Class PropertyXForm
A property that specifies a reference to an XForm.
Inherited Members
Namespace: EPiServer.Core
Assembly: EPiServer.dll
Version: 10.10.4Syntax
[PropertyDefinitionTypePlugIn(DisplayName = "XForm", LanguagePath = "/episerver.xforms/propertyxform")]
public class PropertyXForm : PropertyString, IReadOnly<PropertyData>, IReadOnly, IDynamicContentDisplayType
Constructors
PropertyXForm()
Initializes a new instance of the PropertyXForm class.
Declaration
public PropertyXForm()
PropertyXForm(String)
Initializes a new instance of the PropertyXForm class.
Declaration
public PropertyXForm(string guid)
Parameters
Type | Name | Description |
---|---|---|
System.String | guid | The GUID of the XForm. |
Properties
Form
Gets or sets the form.
Declaration
public XForm Form { get; set; }
Property Value
Type | Description |
---|---|
XForm | The form. |
Remarks
Form will be null if the property is null or if the form can not be loaded.
Fragments
Declaration
public IEnumerable<HtmlFragment> Fragments { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<HtmlFragment> |
IsPosted
Gets or sets a value indicating whether the form has been sent.
Declaration
public bool IsPosted { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
PageLink
Gets or sets the current page link.
Declaration
public PageReference PageLink { get; set; }
Property Value
Type | Description |
---|---|
PageReference | The current page link. |
ParentLink
Gets or sets the parent page link.
Declaration
public PageReference ParentLink { get; set; }
Property Value
Type | Description |
---|---|
PageReference | The parent page link. |
PropertyValueType
Gets the System.Type of the property value.
Declaration
public override Type PropertyValueType { get; }
Property Value
Type | Description |
---|---|
System.Type | The System.Type of the property value. |
Overrides
RenderAsBlockElement
Gets a value indicating whether this should be rendered as a block element (div) not (span).
Declaration
public virtual bool RenderAsBlockElement { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Remarks
PropertyXForm should be treated as a block element.
Type
Property type as defined by enum PropertyDataType.
Declaration
public override PropertyDataType Type { get; }
Property Value
Type | Description |
---|---|
PropertyDataType | The type as defined by enum PropertyDataType. |
Overrides
Value
Gets or sets the value of the property.
Declaration
public override object Value { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The value of the property. |
Overrides
Remarks
Value returns null if the property has no value defined.
Methods
CreatePropertyControl()
Creates an PropertyXFormControl that is used to display a user interface for the property.
Declaration
[Obsolete("Use IPropertyControlFactory to create property controls")]
public override IPropertyControl CreatePropertyControl()
Returns
Type | Description |
---|---|
IPropertyControl | An PropertyXFormControl that is used to display a user interface for the property. |
Overrides
Remarks
It is possible to change which control should be used by registering a different IPropertyControl for the PropertyData class in PropertyControlClassFactory.
MakeReadOnly()
Convert this property to ReadOnly
Declaration
public override void MakeReadOnly()
Overrides
RawPropertyRequiresTypeInformation()
Declaration
protected override bool RawPropertyRequiresTypeInformation()
Returns
Type | Description |
---|---|
System.Boolean |
Overrides
SaveData(PropertyDataCollection)
Return any internal data that will be stored to the database. "Serialize".
Declaration
public override object SaveData(PropertyDataCollection properties)
Parameters
Type | Name | Description |
---|---|---|
PropertyDataCollection | properties | Current property collection. |
Returns
Type | Description |
---|---|
System.Object | The "serializable" value of the property. |
Overrides
ToRawString()
Declaration
public override string ToRawString()
Returns
Type | Description |
---|---|
System.String |