Click or drag to resize
PageInfoProvider Class
Provides information on the page that are necessary for its processing.
Inheritance Hierarchy
SystemObject
  CMS.DocumentEnginePageInfoProvider

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23
Syntax
C#
public class PageInfoProvider

The PageInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodPageInfoProvider
Top
Methods
  NameDescription
Public methodStatic memberGetDataForPageInfoForUrl
Parses the provided URL and returns a PageInfo object describing the required page.
Public methodStatic memberGetDefaultAliasPath
Returns default alias name for domain or site if is defined
Public methodStatic memberGetDependencyCacheKeys
Gets the dependency cache keys for the given page info.
Public methodStatic memberGetPageInfo(Guid) Obsolete.
Returns the page info for the given Document GUID.
Public methodStatic memberGetPageInfo(Guid, Int32)
Returns the page info for the given Document GUID.
Public methodStatic memberGetPageInfo(String, String, String, String, Boolean)
Returns the page info for the given Alias path or URL path.
Public methodStatic memberGetPageInfo(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 methodStatic memberGetPageInfoByDocumentAliasInfo
Gets PageInfo by DocumentAliasInfo.
Public methodStatic memberGetPageInfoForUrl
Parses the provided URL and returns a PageInfo object describing the required page.
Public methodStatic memberGetPageInfos
Gets the page info data matching the conditions.
Public methodStatic memberGetParentCachePageInfo
Returns cache info of the parent page.
Public methodStatic memberGetParentPageInfo Obsolete.
Returns page info of the parent page.
Public methodStatic memberGetParentProperty(Int32, String, String, String) Obsolete.
Returns value inherited from parent in given culture for given column name.
Public methodStatic memberGetParentPropertyReturnType(Int32, String, String, String, WhereCondition)
Returns value inherited from parent in given culture for given column name.
Public methodStatic memberGetParentSecurePageInfo
Returns secured info of the parent page.
Public methodStatic memberGetParentSSLPageInfo
Returns SSL info of the parent page.
Public methodStatic memberGetTemplateSourcePageInfo
Gets the Page info object that defines the page template used by the given page info object.
Public methodStatic memberGetVirtualPageInfo(Int32)
Gets a virtual page info instance based on the given page template
Public methodStatic memberGetVirtualPageInfo(PageTemplateInfo)
Gets a virtual page info instance based on the given page template info
Public methodStatic memberIsDocumentExtension
Returns true if actual extension is correct extension for current set of extensions.
Public methodStatic memberRemoveAllPageInfosFromCache
Removes all page info records from the cache.
Public methodStatic memberRemoveCulturePrefix(String, String)
Returns culture code or culture alias defined in URL and removes it from input path.
Public methodStatic memberRemoveCulturePrefix(String, String, CultureInfo)
Returns culture code or culture alias defined in URL and removes it from input path.
Public methodStatic memberRemovePathPrefix
Remove prefix from path if is defined.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberCacheItemPriority
Cache item priority.
Public fieldStatic memberPREFIX_CMS_GETDOC
GetDoc prefix for CMS pages (pages which require authentication).
Top
Properties
  NameDescription
Public propertyStatic memberGetDocPrefixes
Prefixes for the available permanent document URLs.
Public propertyStatic memberUseCultureForBestPageInfoResult
Gets or sets the value that indicates whether culture should be used for selecting best result instead of URL path.
Public propertyStatic memberUseUnionForPageInfo
If true, union query is used to retrieve the page info.
Top
Remarks
The class uses cache (if it's available) to store information about pages.
See Also