IComponentContentUnit Interface |
Represents a Content Unit with its Element content being an Embedded Component Element.
Component Content Units content will always be based on a Component Schema
The benefit of Component Content Units is the ability to provide much more complex content.
Namespace: Ingeniux.CMS.Presentation
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe IComponentContentUnit type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity.) |
| ComponentElement |
Gets/sets the Component Element this Content Unit holds
|
| ContentUnitSecurity |
Gets/sets the security for this Content Unit, which is a list of User Groups,
that will not see this Content Unit on Page Builder UI
(Inherited from IContentUnit.) |
| Created |
Gets the entity's creation date.
(Inherited from IEntity.) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity.) |
| Element | Gets/sets the Element this Content Unit holds. The element is the "Model" part of the Content Unit. This element will inserted into Page content, when the Content Unit is placed into Page Presentation. |
| HasThumbnail |
Gets whether this Content Unit has thumbnail or not
(Inherited from IContentUnit.) |
| Icon |
Gets/sets the icon name of the Content Unit. Icon is just for easy identification purpose
on Page Builder UI. It has nothing to do with actual Content Unit rendering
(Inherited from IContentUnit.) |
| 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.) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.) |
| RestrictiveSchemaNames |
Gets the list of schema names. If the list is not empty, this Content Unit can only be placed
on Page created with these Schemas (Inherited from IContentUnit.) |
| Reusable |
Gets/sets whether this Content Unit can be placed multiple times on a Page
Presentation. If false, it can only be placed once
on a page.
(Inherited from IContentUnit.) |
| Schema |
Gets the schema the ComponentElement embedded content is based on
|
| SchemaId |
Gets the id of the Schema that was used to create the embedded content of ComponentElement |
| SchemaName |
Gets the root element name of the embedded content of ComponentElement |
| 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.) |
| TemplateName |
Gets/sets the name of the MVC "View", that is in charge of rendering the Content.
It normally matches the Element's tag name.
(Inherited from IContentUnit.) |
| ThumbnailId | Gets the unique id of the thumbnail. The thumbnail id is the file name of the thubmnail for this Content Unit. The prupose of a thumbnail for a Content Unit, is to demonstrate what this Content Unit looks like when place on a Page. |
| ThumbnailRelativePath |
Gets the path of the thumbnail image, relative to the root path of the CMS site
(Inherited from IContentUnit.) |
Methods| Name | Description | |
|---|---|---|
 | BuiltInView | Retrieves the Asset that contains the content of the "View" for rendering of this. If a Content Unit has a built-in View, it will not seek "View" file in Dynamic Site Server "Views" folder anymore. Built-in view gives Page Builder much more flexibility. Developers of the Content Unit can directly work on the "View", without ever leaving the CMS client. |
| CheckInBuiltInView |
Checks in the built-in View Asset, to specified
Publishing Targets.
The view is only effective on published content after check in.
This method will mark the View Asset for publish for the specified targets on its latest version.
(Inherited from IContentUnit.) |
| CreateBuiltInView |
Creates the built-in View Asset for this Content Unit
(Inherited from IContentUnit.) |
| FragmentInstances |
Retrieves the list of customized versions of this Component Content Unit, that have child layouts.
They are individual Components, that were shared out from the Pages, where instances
of this Component Content Unit were placed.
|
| RemoveBuiltInView |
Removes the built-in View Asset. This action move the Asset to recycle folder,
and unassociate the Content Unit with built-in View
(Inherited from IContentUnit.) |
| SetThumbnail |
Sets the content of thumbnail for this Content Unit
(Inherited from IContentUnit.) |
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.) |
| UpdateBuildInView |
Updates content of the Built-in View.
(Inherited from IContentUnit.) |
| 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.) |
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.) |
See Also