PageInfoProvider Class

Provides information on the page that are necessary for its processing.

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.PageInfoProvider

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23

Syntax

public class PageInfoProvider

The PageInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	PageInfoProvider

Methods

	Name	Description
Public method Static member	GetDataForPageInfoForUrl	Parses the provided URL and returns a PageInfo object describing the required page.
Public method Static member	GetDefaultAliasPath	Returns default alias name for domain or site if is defined
Public method Static member	GetDependencyCacheKeys	Gets the dependency cache keys for the given page info.
Public method Static member	GetPageInfo(Guid)	Obsolete. Returns the page info for the given Document GUID.
Public method Static member	GetPageInfo(Guid, Int32)	Returns the page info for the given Document GUID.
Public method Static member	GetPageInfo(String, String, String, String, Boolean)	Returns the page info for the given Alias path or URL path.
Public method Static member	GetPageInfo(String, String, String, String, Int32, Boolean)	Returns the page info for the given Alias path or URL path. If NodeID is provided, pageinfo retrieval is faster.
Public method Static member	GetPageInfoByDocumentAliasInfo	Gets PageInfo by DocumentAliasInfo.
Public method Static member	GetPageInfoForUrl	Parses the provided URL and returns a PageInfo object describing the required page.
Public method Static member	GetPageInfos	Gets the page info data matching the conditions.
Public method Static member	GetParentCachePageInfo	Returns cache info of the parent page.
Public method Static member	GetParentPageInfo	Obsolete. Returns page info of the parent page.
Public method Static member	GetParentProperty(Int32, String, String, String)	Obsolete. Returns value inherited from parent in given culture for given column name.
Public method Static member	GetParentProperty<ReturnType>(Int32, String, String, String, WhereCondition)	Returns value inherited from parent in given culture for given column name.
Public method Static member	GetParentSecurePageInfo	Returns secured info of the parent page.
Public method Static member	GetParentSSLPageInfo	Returns SSL info of the parent page.
Public method Static member	GetTemplateSourcePageInfo	Gets the Page info object that defines the page template used by the given page info object.
Public method Static member	GetVirtualPageInfo(Int32)	Gets a virtual page info instance based on the given page template
Public method Static member	GetVirtualPageInfo(PageTemplateInfo)	Gets a virtual page info instance based on the given page template info
Public method Static member	IsDocumentExtension	Returns true if actual extension is correct extension for current set of extensions.
Public method Static member	RemoveAllPageInfosFromCache	Removes all page info records from the cache.
Public method Static member	RemoveCulturePrefix(String, String)	Returns culture code or culture alias defined in URL and removes it from input path.
Public method Static member	RemoveCulturePrefix(String, String, CultureInfo)	Returns culture code or culture alias defined in URL and removes it from input path.
Public method Static member	RemovePathPrefix	Remove prefix from path if is defined.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	CacheItemPriority	Cache item priority.
Public field Static member	PREFIX_CMS_GETDOC	GetDoc prefix for CMS pages (pages which require authentication).

Properties

	Name	Description
Public property Static member	GetDocPrefixes	Prefixes for the available permanent document URLs.
Public property Static member	UseCultureForBestPageInfoResult	Gets or sets the value that indicates whether culture should be used for selecting best result instead of URL path.
Public property Static member	UseUnionForPageInfo	If true, union query is used to retrieve the page info.

Remarks

The class uses cache (if it's available) to store information about pages.