Class Property

Namespace: EPiServer.Web.WebControls

Assembly: EPiServer.Web.WebControls.dll

Syntax

public class Property : WebControl, INamingContainer, IPageSource, IPageControl, IContentControl, IContentSource, IPropertyControlsContainer

Remarks

Examples

  The following example shows how to print the name of the page to HTML:

    <EPiServer:Property PropertyName="PageName" runat="server" />

        The PropertyName attribute is not case sensitive.

For the Property control to be able to read the properties from the page, it needs to be hosted on a web form or a control that implements the IPageSource interface. The control will iterate through the control hierarchy looking for this interface, and when it finds one it will use the CurrentPage property to read the information about the specific built-in or custom property.

If you put a Property control inside a templated control like the PageList control, that implements IPageSource, the Property control will use the CurrentPage property of the template control instead. The PageList then points the Property control to the current PageData object in its internal PageDataCollection. This is why the two following PageList examples will print the same:

    <EPiServer:PageList PageLink="<%# EPiServer.Core.PageReference.StartPage%>" runat="server">
<ItemTemplate>
<EPiServer:Property PropertyName="PageName" runat="server" />
</ItemTemplate>
</EPiServer:PageList>

<EPiServer:PageList PageLink="<%# EPiServer.Core.PageReference.StartPage%>" runat="server">
<ItemTemplate>
<%#Container.CurrentPage.PageName%>
</ItemTemplate>
</EPiServer:PageList>

Constructors

Property()

Declaration

public Property()

Remarks

Property(PropertyData)

Declaration

public Property(PropertyData propertyData)

Parameters

Properties

BoundPageID

Declaration

protected int BoundPageID { get; }

Property Value

ContentSource

Declaration

public virtual IContentSource ContentSource { get; set; }

Property Value

ContextBuilder

Declaration

protected Injected<ControlRenderContextBuilder> ContextBuilder { get; set; }

Property Value

CssClass

Declaration

public override string CssClass { get; set; }

Property Value

CurrentContent

Declaration

public IContent CurrentContent { get; }

Property Value

CurrentContext

Declaration

protected virtual PropertyContext CurrentContext { get; }

Property Value

CustomTagName

Declaration

public virtual string CustomTagName { get; set; }

Property Value

Examples

Set to "h1" to create a h1-tag around the content.

DisplayMissingMessage

Declaration

public virtual bool DisplayMissingMessage { get; set; }

Property Value

Remarks

<episerver:property propertyname="MyProperty" runat="server" DisplayMissingMessage='false' />

Editable

Declaration

public virtual bool Editable { get; set; }

Property Value

Remarks

<episerver:property propertyname="PageName" runat="server" Editable='false' />

EditMode

Declaration

public virtual bool EditMode { get; set; }

Property Value

Remarks

<episerver:property editmode="True" runat="server" propertyname="MainBody" /> 
<button onclick="OnDopeSave()">Save</button>

EditorSettings

Declaration

public virtual PropertyEditorSettings EditorSettings { get; }

Property Value

Remarks

InnerProperty

Declaration

public virtual PropertyData InnerProperty { get; set; }

Property Value

ObjectSerializerFactory

Declaration

protected Injected<IObjectSerializerFactory> ObjectSerializerFactory { get; set; }

Property Value

OverlaySettings

Declaration

public virtual PropertyEditorSettings OverlaySettings { get; }

Property Value

Remarks

PageLink

Declaration

public virtual PageReference PageLink { get; set; }

Property Value

Remarks

<episerver:property runat="server" propertyname="MainBody" PageLink="30" />

<episerver:property runat="server" propertyname="MainBody" PageLink='<%# EPiServer.Global.EPConfig.StartPage%>' />

PageLinkProperty

Declaration

public virtual string PageLinkProperty { get; set; }

Property Value

PageSource

Declaration

public virtual IPageSource PageSource { get; set; }

Property Value

Remarks

PropertyName

Declaration

public virtual string PropertyName { get; set; }

Property Value

Remarks

Examples

The following example shows how to print the name of the page to HTML:

<episerver:property propertyname="PageName" runat="server" />

PropertyResolver

Declaration

protected Injected<PropertyResolver> PropertyResolver { get; set; }

Property Value

PropertyScopeSeparator

Declaration

public virtual char PropertyScopeSeparator { get; set; }

Property Value

Remarks

PropertyValue

Declaration

[Obsolete("Use InnerProperty.Value if you want to retrieve the value of the loaded property.")]
public object PropertyValue { get; }

Property Value

RenderSettings

Declaration

public virtual PropertyRenderSettings RenderSettings { get; }

Property Value

Remarks

ValidationGroup

Declaration

public virtual string ValidationGroup { get; set; }

Property Value

Methods

CreateChildControls()

Declaration

protected override void CreateChildControls()

DataBind()

Declaration

public override void DataBind()

EnsurePropertyControlsCreated()

Declaration

public void EnsurePropertyControlsCreated()

Get<T>(ContentReference)

Declaration

public T Get<T>(ContentReference contentLink)
    where T : IContentData

Parameters

Returns

Type Parameters

GetChildren<T>(ContentReference)

Declaration

public IEnumerable<T> GetChildren<T>(ContentReference contentLink)
    where T : IContentData

Parameters

Returns

Type Parameters

OnPreRender(EventArgs)

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

RenderErrorMessage(HtmlTextWriter)

Declaration

protected virtual void RenderErrorMessage(HtmlTextWriter writer)

Parameters

Remarks

Explicit Interface Implementations

IPageSource.CurrentPage

Declaration

PageData IPageSource.CurrentPage { get; }

Returns

IPageSource.GetChildren(PageReference)

Declaration

PageDataCollection IPageSource.GetChildren(PageReference pageLink)

Parameters

Returns

IPageSource.GetPage(PageReference)

Declaration

PageData IPageSource.GetPage(PageReference pageLink)

Parameters

Returns

IContentControl.CurrentContext

Declaration

PropertyContext IContentControl.CurrentContext { get; }

Returns

Implements

Extension Methods