ISchema
|
Interface representing common properties for all CMS types
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxThe ISchemaCommon type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity) |
| Created |
Gets the entity's creation date.
(Inherited from IEntity) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity) |
| Drafting | Gets whether the schema is in drafting state. When a schema is in drafting state, it cannot be used for page creation. |
| FriendlyName | Gets and sets the schema's friendly name. |
| Icon | Gets and sets the icon of the page to be created with this schema. |
| 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) |
| RootName | Gets and sets the name of the schema's root element. |
| 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) |
| Versioning | Represents the version number of the object |
| WorkflowDefinition | Gets and sets the workflow defintion for this schema. If set, pages created with this schema will be added to a workflow based on this defintion right away. |
| WorkflowRequired | Gets and sets whether pages created via this schema are added to a workflow after creation. If this property is set to true, the WorkflowDefinition property must be set to a valid workflow definition. Otherwise, validation will fail. |
Methods| Name | Description | |
|---|---|---|
 | AddAllowedRootCategory | Adds a new root category to the allowed root categories collection. |
| AddDefaultCategory | Adds a new default category. |
| AddField | Adds a new schema field to the collection, either at the specified position or at the end. |
| AllowedCategoryRoots | Retrieves the collection of categories. Categories and their descendants in this collection are allowed to be associated with pages created with this schema. |
| AllowedCategoryRootsCount | Gets the count of allowed root categories. |
| ClearAllowedCategoryRoots | Clears all allowed root categories. |
| ClearDefaultCategories | Clear all default categories. |
| ClearFields | Clears all Fields from the collection. |
| DefaultCategories | Retrieves the default categories collection for pages created with this schema. When page is created, these categories are automaticaly applied to the page. |
| DefaultCategoriesCount | Gets the count of default categories. |
| Field(Int32) | Retrieves a schema field by its positional index. |
| Field(String) | Retrieves a schema field by its name. |
| Fields | Gets the collection of fields in this schema. |
| FieldsCount | Gets the count of fields in this schema. |
| GetDuplicateFieldUniqueIds | Detects if there are fields in the schema that contain colliding UniqueIds |
| RemoveAllowedRootCategory | Removes a category from the the allowed root categories collection. |
| RemoveDefaultCategory | Removes a default category. |
| RemoveField | Removes from the collection a schema field at a specified index. |
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity) |
| 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