IPage Interface

Ingeniux CMS Content Store API

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: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public interface IPage : IPageVersion, IContentCollection, 
	IEntity, IEntityEvents, IPageEvents

Public Interface IPage
	Inherits IPageVersion, IContentCollection, IEntity, IEntityEvents, 
	IPageEvents

public interface class IPage : IPageVersion, 
	IContentCollection, IEntity, IEntityEvents, IPageEvents

type IPage =  
    interface
        interface IPageVersion
        interface IContentCollection
        interface IEntity
        interface IEntityEvents
        interface IPageEvents
    end

The IPage type exposes the following members.

Properties

	Name	Description
	AssignedGroup	Gets the Group to which this page is currently assigned. If the page is not assigned to a group, this method returns null.
	AssignedUser	Gets the User to whom this page is currently assigned. If the page is not assigned to a user, this method returns null.
	AssignmentComment	Gets the comments from assignments when the page was not in workflow.
	CanMarkForPublish	Controls whether the page is allowed to mark for publish.
	CanParentRegionRoots	Gets and sets whether this page allows region roots (pages with a noninherited locale) when the page isn't language-neutral.
	CheckedOut	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.
	ContentUnitTemplateName	Gets and sets the template name this field uses. Only fields generated via ContentUnit placement have this value. (Inherited from IContentCollection.)
	Created	Gets the entity's creation date. (Inherited from IEntity.)
	CreationSchema	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.
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	CurrentWorkflow	Gets the workflow this page is in. If page is not in a workflow, this method returns null.
	Date	Gets the date and time when this page version was last changed. (Inherited from IPageVersion.)
	EndDate	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.
	Hierarchy	Gets the hierarchy value of the page in the content tree.
	Icon	Gets and sets the icon of the page. The value is the numeric representation of the icon images.
	IsComponent	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.
	JustSynced	Gets whether the page's content was updated via Schema synchronization and hasn't yet been modified directly.
	LastModified	Gets the date when the entity was most recently modified. (Inherited from IEntity.)
	LastModifiedUser	Gets the ID of the User who lasted edited the entity. (Inherited from IEntity.)
	LastVersion	Gets the most-recent previous version. It is the version before this page was last checked in.
	Layout	Gets and sets the page version's layout, which is the file name of its XSLT style sheet. (Inherited from IPageVersion.)
	Locale	Gets and sets the language of this page.
	LocaleInherited	Gets whether this page inherits its locale from its ancestor page.
	MasterLingualMap	Gets the lingual map between this page and its Master Page.
	Name	Gets and sets the entity's name. (Inherited from IEntity.)
	NowSyncing	Gets whether the page is currently being synchronized to the latest version of the Schema used to create it.
	Page	Gets the Page to which this page version belongs. (Inherited from IPageVersion.)
	PCRDescriptorID	Gets the ID of a page creation rule (PCR) descriptor. PCR Descriptors are used to mark pages that have specific PCR settings.
	Presentations	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.)
	ReferenceMapping	Retrieves the directly referenced page IDs for this page. This mappings are reference pages added to this page.
	Removed	Gets whether the page is under Removed status, which means it is currently a descendant of the Recycle Folder.
	RulesInherited	Gets and sets whether this page inherits the page creation rule (PCR) settings from its parent page or has its own page creation settings.
	Schema	Gets the Schema from which this page is based on.
	SchemaName	Gets the root name of the Schema, which is also the root element name of this page version's serialized XML document. (Inherited from IPageVersion.)
	SchemaVersion	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.
	SecurityInherited	Gets and sets whether this page inherits security information from its parent page.
	SerializeOnCheckIn	Determines whether to serialize an xID.xml file to the v9 XML root on check-in.
	Session	Gets the session that retrieved this entity. An entity is always session-specific. (Inherited from IEntity.)
	SessionId	Gets the unique ID of the session that retrieved this entity. (Inherited from IEntity.)
	Site	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.
	StartDate	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.
	VersionNumber	Gets the version number of this page version. (Inherited from IPageVersion.)
	ViewName	Gets and sets this page version's ViewName. (Inherited from IPageVersion.)
	XID	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

	Name	Description
	AddAttribute	Adds one or more Attributes to the ContentCollection. This method accepts variable number of Attribute objects as parameters. (Inherited from IContentCollection.)
	AddAttributes	Adds a collection of Attributes to the Content Collection. (Inherited from IContentCollection.)
	AddCategories	Adds Categories association to this Page. Which also means, categorized this page with given categories.
	AddElement	Adds one or multiple elements to the Elements collection. (Inherited from IPageVersion.)
	AddElementAfter	Adds one or more elements to the Elements collection after the specified anchor element. (Inherited from IPageVersion.)
	AddElementBefore	Adds one or more elements to the Elements collection before a specified anchor element. (Inherited from IPageVersion.)
	AddElementFirst	Adds one or more elements to the front of the Elements collection. (Inherited from IPageVersion.)
	AddElements	Adds a group of elements to the Elements collection. (Inherited from IPageVersion.)
	AddElementsAfter	Adds a group of elements to the Elements collection after the specified anchor element. (Inherited from IPageVersion.)
	AddElementsBefore	Adds a group of elements to Elements collection before a specified anchor element. (Inherited from IPageVersion.)
	AddElementsFirst	Adds a group of elements to the front of the Elements collection. (Inherited from IPageVersion.)
	AddToWorkflow	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.
	AddToWorkflowDefault	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.
	AllElements	Retrieves the collection of descendant Elements on which the filter callback method returns true. (Inherited from IPageVersion.)
	AllowUser	Checks whether the given user was granted the specified access level.
	Ancestors	Retrieves all of this page's ancestor pages. The results are returned in ascending order based on the pages' hierarchy level.
	AncestorsCount	Returns the count of ancestors for this page.
	AncestorsIDs	Retrieves the metadata of all this page's ancestor pages. The results are returned in ascending order based on the pages' hierarchy level.
	AssignGroup	Assigns this page to a specific User Group.
	AssignUser	Assigns this page to a specific User.
	AssociatedCategories	Retrieves the collection of Categories associated with this page.
	AssociatedCategoriesCount	Gets the count of the Categories that are associated with this page.
	Attribute	Gets a specific Attribute by name (Inherited from IContentCollection.)
	Attributes	(Inherited from IContentCollection.)
	AttributesCount	Gets the count of Attributes in the ContentCollection. (Inherited from IContentCollection.)
	AttributeValue	Gets the value of a specific Attribute by name. (Inherited from IContentCollection.)
	CheckedInPage	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.
	CheckIn	Checks in either the page itself or the page and its descendants.
	CheckInOnProfile	Checks in either the page itself or the page and its descendants toward the Publishing Targets included in the Publishing Profile.
	CheckInSingleWithNoValidate	Checks in the page itself without applying validations before check-in.
	CheckInSingleWithNoValidateOnProfile	Checks in the page itself, without applying validations before check-in, toward the Publishing Targets included in the Publishing Profile.
	CheckOut	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.
	Children	Retrieves this page's child pages.
	ChildrenCount	Returns the count of child pages of this page.
	ClaimPageForCurrentUser	Assigns the Page to the current operating User.
	ClearAttributes	Clears all Attributes from collection. (Inherited from IContentCollection.)
	ClearElements	Removes all Elements from the collection. (Inherited from IPageVersion.)
	ClearRules	Removes all Page Creation Rules from this page. This action permanently removes the PCR descriptor for this page.
	ClearSecurity	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.
	CloneLingualMaps	Retrieves the lingual maps between this page and its clone pages.
	CloneLingualMapsCount	Returns the count of all clone lingual maps.
	ContentUnitsInstantiability	Gets the collection of information on whether a Content Unit can be instantiated, and how many times it can be instantiated.
	CreateChildPage	Creates a new child page under the current page.
	Descendants	Retrieves the descendants of this page. The results are returned in descending order based on the pages' hierarchy level.
	DescendantsCount	Returns the count of all descendants of this page.
	DescendantsIDs	Retrieves metadata of the descendants of this page. The results are returned in ascending order based on the pages' hierarchy level.
	DescendantsIDsWithMaxDepth	Retrieves metadata of the descendants of this page within the given depth limit.
	DescendantsIDsWithMaxDepthForPreview
	DescendantsWithMaxDepth	Retrieves the descendants of this page within the given depth limit.
	DOM	Retrieves the XML serialization of this page version. This is the same as the Serialize method. (Inherited from IPageVersion.)
	Element	Retrieves an Element by its name. (Inherited from IPageVersion.)
	ElementById	Retrieves an Element by its unique ID. (Inherited from IPageVersion.)
	Elements	Retrieves the direct child Elements of this page version. (Inherited from IPageVersion.)
	Elements(String)	Retrieves the direct child Elements of this page version with names that match the specified name. Case-sensitive. (Inherited from IPageVersion.)
	ElementsCount	Gets the count of all direct child Elements. (Inherited from IPageVersion.)
	GetSystemAttribute	Retrieves a system attribute by its enum value. System attributes are attributes on a page document that contain the page's metadata.
	IsDescendantOf	Checks whether this page is a descendant of another given page.
	IsValidRuleTarget	Checks whether, with the given Page Creation Rule, pages can be created as children of this page.
	MarkedForPublish	Finds out whether the page is marked for publish on any Publishing Target.
	MarkedForPublishOnTarget(String)	Finds out whether the page is marked for publish on a specific Publishing Target.
	MarkedForPublishOnTarget(IPublishingTarget)	Finds out whether the page is marked for publish on a specific Publishing Target.
	MarkedForPublishPropagated	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.
	MarkForPublish	Marks this page version for publish on the specified Publishing Target (Inherited from IPageVersion.)
	NextSibling	Retrieves the sibling Page succeeds the given page on the content tree.
	PageCreationRules	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.
	PageCreationRulesCount	Retrieves the count of the collection of Page Creation Rules that can be used to create pages under this page.
	Parent	Retrieves the parent page of the given page.
	Path	Retrieves the string path of the page names, starting from the content store root node. Delimited by "/".
	PresentationElement	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.)
	PresentationElements	Retrieves the direct child Elements of this page version that were added by its Presentation Content Unit, (Inherited from IPageVersion.)
	PreviousSibling	Retrieves the sibling page that precedes the given page on the content tree.
	RegionRoot	Retrieves the Locale (language) root of this page.
	RemoveAttribute	Removes an Attribute from the collection. (Inherited from IContentCollection.)
	RemoveCategory	Removes the association between this page and the specified Category.
	RemoveChildPage	Removes a child Page of this page.
	RemoveChildren	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.
	RemoveElement	Removes an Element from the descendants collection. (Inherited from IPageVersion.)
	RemoveFromWorkflow	Removes the page from its Current Workflow.
	RemovePageCreationRule	Removes a Page Creation Rule (PCR) from this page.
	RemoveSecurityGroup	Removes the access rights of a given user group to this page.
	Republish	Publishes the page, with or without its descendants, to the specified Publishing Target.
	RevertToVersion	Reverts the page's content to that of a given Version.
	Rollback	Reverts a page's content to that of its latest previous Version.
	Save	Saves this page's XML content. This method must be called to update a page's XML content.
	SecurityGroups	Retrieves the collection of User Groups that have the given access level on this page.
	SecurityGroupsCount	Retrieves the count of User Groups that have a security setting—either explicit or inherited from parent pages—on this page.
	SecurityLevel	Retrieves the access level of specific User. The access level is the highest access level of all the Groups to which this user belongs.
	SendGroupNotificationMail	Sends out a Workflow notification email to all Users of a given Group.
	SendWorkFlowNotificationMail	Sends a workflow notification email to the given recipients.
	SerializeCheckedInVersion	Returns the XML element that was serialized from the checked-in version of this page.
	SetAttributeValue	Sets an Attribute's value. If the Attribute with the given name doesn't exist, this method creates it. (Inherited from IContentCollection.)
	SetPageCreationRule	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.
	SetSecurityGroup	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.
	SetSystemAttribute(EnumSystemAttributes, IAttribute)	Sets value for a system attribute.
	SetSystemAttribute(EnumSystemAttributes, String)	Sets string value for a system attribute.
	SiblingIDs	Retrieves sibling page info of this page on the content tree.
	Siblings	Retrieves sibling pages of this page on the content tree.
	Unassign	Removes the assignment of this page so that it doesn't belong to any User or Group.
	UndoCheckOut	Discards the changes in checked-out content and reverts the page to a checked-in state.
	ValidateData	Validates this entity's data. Implemented by concrete inheriting types. (Inherited from IEntity.)
	ValidateUserPermission	Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity. (Inherited from IEntity.)
	Version	Retrieves a Version of this page by version number.
	VersionId	Retrieves the page version entity ID for the version number, including current if it is so.
	Versions	Retrieves the version history of this page. The items are returned by version number in descending order.
	VersionsCount	Gets the count of all previous versions of this page.

Top

Events

	Name	Description
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents.)
	AfterPageAssign	This event is fired after page is assigned. (Inherited from IPageEvents.)
	AfterPageCheckIn	This event is fired after a page is checked in. (Inherited from IPageEvents.)
	AfterPageCheckOut	This event is fired after a page is checked out. (Inherited from IPageEvents.)
	AfterPageMarkForPublishChange	This event is fired after a page had marked-for-publish changes applied to it. (Inherited from IPageEvents.)
	AfterPageRollback	This event is fired after a page is rolled back. (Inherited from IPageEvents.)
	AfterPageUndoCheckOut	This event is fired after a page undo check-out. (Inherited from IPageEvents.)
	BeforeEntitySave	This event is fired before any Entity object is about to be saved. (Inherited from IEntityEvents.)
	BeforePageAssign	This event is fired before page is assigned. (Inherited from IPageEvents.)
	BeforePageCheckIn	This event is fired before a page is checked in. (Inherited from IPageEvents.)
	BeforePageCheckOut	This event is fired before a page is checked out. (Inherited from IPageEvents.)
	BeforePageMarkForPublishChange	This event is fired before a page has any changes marked for publish. (Inherited from IPageEvents.)
	BeforePageRollback	This event is fired before a page is rolled back to previous version. (Inherited from IPageEvents.)
	BeforePageUndoCheckOut	This event is fired before a page undo check-out. (Inherited from IPageEvents.)
	PageRenamed	This event is fired after a page is renamed. (Inherited from IPageEvents.)

Top

Examples

Example of page serialization output:

Copy

<?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>

Reference

Ingeniux.CMS Namespace