Try our conversational search powered by Generative AI!

AI OnAI Off

Class PropertyGetHandler

A class that has the functionality that is used when getting a property for a page. This is the logic that is used to enable the funtion fetch data from other pages (if fetch data from is specified). It's also responsible to fetch dynamic properties.

Inheritance
System.Object
PropertyGetHandler
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.Core
Assembly: EPiServer.dll
Version: 7.19.2
Syntax
public static class PropertyGetHandler

Methods

Cms4PropertyByIndexHandler(Int32, PropertyDataCollection)

CMS4 compatible implementation of the GetByIndex handler for PropertyDataCollection.

Declaration
[Obsolete("CMS4 compatibility behavior will be removed.")]
public static PropertyData Cms4PropertyByIndexHandler(int index, PropertyDataCollection properties)
Parameters
Type Name Description
System.Int32 index

The index.
PropertyDataCollection properties

The properties.
Returns
Type Description
PropertyData

The corresponding PropertyData object.
Remarks

This method can be used to make sure that you will get EPiServer CMS 4 compatible behavior when you index a PropertyDataCollection by Int32. The difference is that this implementatino will follow "Fetch data from" links and include dynamic property information, whereas the default implementation will not.

DefaultPropertyByIndexHandler(Int32, PropertyDataCollection)

Default implementation of the GetByIndex handler for PropertyDataCollection.

Declaration
public static PropertyData DefaultPropertyByIndexHandler(int index, PropertyDataCollection properties)
Parameters
Type Name Description
System.Int32 index

The index.
PropertyDataCollection properties

The properties.
Returns
Type Description
PropertyData

The corresponding PropertyData object.

DefaultPropertyHandler(String, PropertyDataCollection)

The default property get handler.

Declaration
public static PropertyData DefaultPropertyHandler(string name, PropertyDataCollection properties)
Parameters
Type Name Description
System.String name

The name of the property that you want to fetch.
PropertyDataCollection properties

The PropertyDataCollection that should be looked in first.
Returns
Type Description
PropertyData

The property with the given name.
Remarks

The property will be searched for in the following order: The PropertyDataCollection, fetch data from, dynamic properties.

FetchDataFrom(String, PropertyDataCollection)

Used to fetch properties from another page if this has been defined.

Declaration
public static PropertyData FetchDataFrom(string name, PropertyDataCollection properties)
Parameters
Type Name Description
System.String name

The name of the property.
PropertyDataCollection properties

The PropertyDataCollection.
Returns
Type Description
PropertyData

The PropertyData from the fetch data page.

SimplePropertyHandler(String, PropertyDataCollection)

A simple property get handler that only looks in the PropertyDataCollection.

Declaration
public static PropertyData SimplePropertyHandler(string name, PropertyDataCollection properties)
Parameters
Type Name Description
System.String name

The name of the property that you want to fetch.
PropertyDataCollection properties

The PropertyDataCollection.
Returns
Type Description
PropertyData

The property with the given name from the PropertyDataCollection.