Click or drag to resize

IPagePresentationCollection Interface


Represents the collection of presentations for an given Page. This object is always part of IPageVersion, never stored in database as an indenpendent entity

Namespace:  Ingeniux.CMS.Presentation
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface IPagePresentationCollection : IContentUnitInstanceEvents

The IPagePresentationCollection type exposes the following members.

Properties
  NameDescription
Public propertyHasPresentation
Gets wether the collection has presentation
Public propertyLastUpdated
Gets the time when the collection was last changed
Top
Methods
  NameDescription
Public methodAddDefaultPresentation
Creates a new presentation, with information of applied Publishing Targets
Public methodAddMobilePresentation
Public methodAllContentUnitInstances
Retrieves all Content Unit Instances across all Presentations in this collection
Public methodAssignPresentationPublishingTarget
Assigns which Publishing Targets the specified Presentation can will be published to
Public methodClear
Permanently remove all presentations from the collection
Public methodCount
Retrieves the total number of Presentations in this collection
Public methodDefaultPresentationForPublishingTarget
Retrieves a presentation by an Publishing Target, where its rendering template will be published, when publishing to that target.
Public methodDefaultPresentations
Retrieves all Presentations
Public methodElementReferences
Find out how many times the specified element has been used in Presentations across this collection
Public methodGetPublishingTargetIdsForPresentation
Retrieves ids of all Publishing Targets, that the specified Presentation will be published to
Public methodMobilePresentationForPublishingTarget
Public methodMobilePresentations
Public methodMobilePresentationsForPublishingTarget
Public methodPresentation
Retrieves a presentation by its unique id
Public methodCode examplePublish

Publishes the markup templates of the presentation associated with the given Publishing Target. The markup templates are to be generated as individual files located under "RenderingTemplates" folder.

It will live in a folder named after the Page's id.

The file names will be the Presentation names, which ".igxt" as extension

Examples
default.igxt

Public methodRemovePresentation
Permanently removes one Presentation by its unique id
Public methodRemovePresentations
Permanently removes all Presentations that can be published to the specified Publishing Target
Public methodSerializeForPage
Produces the XML element that will be injected into Page XML upon publish
Top
Events
  NameDescription
Public eventContentUnitAdded
This event is fired when a new Content Unit Instance is placed within a Layout Column
(Inherited from IContentUnitInstanceEvents.)
Public eventContentUnitRemoving
This event is fired when a Content Unit Instance is being removed when its parent Layout Column
(Inherited from IContentUnitInstanceEvents.)
Public eventDisplayUnitUpdated
This events is fired when any Display Unit is updated within a Presentation
(Inherited from IContentUnitInstanceEvents.)
Top
See Also