Class EditControl

The EditControl control provides a standard UI component for editing properties.

Inheritance

System.Object

EditControl

SkinsEditControl

DateEditControl

DnnCountryAutocompleteControl

DNNListEditControl

DNNRegionEditControl

EnumEditControl

IntegerEditControl

TextEditControl

TrueFalseEditControl

VersionEditControl

Implements

IPostBackDataHandler

Namespace: DotNetNuke.UI.WebControls

Assembly: DotNetNuke.dll

Syntax

public abstract class EditControl : WebControl

Properties

Category

Gets or sets the Category to which this edit control belongs.

Declaration

public string Category { get; set; }

Property Value

Type	Description
System.String	A string representing the Category of the property.

CustomAttributes

Gets or sets the Custom Attributes for this Control.

Declaration

public object[] CustomAttributes { get; set; }

Property Value

Type	Description
System.Object[]	An array of Attributes.

DataField

Gets or sets set Data Field of the control.

Declaration

public string DataField { get; set; }

Property Value

Type	Description
System.String

EditControlClientId

The EditControl control provides a standard UI component for editing properties.

Declaration

public virtual string EditControlClientId { get; }

Property Value

Type	Description
System.String

EditMode

Gets or sets the Edit Mode of the Editor.

Declaration

public PropertyEditorMode EditMode { get; set; }

Property Value

Type	Description
PropertyEditorMode	A boolean.

IsValid

Gets a value indicating whether returns whether the.

Declaration

public virtual bool IsValid { get; }

Property Value

Type	Description
System.Boolean	A boolean.

LocalResourceFile

Gets or sets the Local Resource File for the Control.

Declaration

public string LocalResourceFile { get; set; }

Property Value

Type	Description
System.String	A String.

Name

Gets or sets name is the name of the field as a string.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	A string representing the Name of the property.

OldValue

Gets or sets oldValue is the initial value of the field.

Declaration

public object OldValue { get; set; }

Property Value

Type	Description
System.Object	The initial Value of the property.

Required

Gets or sets a value indicating whether the Property is required.

Declaration

public bool Required { get; set; }

Property Value

Type	Description
System.Boolean	The initial Value of the property.

StringValue

Gets or sets stringValue is the value of the control expressed as a String.

Declaration

protected abstract string StringValue { get; set; }

Property Value

Type	Description
System.String	A string representing the Value.

SystemType

Gets or sets systemType is the System Data Type for the property.

Declaration

public string SystemType { get; set; }

Property Value

Type	Description
System.String	A string representing the Type of the property.

User

The EditControl control provides a standard UI component for editing properties.

Declaration

public UserInfo User { get; set; }

Property Value

Type	Description
UserInfo

Value

Gets or sets value is the value of the control.

Declaration

public object Value { get; set; }

Property Value

Type	Description
System.Object	The Value of the property.

Methods

LoadPostData(String, NameValueCollection)

LoadPostData loads the Post Back Data and determines whether the value has change.

Declaration

public virtual bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters

Type	Name	Description
System.String	postDataKey	A key to the PostBack Data to load.
NameValueCollection	postCollection	A name value collection of postback data.

Returns

Type	Description
System.Boolean	true if the value has changed, otherwise false.

OnAttributesChanged()

OnAttributesChanged runs when the CustomAttributes property has changed.

Declaration

protected virtual void OnAttributesChanged()

OnDataChanged(EventArgs)

OnDataChanged runs when the PostbackData has changed. It raises the ValueChanged Event.

Declaration

protected abstract void OnDataChanged(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

OnItemAdded(PropertyEditorEventArgs)

Runs when an item is added to a collection type property.

Declaration

protected virtual void OnItemAdded(PropertyEditorEventArgs e)

Parameters

Type	Name	Description
PropertyEditorEventArgs	e

OnItemDeleted(PropertyEditorEventArgs)

Runs when an item is deleted from a collection type property.

Declaration

protected virtual void OnItemDeleted(PropertyEditorEventArgs e)

Parameters

Type	Name	Description
PropertyEditorEventArgs	e

OnValueChanged(PropertyEditorEventArgs)

OnValueChanged runs when the Value has changed. It raises the ValueChanged Event.

Declaration

protected virtual void OnValueChanged(PropertyEditorEventArgs e)

Parameters

Type	Name	Description
PropertyEditorEventArgs	e

RaisePostDataChangedEvent()

RaisePostDataChangedEvent runs when the PostBackData has changed. It triggers a ValueChanged Event.

Declaration

public void RaisePostDataChangedEvent()

Render(HtmlTextWriter)

The EditControl control provides a standard UI component for editing properties.

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
HtmlTextWriter	writer

RenderEditMode(HtmlTextWriter)

RenderEditMode renders the Edit mode of the control.

Declaration

protected virtual void RenderEditMode(HtmlTextWriter writer)

Parameters

Type	Name	Description
HtmlTextWriter	writer	A HtmlTextWriter.

RenderViewMode(HtmlTextWriter)

RenderViewMode renders the View (readonly) mode of the control.

Declaration

protected virtual void RenderViewMode(HtmlTextWriter writer)

Parameters

Type	Name	Description
HtmlTextWriter	writer	A HtmlTextWriter.

Events

ItemAdded

The EditControl control provides a standard UI component for editing properties.

Declaration

public event PropertyChangedEventHandler ItemAdded

Event Type

Type	Description
PropertyChangedEventHandler

ItemDeleted

The EditControl control provides a standard UI component for editing properties.

Declaration

public event PropertyChangedEventHandler ItemDeleted

Event Type

Type	Description
PropertyChangedEventHandler

ValueChanged

The EditControl control provides a standard UI component for editing properties.

Declaration

public event PropertyChangedEventHandler ValueChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

IPostBackDataHandler

Extension Methods

JsonExtensionsWeb.ToJson(Object)