Click or drag to resize

IComponentContentUnitInstance Interface


Represents an instance of Component Content Unit placed into a Page Presentation

Namespace:  Ingeniux.CMS.Presentation
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface IComponentContentUnitInstance : IContentUnitInstance, 
	IDisplayUnit, IContentUnitInstanceEvents

The IComponentContentUnitInstance type exposes the following members.

Properties
  NameDescription
Public propertyAncestorGroupNames
Gets the names of Group Elements, that are ancestors of the underlying Element of this instance
(Inherited from IContentUnitInstance.)
Public propertyContentContainerId
Gets/set the id of the container html element that is used to host child Layout.
Public propertyElementId
Gets the id of the underlying Element
(Inherited from IContentUnitInstance.)
Public propertyElementName
Gets the name of the underlying Element
(Inherited from IContentUnitInstance.)
Public propertyIcon
Gets the icon name of this Content Unit Instance
(Inherited from IContentUnitInstance.)
Public propertyLayout
Gets/sets the child Layout
Public propertyParentElementId
Gets the unique id of the underlying Element's parent Element
(Inherited from IContentUnitInstance.)
Public propertyPending

Gets/sets whether this instance is in pending state.

Content Unit Instances in pending state are just placed into Presentation, but the content of the underlying Element is not yet updated.

The state should be taken off when the element is updated

(Inherited from IContentUnitInstance.)
Public propertySharedComponentId
Gets/set the shared component id. Only applies when the underlying Component Element has its original embed content shared out.
Public propertySourceId
Gets the id of the source Content Unit
(Inherited from IContentUnitInstance.)
Public propertySourceReusable
Gets whether the source Content Unit is Reusable
(Inherited from IContentUnitInstance.)
Public propertyTemplateName
Gets of name of the MVC "View" for this Content Unit Instance
(Inherited from IContentUnitInstance.)
Top
Methods
  NameDescription
Public methodContentUnits
Retrieve all the Content Unit Instances, placed within the child Layout
Public methodFormat
Generates HTML markup, and appends to the specified html document
(Inherited from IDisplayUnit.)
Public methodFragmentFormat
Generates the actual html template for the Presentation fragments of the shared out component
Public methodGetSourceContentUnit
Retrieves the source Content Unit for this instance
(Inherited from IContentUnitInstance.)
Public methodPublish
Generates Presentation fragments markup template for the shared out content Component
Public methodCode exampleSerializeForComponent
Generate XML element for serialization of Page Version of the shared out component, from underlying Component Element
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
Remarks
The Element to be places on edit form will use the same unique id as the original element in Content Unit for the first placement. If the Unit is reusabled, the seconds and further placements will have new unique ids
See Also