ISchema Methods Ingeniux CMS Content Store API

The ISchema type exposes the following members.

Methods

  Name Description
Public method AddAllowedRootCategory
Adds a new root category to the allowed root categories collection.
(Inherited from ISchemaBasic.)
Public method AddDefaultCategory
Adds a new default category.
(Inherited from ISchemaBasic.)
Public method AddField
Adds a new schema field to the collection, either at the specified position or at the end.
(Inherited from ISchemaBasic.)
Public method AllowedCategoryRoots
Retrieves the collection of categories. Categories and their descendants in this collection are allowed to be associated with pages created with this schema.
(Inherited from ISchemaBasic.)
Public method AllowedCategoryRootsCount
Gets the count of allowed root categories.
(Inherited from ISchemaBasic.)
Public method ClearAllowedCategoryRoots
Clears all allowed root categories.
(Inherited from ISchemaBasic.)
Public method ClearDefaultCategories
Clear all default categories.
(Inherited from ISchemaBasic.)
Public method ClearFields
Clears all Fields from the collection.
(Inherited from ISchemaBasic.)
Public method DefaultCategories
Retrieves the default categories collection for pages created with this schema. When page is created, these categories are automaticaly applied to the page.
(Inherited from ISchemaBasic.)
Public method DefaultCategoriesCount
Gets the count of default categories.
(Inherited from ISchemaBasic.)
Public method Field(Int32)
Retrieves a schema field by its positional index.
(Inherited from ISchemaBasic.)
Public method Field(String)
Retrieves a schema field by its name.
(Inherited from ISchemaBasic.)
Public method Fields
Gets the collection of fields in this schema.
(Inherited from ISchemaBasic.)
Public method FieldsCount
Gets the count of fields in this schema.
(Inherited from ISchemaBasic.)
Public method IsSystemSchema
Checks whether this Schema is an essential schema that comes with default CMS instance.
Public method RemoveAllowedRootCategory
Removes a category from the the allowed root categories collection.
(Inherited from ISchemaBasic.)
Public method RemoveDefaultCategory
Removes a default category.
(Inherited from ISchemaBasic.)
Public method RemoveField
Removes from the collection a schema field at a specified index.
(Inherited from ISchemaBasic.)
Public method Save
Saves this schema.
Public method UpdateContent
Updates the schema with provided XML content and saves the schema in draft mode. If new content doesn't have a matching root name and friendly name, it will not be accepted.
Public method ValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public method 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.)
Public method Version
Retrieves a previous version of this schema by its version number.
Public method Versions
Retrieves the schema's history, which is a collection of all its previous versions, in a paginated fashion.
Public method VersionsCount
Gets the count of previous versions for this schema.
Top
See Also

Reference