IPage Properties Ingeniux CMS Content Store API

The IPage type exposes the following members.

Properties

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

Reference