IContentUnit Interface |
Represents a combination of Model and View in the MVC concept. It contains an Element that can be inserted into Page content, and the MVC view that renders the Element.
Content units are the corner stones of Page Builder. They can be instantiated as Content Unit Instances, and placed into a Page Presentation.
A CMS Site with a complete set of Content Units, allows users with necessary permission to customize page rendering within CMS Application.
Namespace: Ingeniux.CMS.Presentation
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.5.94
SyntaxThe IContentUnit type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets the archived value of this entity
(Inherited from IEntity.) |
| 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
|
| 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
|
| 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
|
| 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.) |
| Name |
Gets and sets the entity's name.
(Inherited from IEntity.) |
| RestrictiveSchemaNames | |
| 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.
|
| 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.
|
| 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
|
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.
|
| CreateBuiltInView |
Creates the built-in View Asset for this Content Unit
|
| RemoveBuiltInView |
Removes the built-in View Asset. This action move the Asset to recycle folder,
and unassociate the Content Unit with built-in View
|
| SetThumbnail |
Sets the content of thumbnail for this Content Unit
|
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.) |
| UpdateBuildInView |
Updates content of the Built-in View.
|
| 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