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: 12.0.0

Syntax

public class PageInfoProvider

The PageInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	PageInfoProvider

Fields

	Name	Description
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.

Methods

	Name	Description
Public method Static member	GetDefaultAliasPath	Returns default alias name for domain or site if is defined
Public method Static member	GetPageInfo(String, String, String, String, Boolean)	Returns the page info for the given Alias path or URL path. Use the overload to provide node ID for better performance if possible.
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	GetPageInfoForUrl	Parses the provided URL and returns a PageInfo object describing the required page in best matching culture.
Public method Static member	GetParentCachePageInfo	Returns cache info of the parent page.
Public method Static member	GetParentProperty<ReturnType>	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	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	Removes prefix from path if is defined.

Remarks

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