PageInfo Class

Page data storage object

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<PageInfo>
    CMS.Base.AbstractDataContainer<PageInfo>
      CMS.Base.AbstractHierarchicalObject<PageInfo>
        CMS.Base.ReadOnlyAbstractHierarchicalObject<PageInfo>
          CMS.DocumentEngine.PageInfo

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

Syntax

[SerializableAttribute]
public class PageInfo : ReadOnlyAbstractHierarchicalObject<PageInfo>, 
	IPageInfo, ITreeNode, IDataContainer, ISimpleDataContainer

The PageInfo type exposes the following members.

Constructors

	Name	Description
Public method	PageInfo()	Constructor.
Public method	PageInfo(DataRow)	Constructor.
Public method	PageInfo(IDataContainer)	Constructor.

Fields

	Name	Description
Protected field	mClassName	Document class name.
Protected field	mDocumentTemplateInstance	Document widgets template instance.
Protected field	mEditableItems	Editable items container.
Protected field	mGroupTemplateInstance	Group widgets template instance.
Protected field	mInheritedPageInfo	Inherited page info object.
Protected field	mPageTemplateInfo	Page template info object.
Protected field	mPageTemplateInfoLoaded	If true, the page template info was already loaded
Protected field	mSiteName	Document site name.
Protected field	mTemplateInstance	Complete page template instance (PageTemplateInfo.TemplateInstance + DocumentTemplateInstance + GroupTemplateInstance + MVTVariants + ContentPersonalizationVariants).

Properties

	Name	Description
Public property	ChildPageInfo	Child page info (for the page path of the Portal engine controls).
Public property	ClassName	Class name of the current document.
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	DesignPageTemplateInfo	Page template info used for standard and design view of the document.
Public property	DocumentCheckedOutVersionHistoryID	Document checked out version history ID.
Public property	DocumentContent	Returns document content XML.
Public property	DocumentConversionValue	Document conversion value - Reflects the "DocumentConversionValue" data column.
Public property	DocumentCulture	Document culture.
Public property	DocumentExtensions	Document extensions.
Public property	DocumentGUID	Document GUID
Public property	DocumentID	Document ID.
Public property	DocumentLogActivity	Indicates if document enables logging activities.
Public property	DocumentMenuCaption	Document menu caption.
Public property	DocumentMenuClass	Document menu class.
Public property	DocumentMenuItemHideInNavigation	Document menu hide in navigation.
Public property	DocumentMenuItemInactive	Document menu item inactive.
Public property	DocumentMenuJavascript	Document menu JavaScript.
Public property	DocumentMenuRedirectToFirstChild	Indicates if redirection to first child document should be performed when accessed.
Public property	DocumentMenuRedirectUrl	Document Redirect URL.
Public property	DocumentMenuStyle	Document menu style.
Public property	DocumentName	Document name.
Public property	DocumentNamePath	Document name path.
Public property	DocumentPageDescription	Document page description.
Public property	DocumentPageKeyWords	Document page keywords.
Public property	DocumentPageTitle	Document page title.
Public property	DocumentPublishedVersionHistoryID	Document published version history ID.
Public property	DocumentPublishFrom	Document published from.
Public property	DocumentPublishTo	Document published to.
Public property	DocumentSearchExcluded	Indicates whether document should be excluded from search
Public property	DocumentStylesheetID	Document CSS stylesheet ID.
Public property	DocumentTemplateInstance	Document widgets template instance.
Public property	DocumentTrackConversionName	Document conversion name - Reflects the "DocumentTrackConversionName" data column.
Public property	DocumentUrlPath	Document URL path.
Public property	DocumentWorkflowCycleGUID	Workflow cycle GUID to obtain preview link for document
Public property	DocumentWorkflowStepID	Document workflow step ID.
Public property	EditableItems	Editable items contained within the page.
Public property	EditableRegions	Editable regions contained within the document.
Public property	EditableWebParts	Editable WebParts contained within the document.
Public property	GroupTemplateInstance	Group widgets template instance.
Protected property	InheritedPageInfo	Inherited page info.
Public property	IsDocument	Indicates if document context available.
Public property	IsLink	Indicates whether the document is link to another document.
Public property	IsPublished	Returns true if the node is published.
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	NodeACLID	Node ACLID.
Public property	NodeAlias	Node alias.
Public property	NodeAliasPath	Node alias path.
Public property	NodeAllowCacheInFileSystem	Requires authentication property.
Public property	NodeBodyElementAttributes	Node body CSS class.
Public property	NodeBodyScripts	Top HTML body node for custom HTML code.
Public property	NodeCacheMinutes	Node cache minutes.
Public property	NodeClassID	Node class ID.
Public property	NodeDocType	Node document type.
Public property	NodeGroupID	Node group ID.
Public property	NodeGUID	Node GUID.
Public property	NodeHeadTags	Node header tags.
Public property	NodeID	Node ID.
Public property	NodeInheritPageTemplate	If true, the document inherits the page template from parent
Public property	NodeLevel	Node level.
Public property	NodeLinkedNodeID	Linked node ID.
Public property	NodeLinkedNodeSiteID	Linked node site ID.
Public property	NodeName	Node name.
Public property	NodeOrder	Node order.
Public property	NodeOwner	Document owner.
Public property	NodeParentID	Node parent ID.
Public property	NodeSiteID	Node site ID.
Public property	NodeSiteName	Node site name.
Public property	NodeSKUID	Document product ID.
Public property	NodeTemplateForAllCultures	If true, the document uses the same template (NodeTemplateID) for all culture versions
Public property	OriginalNodeSiteID	Original node site ID. Returns NodeSiteID for standard document, LinkedNodeSiteID for linked document.
Public property	PageResult	Gets or sets the contextual page result data object related to the current url. PageResult returns different data for different document aliases.
Public property	ParentPageInfo	Parent page info (for the page path), this property is meant for internal purposes of Portal engine.
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	RequiresAuthentication	Requires authentication property.
Public property	RequiresSSL	Requires authentication property.
Public property	RequiresSSLValue	Requires authentication property.
Public property	SiteName	Site name of the current document.
Public property	TemplateInstance	Complete page template instance (PageTemplateInfo.TemplateInstance + DocumentTemplateInstance + GroupTemplateInstance).
Protected property	UpperTree	Upper tree DataSet (for inheriting of the values).
Public property	UsedPageTemplateInfo	Page template info used by current view mode.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	WorkflowStepName	Workflow step name.
Public property	WorkflowStepType	Workflow step type.

Methods

	Name	Description
Public method	ClearOutputCache(Boolean)	Clears the output cache for current page.
Public method	ClearOutputCache(Boolean, Boolean)	Clears the output cache for current page.
Public method	Clone()	Clones the PageInfo object.
Public method	Clone(Boolean, Boolean)	Clones the PageInfo object.
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	CreateInherited	Creates an inherited page info.
Public method	GetContentXml	Returns the xml code of the document contents (Editable regions, web parts).
Public method	GetDocumentName	Gets friendly document name
Protected method	GetInheritedTemplateInfo	Gets the inherited template info from parent page infos
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetResolvedPageTitle	Gets resolved document page title
Public method	GetResponseCacheDependencies	Gets the page dependency keys for the response of the page.
Public method	GetUpperTree	Gets the upper tree data for inherited values.
Public method	GetUsedInheritPageLevels	Gets the inherit page levels used by this page
Public method	GetUsedPageTemplateId	Gets the page template id used by this document
Public method	GetUsedPageTemplateIdColumn	Gets the page template id used by this document
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	GetValueFromUpperTree	Returns string value of selected column.
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	IsProduct	Returns true if the document represents a product.
Public method	IsProductSection	Returns true if the document type stands for the product section
Public method	IsRoot	Returns true if the given document is a root node
Public method	LoadContentXml	Loads the content XML to the content table.
Public method	LoadVersion()	Load the current version data of the document to the page info.
Public method	LoadVersion(TreeNode)	Load complete given version of the document to the page info.
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Overrides AbstractSimpleDataContainer<TObject>.RegisterColumns().)
Protected method	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetPageResult	Sets the page result object for the given url. The page result object is then accessible via PageResult property.
Public method	SetPageTemplateId	Sets the default document page template ID
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	IsFile	Returns true if the given document is a file node (Defined by TreeNodeTypeExtensions.)
Public Extension Method	IsFolder	Returns true if the given document is a folder node (Defined by TreeNodeTypeExtensions.)
Public Extension Method	IsRoot	Returns true if the given document is a root node (Defined by TreeNodeTypeExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)