Take the community feedback survey now.

AI OnAI Off

Class PageDefinition

Represents the meta data definitions of a PropertyData used by a
PageData or a DynamicProperty

Inheritance
System.Object
PropertyDefinition
PageDefinition
Inherited Members
System.Object.ToString()
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.DataAbstraction
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
[Obsolete("Use EPiServer.DataAbstraction.PropertyDefinition instead.", false)]
public class PageDefinition : PropertyDefinition, IReadOnly<PropertyDefinition>, IReadOnly

Constructors

PageDefinition()

Declaration
public PageDefinition()

Properties

LocalizationProvider

Gets or sets the language manager instance used for translations.

Declaration
[Obsolete("Use EPiServer.Framework.Localization.LocalizationService.Current for equivalent functionality.", false)]
public static LanguageManager LocalizationProvider { get; set; }
Property Value
Type Description
LanguageManager

The LanguageManager instance.
Remarks

This should be set at startup and will provide means to get localized DisplayName and Description for PropertyData instances

Methods

CheckUsage(Boolean, Boolean)

Retrieves information about the usage of the PropertyDefinition. This method has been obsoleted and replaced by the CheckUsage method on the IPropertyDefinitionRepository service implemenation.

Declaration
[Obsolete("Use the CheckUsage method on the IPropertyDefinitionRepository service interface instead", true)]
public DataSet CheckUsage(bool onlyLanguageSpecific, bool isDynamic)
Parameters
Type Name Description
System.Boolean onlyLanguageSpecific

if set to true only language specific usage is retrieved.
System.Boolean isDynamic

if set to true only dynamic properties will be considered.
Returns
Type Description
System.Data.DataSet

ClearCache()

Clears the cache for the PageDefinitions used by the PageType this PageDefinition belongs to.

Declaration
[Obsolete("The PageDefinition cache management is now a responsibility of the PageDefinitionRepository implementation.")]
public void ClearCache()
Remarks

Will also clear the PageType cache and the DataFactoryCache.

ClearGlobalCache()

Clears the entire PageDefinitions cache.

Declaration
[Obsolete("The PageDefinition cache management is now a responsibility of the PageDefinitionRepository implementation.")]
public static void ClearGlobalCache()

ClearLocalCache()

Clears the entire PageDefinitions cache.

Declaration
[Obsolete("The PageDefinition cache management is now a responsibility of the PageDefinitionRepository implementation.")]
public static void ClearLocalCache()

ClearPageDefinitionCache()

Clears the cache for the PageDefinitions used by the PageType this PageDefinition belongs to.

Declaration
[Obsolete("The PageDefinition cache management is now a responsibility of the PageDefinitionRepository implementation.")]
public void ClearPageDefinitionCache()

CreatePropertyData()

Creates a PropertyData instance for this PropertyDefinition.

Declaration
[Obsolete("Use IPropertyDataFactory.CreateProperty(PropertyDefinition) instead.", false)]
public PropertyData CreatePropertyData()
Returns
Type Description
PropertyData

A PropertyData instance.

Delete()

Deletes the page definition.

Declaration
[Obsolete("Use the Delete method on the IPropertyDefinitionRepository service interface instead.")]
public void Delete()

List(Int32)

List all definitions for a page type

Declaration
[Obsolete("Use the List method on the IPropertyDefinitionRepository service interface instead.")]
public static PageDefinitionCollection List(int pageTypeID)
Parameters
Type Name Description
System.Int32 pageTypeID

The page type id
Returns
Type Description
PageDefinitionCollection

A collection of pagedefinitions

ListDynamic()

List all dynamic property definitions

Declaration
[Obsolete("Use the ListDynamic method on the IPropertyDefinitionRepository service interface instead.")]
public static PageDefinitionCollection ListDynamic()
Returns
Type Description
PageDefinitionCollection

A collection of pagedefinitions

Load(Int32)

Load a definition based on its identifier

Declaration
[Obsolete("Use the Load method on the IPropertyDefinitionRepository service interface instead.")]
public static PageDefinition Load(int pageDefinitionID)
Parameters
Type Name Description
System.Int32 pageDefinitionID

The page definition identifier
Returns
Type Description
PageDefinition

The definition if found or null

MoveDown()

Move the definition down in the sort order

Declaration
[Obsolete("MoveDown/MoveUp is no longer supported, you can set FieldOrder and save changes instead.", true)]
public void MoveDown()

MoveUp()

Move the definition up in the sort order

Declaration
[Obsolete("MoveDown/MoveUp is no longer supported, you can set FieldOrder and save changes instead.", true)]
public void MoveUp()

Save()

Save changes to page type definition.

Declaration
[Obsolete("Use the Save method on the IPropertyDefinitionRepository service interface instead.")]
public void Save()

Save(Boolean)

Save changes to page type definition.

Declaration
[Obsolete("Use the Save method on the IPropertyDefinitionRepository service interface instead.")]
public void Save(bool forceCacheClearing)
Parameters
Type Name Description
System.Boolean forceCacheClearing

if set to true forces the page type and DataFactory cache to be cleared even though the page type has not been changed.

Implements

Extension Methods