IPageVersion Interface

Ingeniux CMS Content Store API

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

Syntax

C++

Copy

public interface IPageVersion : IContentCollection, 
	IEntity, IEntityEvents

Public Interface IPageVersion
	Inherits IContentCollection, IEntity, IEntityEvents

public interface class IPageVersion : IContentCollection, 
	IEntity, IEntityEvents

type IPageVersion =  
    interface
        interface IContentCollection
        interface IEntity
        interface IEntityEvents
    end

The IPageVersion type exposes the following members.

Properties

	Name	Description
	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.)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	Date	Gets the date and time when this page version was last changed.
	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.)
	Layout	Gets and sets the page version's layout, which is the file name of its XSLT style sheet.
	Name	Gets and sets the entity's name. (Inherited from IEntity.)
	Page	Gets the Page to which this page version belongs.
	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.
	SchemaName	Gets the root name of the Schema, which is also the root element name of this page version's serialized XML document.
	SchemaVersion	Gets the Schema Version this on which this page version is based. It could be based on a previous version of the Schema.
	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.)
	VersionNumber	Gets the version number of this page version.
	ViewName	Gets and sets this page version's ViewName.
	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]".

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.)
	AddElement	Adds one or multiple elements to the Elements collection.
	AddElementAfter	Adds one or more elements to the Elements collection after the specified anchor element.
	AddElementBefore	Adds one or more elements to the Elements collection before a specified anchor element.
	AddElementFirst	Adds one or more elements to the front of the Elements collection.
	AddElements	Adds a group of elements to the Elements collection.
	AddElementsAfter	Adds a group of elements to the Elements collection after the specified anchor element.
	AddElementsBefore	Adds a group of elements to Elements collection before a specified anchor element.
	AddElementsFirst	Adds a group of elements to the front of the Elements collection.
	AllElements	Retrieves the collection of descendant Elements on which the filter callback method returns true.
	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.)
	ClearAttributes	Clears all Attributes from collection. (Inherited from IContentCollection.)
	ClearElements	Removes all Elements from the collection.
	DOM	Retrieves the XML serialization of this page version. This is the same as the Serialize method.
	Element	Retrieves an Element by its name.
	ElementById	Retrieves an Element by its unique ID.
	Elements	Retrieves the direct child Elements of this page version.
	Elements(String)	Retrieves the direct child Elements of this page version with names that match the specified name. Case-sensitive.
	ElementsCount	Gets the count of all direct child Elements.
	MarkForPublish	Marks this page version for publish on the specified Publishing Target
	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.
	PresentationElements	Retrieves the direct child Elements of this page version that were added by its Presentation Content Unit,
	RemoveAttribute	Removes an Attribute from the collection. (Inherited from IContentCollection.)
	RemoveElement	Removes an Element from the descendants collection.
	SetAttributeValue	Sets an Attribute's value. If the Attribute with the given name doesn't exist, this method creates it. (Inherited from IContentCollection.)
	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.)

Top

Events

	Name	Description
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents.)
	BeforeEntitySave	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:

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

Ingeniux.CMSIPage