Click or drag to resize

IPage Interface


Represents a node in the content tree within a particular Site. It can be retrieved via Page method from the Site object.

Pages are the building blocks of a CMS Site. Each Page object represents a structured piece of content that represents either a URL on the runtime site or a content block to be included in other pages.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface IPage : IContentItem<IPage, IPageVersion, ISchema, ISchemaVersion>, 
	IContentItem, IContentItemVersion, IEntity<ISite>, IEntity, 
	IEntityEvents, IContentItemWorkflowSuper, IPageVersion, IContentItemVersion<ISchema, ISchemaVersion>, 
	IPageEvents

The IPage type exposes the following members.

Properties
  NameDescription
Public propertyCode example_Locale
Gets/sets the locale name of this object, if this object has language property
(Inherited from IContentItem.)
Public propertyCode exampleAdminRightsEnabled
Gets and sets whether the content item has admin rights enabled. Admin rights will allow actions to the item that cannot normally be done by the user whose session is processing the request.
(Inherited from IContentItemWorkflowSuper.)
Public propertyAssignedGroup
Gets the Group to which this page is currently assigned. If the page is not assigned to a group, this method returns null.
(Inherited from IContentItem.)
Public propertyAssignedUser
Gets the User to whom this page is currently assigned. If the page is not assigned to a user, this method returns null.
(Inherited from IContentItem.)
Public propertyAssignmentComment
Gets the comments from assignments when the page was not in workflow.
(Inherited from IContentItem.)
Public propertyCanMarkForPublish
Controls whether the page is allowed to mark for publish.
(Inherited from IContentItem.)
Public propertyCanParentRegionRoots
Gets and sets whether this content item allows region roots (content items with a noninherited locale) when the content item isn't language-neutral.
(Inherited from IContentItem.)
Public propertyCheckedOut
Gets whether this page is checked out. A page has to be checked out to a specific User to be edited. A page's checked-out content is subject to modification by the assigned User. These modifications can only be published if the page is checked in.
(Inherited from IContentItem.)
Public propertyComments
Gets/sets the comment of this version.

Comments are set during check-in of a IContentItemContent Item

.

However, it can be changed anytime afterwards.

(Inherited from IContentItemVersion.)
Public propertyContentItemType (Inherited from IContentItem.)
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationSchema
Gets the Schema from which this page was originally created from. Note that it is normally the same as Schema property value, unless this Page has presentations and created a new Schema with the presentations.
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyCurrentWorkflow
Gets the workflow this page is in. If page is not in a workflow, this method returns null.
(Inherited from IContentItem.)
Public propertyDate
Gets the date and time when this version was last changed.
(Inherited from IContentItemVersion.)
Public propertyEndDate
Gets and sets the end date of the page. When set, this page will not be included in navigations when current time is greater than the EndDate value.
(Inherited from IContentItem.)
Public propertyHierarchy Obsolete. (Inherited from IContentItem.)
Public propertyIcon
Gets and sets the icon of the page. The value is the numeric representation of the icon images.
(Inherited from IContentItem.)
Public propertyCode exampleInWorkflowTransition
Gets and sets whether the content item is being accessed within the bounds of a workflow transition.
(Inherited from IContentItemWorkflowSuper.)
Public propertyIsComponent
Gets whether this page is a component. Components are used as part of other pages, don't have their own URL entries, and don't have specific view or style sheet rendering specified in content.
Public propertyJustSynced
Gets whether the page's content was updated via Schema synchronization and hasn't yet been modified directly.
(Inherited from IContentItem.)
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyLastVersion
Gets the most-recent previous version. It is the version before this page was last checked in.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public propertyCode exampleLayout
Gets and sets the page version's layout, which is the file name of its XSLT style sheet.
(Inherited from IPageVersion.)
Public propertyLocale
Gets and sets the language of this page.
(Inherited from IContentItem.)
Public propertyLocaleInherited
Gets whether this page inherits its locale from its ancestor page.
(Inherited from IContentItem.)
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertyMasterLingualMap
Gets the lingual map between this page and its Master Page.
(Inherited from IContentItem.)
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyNowSyncing
Gets whether the page is currently being synchronized to the latest version of the Schema used to create it.
(Inherited from IContentItem.)
Public propertyPage
Gets the Page to which this page version belongs.
(Inherited from IPageVersion.)
Public propertyParentId
Gets the unique ID of the parent object
(Inherited from IContentItem.)
Public propertyPCRDescriptorID
Gets the ID of a page creation rule (PCR) descriptor. PCR Descriptors are used to mark pages that have specific PCR settings.
Public propertyPresentations
Gets and sets the Presentations of this page version. This value is null by default, meaning there is no presentation for rendering in Page Builder mode.
(Inherited from IPageVersion.)
Public propertyReferenceMapping
Retrieves the directly referenced page IDs for this page. This mappings are reference pages added to this page.
Public propertyRemoved
Gets whether the page is under Removed status, which means it is currently a descendant of the Recycle Folder.
(Inherited from IContentItem.)
Public propertyRulesInherited
Gets and sets whether this page inherits the page creation rule (PCR) settings from its parent page or has its own page creation settings.
Public propertySchema
Gets the Schema from which this page is based on.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public propertySchemaName
Gets the root name of the Schema, which is also the root element name of this version's serialized XML document.
(Inherited from IContentItemVersion.)
Public propertySchemaVersion
Gets the Schema Version which with this page is synchronized. Note that if the schema has not been updated and or sychronized to this page, the page will be on a older version of the schema.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public propertySecurityDescriptor
Gets the security descriptor of this content item
(Inherited from IContentItem.)
Public propertySecurityInherited
Gets whether this content item has security inherited from its parent
(Inherited from IContentItem.)
Public propertySerializeOnCheckIn
Determines whether to serialize an xID.xml file to the v9 XML root on check-in.
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Public propertySiblingPosition
Gets the position of this object among its siblings
(Inherited from IContentItem.)
Public propertySite
Gets the Site object that owns the current page. This Site object was the object in charge of retrieving or creating the current Page object.
Public propertyStartDate
Gets and sets the start date of the page. When set, this page will not be included in navigations when current time is less than the StartDate value.
(Inherited from IContentItem.)
Public propertyVersionNumber
Gets the version number of this version.
(Inherited from IContentItemVersion.)
Public propertyViewName
Gets and sets this page version's ViewName.
(Inherited from IPageVersion.)
Public propertyCode exampleXID
Gets the ID of the Page that owns this page version. A page's ID (known as an xID) takes the form "x[integer]".
(Inherited from IPageVersion.)
Top
Methods
  NameDescription
Public methodAddCategories
Adds Categories association to this Page. Which also means, categorized this page with given categories.
(Inherited from IContentItem.)
Public methodAddElement
Adds one or multiple elements to the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddElementAfter
Adds one or more elements to the Elements collection after the specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementBefore
Adds one or more elements to the Elements collection before a specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementFirst
Adds one or more elements to the front of the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddElements
Adds a group of elements to the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddElementsAfter
Adds a group of elements to the Elements collection after the specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementsBefore
Adds a group of elements to Elements collection before a specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementsFirst
Adds a group of elements to the front of the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddToWorkflow
Adds this page to workflow. This operation creates a new workflow instance for this page based on the Workflow Definition provided and assigns the page to the specified User.
(Inherited from IContentItem.)
Public methodAddToWorkflowDefault
Adds this page to a workflow. If the initial Transition has a Default User specified, the page will be assigned to that user. Otherwise, it will be assigned to the Next Group specified by the transition. This operation creates a new workflow instance for this page based on the Workflow Definition provided.
(Inherited from IContentItem.)
Public methodAllElements
Retrieves the collection of descendant Elements on which the filter callback method returns true.
(Inherited from IContentItemVersion.)
Public methodAllowUser
Checks whether the given user was granted the specified access level.
(Inherited from IContentItem.)
Public methodAncestors
Retrieves all of this page's ancestor pages. The results are returned in ascending order based on the pages' hierarchy level.
Public methodAncestorsCount
Returns the count of ancestors for this content item.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public methodAncestorsIDs
Retrieves the metadata of all this page's ancestor pages. The results are returned in ascending order based on the pages' hierarchy level.
Public methodAssignGroup
Assigns this page to a specific User Group.
(Inherited from IContentItem.)
Public methodAssignUser
Assigns this page to a specific User.
(Inherited from IContentItem.)
Public methodAssociatedCategories
Retrieves the collection of Categories associated with this page.
(Inherited from IContentItem.)
Public methodAssociatedCategoriesCount
Gets the count of the Categories that are associated with this page.
(Inherited from IContentItem.)
Public methodCheckedInPage
Retrieves the checked-in content of this page. If the page is checked out, there could be potential differences between the content of the page and result of this method.
Public methodCheckedInVersion
Retrieves the checked in version of the item. Mainly used for retrieving checked in version on a checked out item
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public methodCheckIn
Checks in either the page itself or the page and its descendants.
(Inherited from IContentItem.)
Public methodCheckInOnProfile
Checks in either the page itself or the page and its descendants toward the Publishing Targets included in the Publishing Profile.
(Inherited from IContentItem.)
Public methodCheckInSingle(IEnumerableString, String) (Inherited from IContentItem.)
Public methodCheckInSingle(IEnumerableIPublishingTarget, String) (Inherited from IContentItem.)
Public methodCheckInSingleWithNoValidate
Checks in the page itself without applying validations before check-in.
(Inherited from IContentItem.)
Public methodCheckInSingleWithNoValidateOnProfile
Checks in the page itself, without applying validations before check-in, toward the Publishing Targets included in the Publishing Profile.
(Inherited from IContentItem.)
Public methodCheckOut
Checks out the page and assigns it to the current user. A page can only be edited after it is checked out to the current user.
(Inherited from IContentItem.)
Public methodChildren
Retrieves this page's child pages.
Public methodChildrenCount
Returns the count of child pages of this page.
Public methodClaimPageForCurrentUser
Assigns the Page to the current operating User.
(Inherited from IContentItem.)
Public methodClearElements
Removes all Elements from the collection.
(Inherited from IContentItemVersion.)
Public methodClearRules
Removes all Page Creation Rules from this page. This action permanently removes the PCR descriptor for this page.
Public methodClearSecurity
Clears all access to this page. Note that if no further security setting procedures are taken, no one except administrators will have access to this page . This action permenantly removes the security descriptor for this page.
(Inherited from IContentItem.)
Public methodCloneLingualMaps
Retrieves the lingual maps between this page and its clone pages.
(Inherited from IContentItem.)
Public methodCloneLingualMapsCount
Returns the count of all clone lingual maps.
(Inherited from IContentItem.)
Public methodContentUnitsInstantiability
Gets the collection of information on whether a Content Unit can be instantiated, and how many times it can be instantiated.
Public methodCreateChildPage
Creates a new child page under the current page.
Public methodDecorateElement
Manually apply Session, Manager, and Owner information on an Element field on this version object
(Inherited from IContentItemVersion.)
Public methodCode exampleDescendantIDsWithMaxDepth
Retrieves metadata of the descendants of this page within the given depth limit.
(Inherited from IContentItem.)
Public methodDescendantIDsWithMaxDepthForPreview
Retrieves the collection of descendants hierarchy information, under the limitations of maximum descendants depth, and maximum descendants count.
(Inherited from IContentItem.)
Public methodDescendants
Retrieves the descendants of this page. The results are returned in descending order based on the pages' hierarchy level.
Public methodDescendantsCount
Returns the count of all descendants of this page.
Public methodDescendantsIDs
Retrieves metadata of the descendants of this page. The results are returned in ascending order based on the pages' hierarchy level.
(Inherited from IContentItem.)
Public methodDescendantsWithMaxDepth
Retrieves the descendants of this page within the given depth limit.
Public methodDOM
Retrieves the XML serialization of this page version. This is the same as the Serialize method.
(Inherited from IPageVersion.)
Public methodElement
Retrieves an Element by its name.
(Inherited from IContentItemVersion.)
Public methodElementById
Retrieves an Element by its unique ID.
(Inherited from IContentItemVersion.)
Public methodElements
Retrieves the direct child Elements of this version.
(Inherited from IContentItemVersion.)
Public methodElements(String)
Retrieves the direct child Elements of this version with names that match the specified name. Case-sensitive.
(Inherited from IContentItemVersion.)
Public methodElementsCount
Gets the count of all direct child Elements.
(Inherited from IContentItemVersion.)
Public methodGetSystemAttribute
Retrieves a system attribute by its enum value. System attributes are attributes on a page document that contain the page's metadata.
(Inherited from IContentItem.)
Public methodIsDescendantOf
Checks whether this page is a descendant of another given page.
Public methodIsValidRuleTarget
Checks whether, with the given Page Creation Rule, pages can be created as children of this page.
Public methodMarkedForPublish
Finds out whether the page is marked for publish on any Publishing Target.
(Inherited from IContentItem.)
Public methodMarkedForPublishOnTarget(String)
Finds out whether the page is marked for publish on a specific Publishing Target.
(Inherited from IContentItem.)
Public methodMarkedForPublishOnTarget(IPublishingTarget)
Finds out whether the page is marked for publish on a specific Publishing Target.
(Inherited from IContentItem.)
Public methodMarkedForPublishPropagated
Finds out whether the page is marked on all Publishing Targets, and the marked versions are the targets are the latest version of this page.
(Inherited from IContentItem.)
Public methodMarkedVersion(String)
Retrieves the marked version object on a specific Publishing Target. Can be null if not marked on that Publishing Target
(Inherited from IContentItem.)
Public methodMarkedVersion(IPublishingTarget)
Retrieves the marked version object on a specific Publishing Target. Can be null if not marked on that Publishing Target
(Inherited from IContentItem.)
Public methodMarkedVersionNumber(String)
Retrieves the marking version number on a specific Publishing Target. If item is not marked on that target, returns -1
(Inherited from IContentItem.)
Public methodMarkedVersionNumber(IPublishingTarget)
Retrieves the marking version number on a specific Publishing Target. If item is not marked on that target, returns -1
(Inherited from IContentItem.)
Public methodMarkForPublish
Marks this version for publish on the specified Publishing Target
(Inherited from IContentItem.)
Public methodNextChildPosition
Retrieves position reversed for the next child object to be created under this object
(Inherited from IContentItem.)
Public methodNextSibling
Retrieves the sibling Page succeeds the given page on the content tree.
Public methodPageCreationRules
Retrieves the collection of page creation rules that can be used to create pages under this page. The collection also includes the information on whether the PCR covers descendants.
Public methodPageCreationRulesCount
Retrieves the count of the collection of Page Creation Rules that can be used to create pages under this page.
Public methodParent
Retrieves the parent page of the given page.
Public methodPath
Retrieves the string path of the page names, starting from the content store root node. Delimited by "/".
(Inherited from IContentItem.)
Public methodPresentationElement
Retrieves an Element that was added by its Presentation Content Unit by its unique ID. This method will not return elements that are outside of the presentation fields group.
(Inherited from IPageVersion.)
Public methodPresentationElements
Retrieves the direct child Elements of this page version that were added by its Presentation Content Unit,
(Inherited from IPageVersion.)
Public methodPreviousSibling
Retrieves the sibling page that precedes the given page on the content tree.
Public methodQuickEditableFields
Retrieves the collection of fields, that represents the version object and contains the summary of the version
(Inherited from IContentItemVersion.)
Public methodRegionRoot
Retrieves the Locale (language) root of this page.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public methodRemoveCategory
Removes the association between this page and the specified Category.
(Inherited from IContentItem.)
Public methodRemoveChildPage
Removes a child Page of this page.
Public methodRemoveChildren
Removes all children of this page. If the page is not in the Recycle Folder, the child pages will be moved there. Otherwise, they are permenantly deleted.
Public methodRemoveElement
Removes an Element from the descendants collection.
(Inherited from IContentItemVersion.)
Public methodRemoveFromWorkflow
Removes the page from its Current Workflow.
(Inherited from IContentItem.)
Public methodRemovePageCreationRule
Removes a Page Creation Rule (PCR) from this page.
Public methodRemoveSecurityGroup
Removes the access rights of a given user group to this page.
(Inherited from IContentItem.)
Public methodRepublish
Publishes the page, with or without its descendants, to the specified Publishing Target.
Public methodRevertToVersion
Reverts the page's content to that of a given Version.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public methodRollback
Reverts a page's content to that of its latest previous Version.
(Inherited from IContentItem.)
Public methodSave
Saves this page's XML content. This method must be called to update a page's XML content.
(Inherited from IContentItem.)
Public methodSecurityGroups
Retrieves the collection of User Groups that have the given access level on this page.
(Inherited from IContentItem.)
Public methodSecurityGroupsCount
Retrieves the count of User Groups that have a security setting—either explicit or inherited from parent pages—on this page.
(Inherited from IContentItem.)
Public methodSecurityLevel
Retrieves the access level of specific User. The access level is the highest access level of all the Groups to which this user belongs.
(Inherited from IContentItem.)
Public methodSendGroupNotificationMail
Sends out a Workflow notification email to all Users of a given Group.
(Inherited from IContentItem.)
Public methodSendWorkFlowNotificationMail
Sends a workflow notification email to the given recipients.
(Inherited from IContentItem.)
Public methodSerializeCheckedInVersion
Returns the XML element that was serialized from the checked-in version of this page.
(Inherited from IContentItem.)
Public methodSetPageCreationRule
Sets a page creation rule (PCR) descriptor on this page. When executed successfully, this action sets RulesInherited to false. If this page never had a PCR descriptor before, it will be created automatically. Otherwise, it will resume on the existing descriptor.
Public methodSetSecurityGroup
Sets the access level to this page for a specific User Group. Successful execution of this method causes the SecurityInherited property to be set to false.
(Inherited from IContentItem.)
Public methodSetSystemAttribute(EnumSystemAttributes, IAttribute)
Sets value for a system attribute.
(Inherited from IContentItem.)
Public methodSetSystemAttribute(EnumSystemAttributes, String)
Sets string value for a system attribute.
(Inherited from IContentItem.)
Public methodSiblingIDs
Retrieves sibling page info of this page on the content tree.
Public methodSiblings
Retrieves sibling pages of this page on the content tree.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public methodUnassign
Removes the assignment of this page so that it doesn't belong to any User or Group.
(Inherited from IContentItem.)
Public methodUndoCheckOut
Discards the changes in checked-out content and reverts the page to a checked-in state.
(Inherited from IContentItem.)
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity.)
Public methodVersion
Retrieves a Version of this page by version number.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public methodVersionId
Retrieves the page version entity ID for the version number, including current if it is so.
Public methodVersions
Retrieves the version history of this page. The items are returned by version number in descending order.
(Inherited from IContentItemT, TVersion, TSchema, TSchemaVersion.)
Public methodVersionsCount
Gets the count of all previous versions of this page.
(Inherited from IContentItem.)
Top
Events
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventAfterPageAssign
This event is fired after page is assigned.
(Inherited from IPageEvents.)
Public eventAfterPageCheckIn
This event is fired after a page is checked in.
(Inherited from IPageEvents.)
Public eventAfterPageCheckOut
This event is fired after a page is checked out.
(Inherited from IPageEvents.)
Public eventAfterPageMarkForPublishChange
This event is fired after a page had marked-for-publish changes applied to it.
(Inherited from IPageEvents.)
Public eventAfterPageRollback
This event is fired after a page is rolled back.
(Inherited from IPageEvents.)
Public eventAfterPageUndoCheckOut
This event is fired after a page undo check-out.
(Inherited from IPageEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Public eventBeforePageAssign
This event is fired before page is assigned.
(Inherited from IPageEvents.)
Public eventBeforePageCheckIn
This event is fired before a page is checked in.
(Inherited from IPageEvents.)
Public eventBeforePageCheckOut
This event is fired before a page is checked out.
(Inherited from IPageEvents.)
Public eventBeforePageMarkForPublishChange
This event is fired before a page has any changes marked for publish.
(Inherited from IPageEvents.)
Public eventBeforePageRollback
This event is fired before a page is rolled back to previous version.
(Inherited from IPageEvents.)
Public eventBeforePageUndoCheckOut
This event is fired before a page undo check-out.
(Inherited from IPageEvents.)
Public eventPageRenamed
This event is fired after a page is renamed.
(Inherited from IPageEvents.)
Top
Examples
Example of page serialization output:
XML
<?xml version="1.0" encoding="utf-8"?>
<Details ID="x9" Name="Terms" IsComponent="false" ViewName="Details">
  <Title type="string" UID="df5fea71-5d6a-4cd0-a1f1-bc21c7d2e628" label="Title" readonly="false" hidden="true" required="false">Terms of Service</Title>
  <BodyCopy type="xhtml" UID="2d1c3d20-b7ee-42c6-87d9-5edeacabd31a" label="Body Copy" readonly="true" hidden="false" required="false" Height="">
    Fusce condimentum eleifend enim a feugiat. Pellentesque viverra vehicula sem ut volutpat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut non libero magna. Sed et quam lacus. Fusce condimentum eleifend enim a feugiat.
  </BodyCopy>
  <xPower Type="Component" Name="SiteControl" Component="x4" UID="5eacaa24-b25a-4a3a-b38c-ecf2ae2dc241" label="网站通用内容" readonly="false" hidden="false" required="false" CompTypes="SiteControl" WrappedUp="" AllowWrappingChange="false" componentName="SiteControl" AutoEmbed="false" Embedded="false" />
  <xPower Type="Navigation" Name="AncestorNavigation" Navigation="Ancestors" UID="d206ba6f-9fca-4e3e-bbf1-151948d7ccd1" label="Ancestor Navigation" readonly="false" hidden="false" required="false" Expanded="false" GenerationOrder="down" StartPage="x2" MaxNodes="" MaxDepth="" Query="" />
  <IGX_Presentations>
    <DefaultPresentations />
    <MobilePresentations />
  </IGX_Presentations>
</Details>
See Also