Click or drag to resize

ISchemaCommon Interface


Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface ISchemaCommon : IEntity<ISchemaManager>, 
	IEntity, IEntityEvents

The ISchemaCommon type exposes the following members.

Properties
  NameDescription
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyDrafting
Gets whether the schema is in drafting state. When a schema is in drafting state, it cannot be used for page creation.
Public propertyFriendlyName
Gets and sets the schema's friendly name.
Public propertyIcon
Gets and sets the icon of the page to be created with this schema.
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyRootName
Gets and sets the name of the schema's root element.
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Public propertyVersioning
Public propertyWorkflowDefinition
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.
Public propertyWorkflowRequired
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.
Top
Methods
  NameDescription
Public methodAddAllowedRootCategory
Adds a new root category to the allowed root categories collection.
Public methodAddDefaultCategory
Adds a new default category.
Public methodAddField
Adds a new schema field to the collection, either at the specified position or at the end.
Public methodAllowedCategoryRoots
Retrieves the collection of categories. Categories and their descendants in this collection are allowed to be associated with pages created with this schema.
Public methodAllowedCategoryRootsCount
Gets the count of allowed root categories.
Public methodClearAllowedCategoryRoots
Clears all allowed root categories.
Public methodClearDefaultCategories
Clear all default categories.
Public methodClearFields
Clears all Fields from the collection.
Public methodDefaultCategories
Retrieves the default categories collection for pages created with this schema. When page is created, these categories are automaticaly applied to the page.
Public methodDefaultCategoriesCount
Gets the count of default categories.
Public methodField(Int32)
Retrieves a schema field by its positional index.
Public methodField(String)
Retrieves a schema field by its name.
Public methodFields
Gets the collection of fields in this schema.
Public methodFieldsCount
Gets the count of fields in this schema.
Public methodRemoveAllowedRootCategory
Removes a category from the the allowed root categories collection.
Public methodRemoveDefaultCategory
Removes a default category.
Public methodRemoveField
Removes from the collection a schema field at a specified index.
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity.)
Top
Events
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Top
See Also