Don't miss out Virtual Happy Hour this Friday (April 26).

Try our conversational search powered by Generative AI!

AI OnAI Off

Interface IPropertyControl

Implemented by a Control that is used to display a user interface for a PropertyData class.

Namespace: EPiServer.Core
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
public interface IPropertyControl

Properties

DisplayEditUI

Gets a value indicating whether the control should display an edit user interface.

Declaration
bool DisplayEditUI { get; }
Property Value
Type Description
System.Boolean

true if the control should display an edit user interface.; otherwise, false.

Enabled

Gets or sets a value indicating whether this IPropertyControl is enabled.

Declaration
bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

true if enabled; otherwise, false.
Remarks

This is only valid for web form based editors.

Properties

Sets the properties that are being edited for the IPropertyControl.

Declaration
PropertyDataCollection Properties { set; }
Property Value
Type Description
PropertyDataCollection

PropertyData

Gets or sets the PropertyData for the IPropertyControl.

Declaration
PropertyData PropertyData { get; set; }
Property Value
Type Description
PropertyData

RenderType

Sets the RenderType for the IPropertyControl.

Declaration
RenderType RenderType { set; }
Property Value
Type Description
RenderType

RowLayout

Specifies how a property row is rendered in the edit user interface.

Declaration
TableRowLayout RowLayout { get; }
Property Value
Type Description
TableRowLayout
Remarks

This is only valid for web form based editors.

ValidationGroup

Gets or sets the validation group.

Declaration
string ValidationGroup { get; set; }
Property Value
Type Description
System.String

The validation group.
Remarks

This is only valid for web form based editors.

Methods

ApplyChanges()

Applies changes for the posted data to the page's properties.

Declaration
void ApplyChanges()
Remarks

This is only valid for web form based editors.

SetupControl()

Called when setting up the properties for a page.

Declaration
void SetupControl()
Remarks

If the control creates it's child controls in CreateChildControls(), EnsureChildControls() should be called in this method to make sure the child controls are created before loading post data.

Extension Methods