The PageInfo type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | PageInfo |
Constructor.
|
| PageInfo(DataRow) |
Constructor.
|
Methods
| Name | Description | |
|---|---|---|
| AddResponseCacheDependencies |
Adds the cache dependencies for the current page to the response.
|
| ClearOutputCache(Boolean) |
Clears the output cache for current page.
|
| ClearOutputCache(Boolean, Boolean) |
Clears the output cache for current page.
|
| Clone |
Clones the PageInfo object.
|
| Clone(Boolean, Boolean) |
Clones the PageInfo object.
|
| 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 ObjectType .) |
| ContainsColumn |
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainer ParentObjectType .) |
| CreateInherited |
Creates an inherited page info.
|
|  Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetContentXml |
Returns the xml code of the document contents (Editable regions, web parts).
|
| GetDocumentName |
Gets friendly document name
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetInheritedTemplateInfo |
Gets the inherited template info from parent page infos
|
| GetProperty |
Gets the context property.
(Inherited from AbstractHierarchicalObject ObjectType .) |
| GetPropertyType |
Gets the type of the given property
(Inherited from AbstractHierarchicalObject ObjectType .) |
| GetResponseCacheDependencies |
Gets the page dependency keys for the response of the page.
|
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| GetUpperTree |
Gets the upper tree data for inherited values.
|
| GetUsedInheritPageLevels |
Gets the inherit page levels used by this page
|
| GetUsedPageTemplateId |
Gets the page template id used by this document
|
| GetUsedPageTemplateIdColumn |
Gets the page template id used by this document
|
| GetValue |
Gets the object value.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| GetValueFromUpperTree |
Returns string value of selected column.
|
| HasSetter |
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObject ObjectType .) |
| IsProduct |
Returns true if the document represents a product.
|
| IsProductSection |
Returns true if the document type stands for the product section
|
| IsRoot |
Returns true if the given document is a root node
|
| IsWireframe |
Returns true if the document is a wireframe document
|
| LoadContentXml |
Loads the content XML to the content table.
|
| LoadVersion |
Load the current version data of the document to the page info.
|
| LoadVersion(TreeNode) |
Load the given version of the document to the page info.
|
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| RegisterColumn(String, Func ParentObjectType, Object ) |
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegisterColumn(String, Func ParentObjectType, Object , Func ParentObjectType, Object, Object ) |
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegisterColumns |
Registers the Columns of this object
(Overrides AbstractSimpleDataContainer ParentObjectType RegisterColumns .) |
| RegisterProperties |
Registers the properties of this object
(Inherited from AbstractHierarchicalObject ObjectType .) |
| RegisterProperty(String, Func ObjectType, Object ) |
Registers the given property to the object
(Inherited from AbstractHierarchicalObject ObjectType .) |
| RegisterProperty(String, Object, Func ObjectType, Object, Object ) |
Registers the given parameterized property to the object.
(Inherited from AbstractHierarchicalObject ObjectType .) |
| SetPageResult |
Sets the page result object for the given url. The page result object is then accessible via PageResult property.
|
| SetPageTemplateId |
Sets the default document page template ID
|
| SetProperty |
Gets the context property.
(Inherited from AbstractHierarchicalObject ObjectType .) |
| SetValue |
Sets the object value.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryGetProperty(String, Object ) |
Gets the context property.
(Inherited from AbstractHierarchicalObject ObjectType .) |
| TryGetProperty(String, Object , Boolean) |
Returns value of property.
(Inherited from AbstractHierarchicalObject ObjectType .) |
| TryGetValue |
Returns value of column.
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| UseWireframeTemplate |
Returns true if the page uses wireframe template in current context
|
Extension Methods
| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| CopyTo |
Copies the data of specified columns of the source object to the target object.
(Defined by DataExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| CheckRequiredColumns |
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToJSON |
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToXML |
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.) |
Fields
| Name | Description | |
|---|---|---|
 | mClassName |
Document class name.
|
| mDocumentTemplateInstance |
Document widgets template instance.
|
| mEditableItems |
Editable items container.
|
| mGroupTemplateInstance |
Group widgets template instance.
|
| mInheritedPageInfo |
Inherited page info object.
|
| mPageTemplateInfo |
Page template info object.
|
| mPageTemplateInfoLoaded |
If true, the page template info was already loaded
|
| mSiteName |
Document site name.
|
| mTemplateInstance |
Complete page template instance (PageTemplateInfo.TemplateInstance + DocumentTemplateInstance + GroupTemplateInstance + MVTVariants + ContentPersonalizationVariants).
|
| mWireframePageTemplateInfo |
Wireframe page template info object.
|
| mWireframePageTemplateInfoLoaded |
If true, the wireframe page template info was already loaded
|
Properties
| Name | Description | |
|---|---|---|
 | AbsoluteURL |
Gets document absolute URL.
|
| ClassName |
Class name of the current document.
|
| ColumnNames |
Available column names.
(Inherited from AbstractDataContainer ParentObjectType .) |
| DesignPageTemplateInfo |
Page template info used for standard and design view of the document.
|
| DocumentCampaign |
Document campaign.
|
| DocumentContent |
Returns document content XML.
|
| DocumentConversionValue |
Document conversion value - Reflects the "DocumentConversionValue" data column.
|
| DocumentCulture |
Document culture.
|
| DocumentExtensions |
Document extensions.
|
| DocumentGUID |
Document GUID
|
| DocumentCheckedOutVersionHistoryID |
Document checked out version history ID.
|
| DocumentID |
Document ID.
|
| DocumentLogActivity |
Indicates if document enables logging activities.
|
| DocumentMenuCaption |
Document menu caption.
|
| DocumentMenuClass |
Document menu class.
|
| DocumentMenuItemHideInNavigation |
Document menu hide in navigation.
|
| DocumentMenuItemInactive |
Document menu item inactive.
|
| DocumentMenuJavascript |
Document menu JavaScript.
|
| DocumentMenuRedirectToFirstChild |
Indicates if redirection to first child document should be performed when accessed.
|
| DocumentMenuRedirectUrl |
Document Redirect URL.
|
| DocumentMenuStyle |
Document menu style.
|
| DocumentName |
Document name.
|
| DocumentNamePath |
Document name path.
|
| DocumentPageDescription |
Document page description.
|
| DocumentPageKeyWords |
Document page keywords.
|
| DocumentPageTitle |
Document page title.
|
| DocumentPublishedVersionHistoryID |
Document published version history ID.
|
| DocumentPublishFrom |
Document published from.
|
| DocumentPublishTo |
Document published to.
|
| DocumentSearchExcluded |
Indicates whether document should be excluded from search
|
| DocumentStylesheetID |
Document CSS stylesheet ID.
|
| DocumentTemplateInstance |
Document widgets template instance.
|
| DocumentTrackConversionName |
Document conversion name - Reflects the "DocumentTrackConversionName" data column.
|
| DocumentUrlPath |
Document URL path.
|
| DocumentWorkflowCycleGUID |
Workflow cycle GUID to obtain preview link for document
|
| DocumentWorkflowStepID |
Document workflow step ID.
|
| EditableItems |
Editable items contained within the page.
|
| EditableRegions |
Editable regions contained within the document.
|
| EditableWebParts |
Editable WebParts contained within the document.
|
| GroupTemplateInstance |
Group widgets template instance.
|
| ChildPageInfo |
Child page info (for the page path of the PortalControls).
|
 | InheritedPageInfo |
Inherited page info.
|
| IsDocument |
Indicates if document context available.
|
| IsLink |
Indicates whether the document is link to another document.
|
| IsPublished |
Returns true if the node is published.
|
| Item |
Gets the value of particular property
(Inherited from AbstractHierarchicalObject ObjectType .) |
| NodeACLID |
Node ACLID.
|
| NodeAlias |
Node alias.
|
| NodeAliasPath |
Node alias path.
|
| NodeAllowCacheInFileSystem |
Requires authentication property.
|
| NodeBodyElementAttributes |
Node body CSS class.
|
| NodeCacheMinutes |
Node cache minutes.
|
| NodeClassID |
Node class ID.
|
| NodeDocType |
Node document type.
|
| NodeGroupID |
Node group ID.
|
| NodeGUID |
Node GUID.
|
| NodeHeadTags |
Node header tags.
|
| NodeID |
Node ID.
|
| NodeInheritPageTemplate |
If true, the document inherits the page template from parent
|
| NodeLevel |
Node level.
|
| NodeLinkedNodeID |
Linked node ID.
|
| NodeLinkedNodeSiteID |
Linked node site ID.
|
| NodeName |
Node name.
|
| NodeOrder |
Node order.
|
| NodeOwner |
Document owner.
|
| NodeParentID |
Node parent ID.
|
| NodeSiteID |
Node site ID.
|
| NodeSKUID |
Document product ID.
|
| NodeTemplateForAllCultures |
If true, the document uses the same template (NodeTemplateID) for all culture versions
|
| NodeWireframeInheritPageLevels |
Node wireframe inherit page levels.
|
| NodeWireframeTemplateID |
Node wireframe template ID - Special template used for wireframing - Always ad-hoc template
|
| OriginalNodeSiteID |
Original node site ID. Returns NodeSiteID for standard document, LinkedNodeSiteID for linked document.
|
| PageResult |
Gets or sets the contextual page result data object related to the current url.
PageResult returns different data for different document aliases.
|
| PageTitle |
Page title - resolved.
|
| ParentPageInfo |
Parent page info (for the page path), this property is meant for internal purposes of Portal engine.
|
| PermanentURL |
Gets document permanent absolute URL.
|
| Properties |
Properties available through the context.
(Inherited from AbstractHierarchicalObject ObjectType .) |
| PropertyList |
Used property list
(Inherited from AbstractHierarchicalObject ObjectType .) |
| RegisteredColumns |
Registered Columns
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegisteredColumnsObject |
Registered Columns object
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| RegisteredProperties |
Registered properties
(Inherited from AbstractHierarchicalObject ObjectType .) |
| RegisteredPropertiesObject |
Registered properties object
(Inherited from AbstractHierarchicalObject ObjectType .) |
| RelativeURL |
Gets document relative URL.
|
| RequiresAuthentication |
Requires authentication property.
|
| RequiresSSL |
Requires authentication property.
|
| RequiresSSLValue |
Requires authentication property.
|
| SiteName |
Site name of the current document.
|
| TemplateInstance |
Complete page template instance (PageTemplateInfo.TemplateInstance + DocumentTemplateInstance + GroupTemplateInstance).
|
| UpperTree |
Upper tree DataSet (for inheriting of the values).
|
| UsedPageTemplateInfo |
Page template info used by current view mode, either Wireframe or Design page template.
|
| UseLocalColumns |
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainer ParentObjectType .) |
| UseLocalProperties |
If true, the object uses local properties
(Inherited from AbstractHierarchicalObject ObjectType .) |
| WireframePageTemplateInfo |
Page template info used by the wireframe mode.
|
| WorkflowStepName |
Workflow step name.
|
| WorkflowStepType |
Workflow step type.
|
See Also