Click or drag to resize

IPageVersion Interface


Represents the content of a Page at a specific stage in the page's history. The Page Version object contains Elements and Attributes on the page content, the Presentations of the Page, and references to the page and its Schema Version.

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

The IPageVersion type exposes the following members.

Properties
  NameDescription
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 propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyDate
Gets the date and time when this version was last changed.
(Inherited from IContentItemVersion.)
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 propertyCode exampleLayout
Gets and sets the page version's layout, which is the file name of its XSLT style sheet.
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyPage
Gets the Page to which this page version belongs.
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.
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 this on which this version is based. It could be based on a previous version of the Schema.
(Inherited from IContentItemVersionTSchema, TSchemaVersion.)
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 propertyVersionNumber
Gets the version number of this version.
(Inherited from IContentItemVersion.)
Public propertyViewName
Gets and sets this page version's ViewName.
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]".
Top
Methods
  NameDescription
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 methodAllElements
Retrieves the collection of descendant Elements on which the filter callback method returns true.
(Inherited from IContentItemVersion.)
Public methodClearElements
Removes all Elements from the collection.
(Inherited from IContentItemVersion.)
Public methodDecorateElement
Manually apply Session, Manager, and Owner information on an Element field on this version object
(Inherited from IContentItemVersion.)
Public methodDOM
Retrieves the XML serialization of this page version. This is the same as the Serialize method.
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 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.
Public methodPresentationElements
Retrieves the direct child Elements of this page version that were added by its Presentation Content Unit,
Public methodQuickEditableFields
Retrieves the collection of fields, that represents the version object and contains the summary of the version
(Inherited from IContentItemVersion.)
Public methodRemoveElement
Removes an Element from the descendants collection.
(Inherited from IContentItemVersion.)
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.)
Top
Events
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Top
Remarks

A page contains at least one page version instance, the current version. If the page is checked out, it also contains the check-out version. If the page was previously checked in, it will contain one or more previous versions.

Examples
Example of PageVersion 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