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

AI OnAI Off

Class PropertyPageReference

Property representing a link to a page.

Inheritance
System.Object
PropertyData
PropertyContentReference
PropertyPageReference
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.Core
Assembly: EPiServer.dll
Version: 9.12.2
Syntax
public class PropertyPageReference : PropertyContentReference, IReadOnly<PropertyData>, IReadOnly

Constructors

PropertyPageReference()

Initializes a new instance of the PropertyPageReference class.

Declaration
public PropertyPageReference()

PropertyPageReference(ContentReference)

Initializes a new instance of the PropertyPageReference class.

Declaration
public PropertyPageReference(ContentReference contentLink)
Parameters
Type Name Description
ContentReference contentLink

The page link.

PropertyPageReference(Guid)

Initializes a new instance of the PropertyPageReference class.

Declaration
public PropertyPageReference(Guid pageGuid)
Parameters
Type Name Description
System.Guid pageGuid

The guid based identifier for the page

PropertyPageReference(Int32)

Initializes a new instance of the PropertyPageReference class.

Declaration
public PropertyPageReference(int pageID)
Parameters
Type Name Description
System.Int32 pageID

The page ID.

PropertyPageReference(Int32, Int32)

Initializes a new instance of the PropertyPageReference class.

Declaration
public PropertyPageReference(int pageID, int workID)
Parameters
Type Name Description
System.Int32 pageID

The page ID.
System.Int32 workID

The work ID for the page version.

PropertyPageReference(Int32, Int32, String)

Initializes a new instance of the PropertyPageReference class.

Declaration
public PropertyPageReference(int pageID, int workID, string providerName)
Parameters
Type Name Description
System.Int32 pageID

The page ID.
System.Int32 workID

The work ID of the page version.
System.String providerName

Name of the provider.

PropertyPageReference(Int32, String)

Initializes a new instance of the PropertyPageReference class.

Declaration
public PropertyPageReference(int pageID, string providerName)
Parameters
Type Name Description
System.Int32 pageID

The page ID.
System.String providerName

Name of the provider.
Remarks

Only used for remote page references.

Properties

Gets or sets the content link.

Declaration
public override ContentReference ContentLink { get; set; }
Property Value
Type Description
ContentReference

The content link.
Overrides

IsSelfReference

Gets a value indicating whether this property is a self reference.

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

true if this property is a self reference; otherwise, false.
Overrides
Remarks

Only used when creating new pages when there is no known Page ID, must manually be reset.

Gets or sets the page link.

Declaration
public virtual PageReference PageLink { get; set; }
Property Value
Type Description
PageReference

The 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

RemoteSite

Gets or sets the remote site for this page reference.

Declaration
[Obsolete("Use property ProviderName instead")]
public virtual string RemoteSite { get; set; }
Property Value
Type Description
System.String

The remote site for this page reference..

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

Methods

CreatePropertyControl()

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

Declaration
public override IPropertyControl CreatePropertyControl()
Returns
Type Description
IPropertyControl

An PropertyPageReferenceControl 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.

EnsureType(ContentReference)

Ensures that the type is a PageReference.

Declaration
protected override ContentReference EnsureType(ContentReference contentLink)
Parameters
Type Name Description
ContentReference contentLink

The contentLink or a corresponding PageReference if passed in value was a ContentReference.
Returns
Type Description
ContentReference
Overrides

GetEmptyReference()

Declaration
protected override ContentReference GetEmptyReference()
Returns
Type Description
ContentReference

An empty PageReference object.
Overrides

Parse(String)

Creates a new instance of PropertyPageReference with the value specified.

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

The page link as a string.
Returns
Type Description
PropertyPageReference

A new instance of PropertyPageReference with the value specified.

Parse(String, IPermanentLinkMapper)

Creates a new instance of PropertyPageReference with the value specified.

Declaration
public static PropertyPageReference Parse(string value, IPermanentLinkMapper permanentLinkMapper)
Parameters
Type Name Description
System.String value

The page link as a string.
IPermanentLinkMapper permanentLinkMapper

The permanent link mapper.
Returns
Type Description
PropertyPageReference

A new instance of PropertyPageReference with the value specified.

ParseToObject(String)

Creates a new instance of PropertyPageReference with the given value, ie reversed ToString().

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

The string value to parse.
Returns
Type Description
PropertyData

A new instance of PropertyPageReference with the given value.
Overrides

ParseToSelf(String)

Sets the value of the property from a string representation.

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

The string value to parse.
Overrides

Implements

Extension Methods