November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class PropertyContentArea

Defines a property representing a ContentArea.

Inheritance
System.Object
PropertyData
PropertyLongString
PropertyContentArea
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.SpecializedProperties
Assembly: EPiServer.dll
Version: 9.12.2
Syntax
[PropertyDefinitionTypePlugIn]
public class PropertyContentArea : PropertyLongString, IReadOnly<PropertyData>, IReadOnly, ILazyProperty, IReferenceMap

Constructors

PropertyContentArea()

Initializes a new instance of the PropertyContentArea class.

Declaration
public PropertyContentArea()

PropertyContentArea(String)

Initializes a new instance of the PropertyContentArea class with the give value.

Declaration
public PropertyContentArea(string value)
Parameters
Type Name Description
System.String value

The value to assign to the new instance.

PropertyContentArea(String, IPrincipalAccessor)

Initializes a new instance of the PropertyContentArea class with the give value.

Declaration
public PropertyContentArea(string value, IPrincipalAccessor principalAccessor)
Parameters
Type Name Description
System.String value

The value to assign to the new instance.
IPrincipalAccessor principalAccessor

The principal accessor to use
Remarks

This is mainly exposed for unit test usage

Properties

ContentArea

Gets or sets the content area for this property.

Declaration
protected ContentArea ContentArea { get; set; }
Property Value
Type Description
ContentArea

The block area.

IsModified

Declaration
public override bool IsModified { get; set; }
Property Value
Type Description
System.Boolean
Overrides

IsNull

Check for null property (no value has been set).

Declaration
public override bool IsNull { get; }
Property Value
Type Description
System.Boolean

true if this property is null; otherwise, false.
Overrides

LongString

Gets or sets the string reprensentation with normal links. This is how actual content is accessed. The setter will parse the content, and insert permanent links where appropriate. The getter will, if necessary, reparse the content to split it into the mixed list representation to speed up dynamic rendering of links.

Declaration
protected override string LongString { get; set; }
Property Value
Type Description
System.String

The long string.
Overrides

PrincipalAcccessor

Gets or set the principal accessor.

Declaration
public Injected<IPrincipalAccessor> PrincipalAcccessor { get; set; }
Property Value
Type Description
Injected<IPrincipalAccessor>

PropertyValueType

Gets the System.Type for this property.

Declaration
public override Type PropertyValueType { get; }
Property Value
Type Description
System.Type

The System.Type of the property value.
Overrides

ReferencedPermanentLinkIds

Gets an list of permanent link ids that are referenced from this property.

Declaration
public IList<Guid> ReferencedPermanentLinkIds { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Guid>

An list of permanent link ids that are referenced from this property.

Value

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

Copy()

Creates a copy of this object.

Declaration
public override PropertyData Copy()
Returns
Type Description
PropertyData

A new PropertyData object.
Overrides

CreatePropertyControl()

Creates an PropertyContentAreaControl that is used to display a user interface for the property.

Declaration
public override IPropertyControl CreatePropertyControl()
Returns
Type Description
IPropertyControl

An PropertyContentAreaControl that is used to display a user interface for the property.
Overrides

CreateWritableClone()

Creates a writable clone of the property.

Declaration
public override PropertyData CreateWritableClone()
Returns
Type Description
PropertyData

A writable copy of the property.
Overrides

LoadData(Object)

Sets the internal representation from what is stored in the database. "Deserialize".

Declaration
public override void LoadData(object value)
Parameters
Type Name Description
System.Object value

The internal value.
Overrides

MakeReadOnly()

Sets internal ContentArea to read-only as well as calling the base class

Declaration
public override void MakeReadOnly()
Overrides

Parse(String)

Create a new PropertyLongString with the value passed to the method.

Declaration
public static PropertyContentArea Parse(string value)
Parameters
Type Name Description
System.String value

The value for the new PropertyLongString.
Returns
Type Description
PropertyContentArea

A new instance of PropertyLongString with the value passed to the method.
Remarks

As PropertyLongString stores its value as a string no parsing is necessary.

ParseToObject(String)

Create a new PropertyLongString with the value passed to the method.

Declaration
public override PropertyData ParseToObject(string value)
Parameters
Type Name Description
System.String value

The value for the new PropertyLongString.
Returns
Type Description
PropertyData

A new instance of PropertyLongString with the value passed to the method.
Overrides

ParseToSelf(String)

Parses a string and assigns it to the value of this instance.

Declaration
public override void ParseToSelf(string value)
Parameters
Type Name Description
System.String value

The new value for the property.
Overrides
Remarks

As PropertyLongString stores its value as a string no parsing is necessary.

RemapPermanentLinkReferences(IDictionary<Guid, Guid>)

Remaps permanent links according to the provided link mapping.

Declaration
public void RemapPermanentLinkReferences(IDictionary<Guid, Guid> idMap)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.Guid, System.Guid> idMap

The link mapping.

SaveData(PropertyDataCollection)

Get the data representation suitable for storing to the database. "Serialize".

Declaration
public override object SaveData(PropertyDataCollection properties)
Parameters
Type Name Description
PropertyDataCollection properties

The properties for the current page.
Returns
Type Description
System.Object

A string representation of the xhtml where the permanent links have not been resolved.
Overrides
Remarks

Returns with unresolved links

SetDefaultValue()

Sets the default value for this property.

Declaration
protected override void SetDefaultValue()
Overrides

ToWebString()

The Xhtml string representation for view mode.

Declaration
public override string ToWebString()
Returns
Type Description
System.String
Overrides

Implements

Extension Methods