Class FieldEditorControl

The FieldEditorControl control provides a Control to display Profile Properties.

Inheritance

System.Object

FieldEditorControl

Implements

INamingContainer

Namespace: DotNetNuke.UI.WebControls

Assembly: DotNetNuke.dll

Syntax

public class FieldEditorControl : WebControl

Constructors

FieldEditorControl()

Initializes a new instance of the FieldEditorControl class.

Declaration

public FieldEditorControl()

Properties

DataField

Gets or sets the value of the Field/property that this control displays.

Declaration

public string DataField { get; set; }

Property Value

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

DataSource

Gets or sets the DataSource that is bound to this control.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object

EditControlStyle

Gets the value of the Field Style.

Declaration

public Style EditControlStyle { get; }

Property Value

Type	Description
Style

EditControlWidth

Gets or sets the width of the Edit Control Column.

Declaration

public Unit EditControlWidth { get; set; }

Property Value

Type	Description
Unit

EditMode

Gets or sets the Edit Mode of the Editor.

Declaration

public PropertyEditorMode EditMode { get; set; }

Property Value

Type	Description
PropertyEditorMode	The mode of the editor.

Editor

Gets the Edit Control associated with the Editor.

Declaration

public EditControl Editor { get; }

Property Value

Type	Description
EditControl

EditorDisplayMode

Gets or sets whether the control uses Divs or Tables.

Declaration

public EditorDisplayMode EditorDisplayMode { get; set; }

Property Value

Type	Description
EditorDisplayMode

EditorInfoAdapter

Gets or sets the Factory used to create the Control.

Declaration

public IEditorInfoAdapter EditorInfoAdapter { get; set; }

Property Value

Type	Description
IEditorInfoAdapter	The mode of the editor.

EditorTypeName

Gets or sets the Editor Type to use.

Declaration

public string EditorTypeName { get; set; }

Property Value

Type	Description
System.String	The typename of the editor.

EnableClientValidation

Gets or sets a value indicating whether gets and sets a flag indicating whether the Validators should use client-side validation.

Declaration

public bool EnableClientValidation { get; set; }

Property Value

Type	Description
System.Boolean

ErrorStyle

Gets the value of the Error Style.

Declaration

public Style ErrorStyle { get; }

Property Value

Type	Description
Style

HelpDisplayMode

Gets or sets whether the control displays Help.

Declaration

public HelpDisplayMode HelpDisplayMode { get; set; }

Property Value

Type	Description
HelpDisplayMode

HelpStyle

Gets the value of the Label Style.

Declaration

public Style HelpStyle { get; }

Property Value

Type	Description
Style

IsDirty

Gets a value indicating whether any of the properties have been changed.

Declaration

public bool IsDirty { get; }

Property Value

Type	Description
System.Boolean

IsValid

Gets a value indicating whether all of the properties are Valid.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
System.Boolean

LabelMode

Gets or sets the label mode.

Declaration

public LabelMode LabelMode { get; set; }

Property Value

Type	Description
LabelMode

LabelStyle

Gets the value of the Label Style.

Declaration

public Style LabelStyle { get; }

Property Value

Type	Description
Style

LabelWidth

Gets or sets the width of the Label Column.

Declaration

public Unit LabelWidth { get; set; }

Property Value

Type	Description
Unit

LocalResourceFile

Gets or sets the Local Resource File for the Control.

Declaration

public string LocalResourceFile { get; set; }

Property Value

Type	Description
System.String

Required

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

Declaration

public bool Required { get; set; }

Property Value

Type	Description
System.Boolean

RequiredUrl

Gets or sets the Url of the Required Image.

Declaration

public string RequiredUrl { get; set; }

Property Value

Type	Description
System.String

ShowRequired

Gets or sets a value indicating whether the Required icon is used.

Declaration

public bool ShowRequired { get; set; }

Property Value

Type	Description
System.Boolean

ShowVisibility

Gets or sets a value indicating whether the Visibility control is used.

Declaration

public bool ShowVisibility { get; set; }

Property Value

Type	Description
System.Boolean

TagKey

The FieldEditorControl control provides a Control to display Profile Properties.

Declaration

protected override HtmlTextWriterTag TagKey { get; }

Property Value

Type	Description
HtmlTextWriterTag

User

Gets or sets the user.

Declaration

public UserInfo User { get; set; }

Property Value

Type	Description
UserInfo

ValidationExpression

Gets or sets the validation expression.

Declaration

public string ValidationExpression { get; set; }

Property Value

Type	Description
System.String

VisibilityStyle

Gets the value of the Visibility Style.

Declaration

public Style VisibilityStyle { get; }

Property Value

Type	Description
Style

Methods

CollectionItemAdded(Object, PropertyEditorEventArgs)

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

Declaration

protected virtual void CollectionItemAdded(object sender, PropertyEditorEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender of the event.
PropertyEditorEventArgs	e	The event arguments PropertyEditorEventArgs.

CollectionItemDeleted(Object, PropertyEditorEventArgs)

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

Declaration

protected virtual void CollectionItemDeleted(object sender, PropertyEditorEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender of the event.
PropertyEditorEventArgs	e	The event arguments PropertyEditorEventArgs.

CreateEditor()

CreateEditor creates the control collection for this control.

Declaration

protected virtual void CreateEditor()

DataBind()

Binds the controls to the DataSource.

Declaration

public override void DataBind()

ListItemChanged(Object, PropertyEditorEventArgs)

Runs when an Item in the List Is Changed.

Declaration

protected virtual void ListItemChanged(object sender, PropertyEditorEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender of the event.
PropertyEditorEventArgs	e	The event arguments PropertyEditorEventArgs.

Remarks

Raises an ItemChanged event.

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	The event arguments PropertyEditorEventArgs.

OnItemCreated(PropertyEditorItemEventArgs)

Runs when the Editor is Created.

Declaration

protected virtual void OnItemCreated(PropertyEditorItemEventArgs e)

Parameters

Type	Name	Description
PropertyEditorItemEventArgs	e	The event arguments PropertyEditorItemEventArgs.

OnItemDeleted(PropertyEditorEventArgs)

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

Declaration

protected virtual void OnItemDeleted(PropertyEditorEventArgs e)

Parameters

Type	Name	Description
PropertyEditorEventArgs	e	The event arguments PropertyEditorEventArgs.

OnPreRender(EventArgs)

The FieldEditorControl control provides a Control to display Profile Properties.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

Validate()

Validates the data, and sets the IsValid Property.

Declaration

public virtual void Validate()

ValueChanged(Object, PropertyEditorEventArgs)

Runs when the Value of a Property changes.

Declaration

protected virtual void ValueChanged(object sender, PropertyEditorEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender of the event.
PropertyEditorEventArgs	e	The event arguments PropertyEditorEventArgs.

VisibilityChanged(Object, PropertyEditorEventArgs)

Runs when the Visibility of a Property changes.

Declaration

protected virtual void VisibilityChanged(object sender, PropertyEditorEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender of the event.
PropertyEditorEventArgs	e	The event arguments PropertyEditorEventArgs.

Events

ItemAdded

Occurs when an item is added.

Declaration

public event PropertyChangedEventHandler ItemAdded

Event Type

Type	Description
PropertyChangedEventHandler

ItemChanged

Occurs when an item was changed.

Declaration

public event PropertyChangedEventHandler ItemChanged

Event Type

Type	Description
PropertyChangedEventHandler

ItemCreated

Occurs when an item was created.

Declaration

public event EditorCreatedEventHandler ItemCreated

Event Type

Type	Description
EditorCreatedEventHandler

ItemDeleted

Occurs when an item was deleted.

Declaration

public event PropertyChangedEventHandler ItemDeleted

Event Type

Type	Description
PropertyChangedEventHandler

Implements

INamingContainer

Extension Methods

JsonExtensionsWeb.ToJson(Object)