Class MetaDataProperties

Defines the names for the meta data properties used in PageData.

Inheritance

System.Object

MetaDataProperties

Namespace: EPiServer.DataAbstraction

Assembly: EPiServer.dll

Version: 12.0.3

Syntax

public static class MetaDataProperties : Object

Fields

BinaryData

Property holding binary data of type Blob for IBinaryStorable.

Declaration

public const string BinaryData = "BinaryData"

Field Value

Type	Description
System.String

PageArchiveLink

Property containing a link a page where the page will be archived. Of type PropertyContentReference.

Declaration

public const string PageArchiveLink = "PageArchiveLink"

Field Value

Type	Description
System.String

PageCategory

Property containing the categories associated with the page. Of type PropertyCategory.

Declaration

public const string PageCategory = "PageCategory"

Field Value

Type	Description
System.String

PageChanged

Property containing the date when the page was last marked as changed. Of type PropertyDate.

Declaration

public const string PageChanged = "PageChanged"

Field Value

Type	Description
System.String

PageChangedBy

Property containing the username of the user that last changed the page. Of type PropertyString.

Declaration

public const string PageChangedBy = "PageChangedBy"

Field Value

Type	Description
System.String

PageChangedOnPublish

Property indicating if the changed date should be updated when the page is published. Of type PropertyBoolean.

Declaration

public const string PageChangedOnPublish = "PageChangedOnPublish"

Field Value

Type	Description
System.String

PageChildOrderRule

Property containing the type of sorting that should be used for child pages. Of type PropertyNumber representing a FilterSortOrder.

Declaration

public const string PageChildOrderRule = "PageChildOrderRule"

Field Value

Type	Description
System.String

PageContentAssetsID

Property containing the unique assets folder. Of type PropertyString.

Declaration

public const string PageContentAssetsID = "PageContentAssetsID"

Field Value

Type	Description
System.String

PageContentOwnerID

Property containing the owner id for a IContentAsset. Of type PropertyString.

Declaration

public const string PageContentOwnerID = "PageContentOwnerID"

Field Value

Type	Description
System.String

PageCreated

Property containing the date when the page was created. Of type PropertyDate.

Declaration

public const string PageCreated = "PageCreated"

Field Value

Type	Description
System.String

PageCreatedBy

Property containing the username of the user that created the page. Of type PropertyString.

Declaration

public const string PageCreatedBy = "PageCreatedBy"

Field Value

Type	Description
System.String

PageDeleted

Property indicating if the page is currently placed in the wastebasket. Of type PropertyBoolean.

Declaration

public const string PageDeleted = "PageDeleted"

Field Value

Type	Description
System.String

PageDeletedBy

Property indicating who delete the page.

Declaration

public const string PageDeletedBy = "PageDeletedBy"

Field Value

Type	Description
System.String

PageDeletedDate

Property indicating when the page is placed in the wastebasket.

Declaration

public const string PageDeletedDate = "PageDeletedDate"

Field Value

Type	Description
System.String

PageExternalURL

Property containing a simple URL of the page. Of type PropertyVirtualLink.

Declaration

public const string PageExternalURL = "PageExternalURL"

Field Value

Type	Description
System.String

PageFolderID

Property containing the unique folder name in the page folder provider. Of type PropertyNumber.

Declaration

public const string PageFolderID = "PageFolderID"

Field Value

Type	Description
System.String

PageGUID

Property containing the unique identifier of the page. Of type PropertyString.

Declaration

public const string PageGUID = "PageGUID"

Field Value

Type	Description
System.String

PageLanguageBranch

Property containing the language branch identifier for page. Of type PropertyString.

Declaration

public const string PageLanguageBranch = "PageLanguageBranch"

Field Value

Type	Description
System.String

PageLink

Property containing the identifier of the page. Of type PropertyContentReference.

Declaration

public const string PageLink = "PageLink"

Field Value

Type	Description
System.String

PageLinkURL

Property containing the URL to the page. Of type PropertyUrl.

Declaration

public const string PageLinkURL = "PageLinkURL"

Field Value

Type	Description
System.String

PageMasterLanguageBranch

Property containing the master language branch of the page. Of type PropertyString.

Declaration

public const string PageMasterLanguageBranch = "PageMasterLanguageBranch"

Field Value

Type	Description
System.String

PageName

Property containing the name of the page. PropertyString.

Declaration

public const string PageName = "PageName"

Field Value

Type	Description
System.String

PageParentLink

Property containing a link to the parent page of the page. Of type PropertyContentReference.

Declaration

public const string PageParentLink = "PageParentLink"

Field Value

Type	Description
System.String

PagePeerOrder

Property containing the sorting index of the page. Of type PropertyNumber.

Declaration

public const string PagePeerOrder = "PagePeerOrder"

Field Value

Type	Description
System.String

PagePendingPublish

Property indicating if the page is pending publishing Of type PropertyBoolean.

Declaration

public const string PagePendingPublish = "PagePendingPublish"

Field Value

Type	Description
System.String

PageSaved

Property containing the date when the page was last saved. Of type PropertyDate.

Declaration

public const string PageSaved = "PageSaved"

Field Value

Type	Description
System.String

PageShortcutLink

Property containing a page where the page is linked to, as defined by PageShortcutType. Of type PropertyContentReference.

Declaration

public const string PageShortcutLink = "PageShortcutLink"

Field Value

Type	Description
System.String

PageShortcutType

Property containing the type of link behaviour that should be used for the page. Of type PropertyNumber.

Declaration

public const string PageShortcutType = "PageShortcutType"

Field Value

Type	Description
System.String

PageStartPublish

Property containing the date when the page should be published. Of type PropertyDate.

Declaration

public const string PageStartPublish = "PageStartPublish"

Field Value

Type	Description
System.String

PageStopPublish

Property containing the date at which time the page should stop being published. Of type PropertyDate.

Declaration

public const string PageStopPublish = "PageStopPublish"

Field Value

Type	Description
System.String

PageTargetFrame

Property containing the frame that this page should be displayed in. Of type PropertyFrame.

Declaration

public const string PageTargetFrame = "PageTargetFrame"

Field Value

Type	Description
System.String

PageTypeID

Property containing the identifier of the page type of the page. Of type PropertyPageType.

Declaration

public const string PageTypeID = "PageTypeID"

Field Value

Type	Description
System.String

PageTypeName

Property containing the name of the page type of the page. Of type PropertyString.

Declaration

public const string PageTypeName = "PageTypeName"

Field Value

Type	Description
System.String

PageURLSegment

Property containing the segment that represents the page in an URL. Of type PropertyString.

Declaration

public const string PageURLSegment = "PageURLSegment"

Field Value

Type	Description
System.String

PageVisibleInMenu

Property indicating if the page should be visible in menus. Of type PropertyBoolean.

Declaration

public const string PageVisibleInMenu = "PageVisibleInMenu"

Field Value

Type	Description
System.String

PageWorkStatus

Property containing the editing status of the page. Of type PropertyNumber representing a VersionStatus.

Declaration

public const string PageWorkStatus = "PageWorkStatus"

Field Value

Type	Description
System.String

Thumbnail

Property holding binary data of type Blob for IContentMedia.

Declaration

public const string Thumbnail = "Thumbnail"

Field Value

Type	Description
System.String

Properties

All

A list of all existing meta data properties for content.

Declaration

public static IEnumerable<string> All { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

Remarks

Not all content types have all meta data present.

MetaDataInterfaces

Returns a list of metadata interface types

Declaration

public static IEnumerable<Type> MetaDataInterfaces { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Type>

Methods

GetFieldOrder(String)

Gets value for FieldOrder for the specified property.

Declaration

public static int GetFieldOrder(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.

Returns

Type	Description
System.Int32	The field order for that property, or 0 if not found.

GetInterfaceForPageDataMetaDataProperty(String)

Gets the interface that exposes the specified property on a the PageData implementation.

Declaration

public static Type GetInterfaceForPageDataMetaDataProperty(string metaDataPropertyName)

Parameters

Type	Name	Description
System.String	metaDataPropertyName	Name of the property.

Returns

Type	Description
System.Type	The interface that exposes the specified property, or null if none exists.

GetLanguageSpecificSetting(String)

Gets value for IsLanguageSpecific for the specified property.

Declaration

public static bool GetLanguageSpecificSetting(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.

Returns

Type	Description
System.Boolean	`true` if that property is language specific, otherwise `false`

GetPageDataPropertyName(String)

Gets the name of the backing PropertyData on a PageData for a specific property exposed through an interface. Example: IContent.Name would return PageName.

Declaration

public static string GetPageDataPropertyName(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	The name of the property on an interface.

Returns

Type	Description
System.String	The name of the backing property data

GetTabForPropertyName(String)

Gets the the edit tab for the specified property.

Declaration

public static EditTab GetTabForPropertyName(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	Name of the property.

Returns

Type	Description
EditTab	The edit tab for the property. The default tab is Information.

IsHandledByInterface(PropertyData)

Determines if the property instance is handled by a metadata interface

Declaration

public static bool IsHandledByInterface(PropertyData property)

Parameters

Type	Name	Description
PropertyData	property	The property to evaluate

Returns

Type	Description
System.Boolean	true if the property is handled by a metadata interface else false