Represents the properties shared by the Schema and SchemaVersion objects.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax
The ISchemaBasic type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| ContentUnitsInstantiability |
Gets the collection of information on whether a Content Unit can be instantiated, and how many times it can be instantiated.
| |
| Drafting |
Gets whether the schema is in drafting state. When a schema is in drafting state, it cannot be used for page creation.
| |
| Errors |
Gets any errors associated with this schema.
| |
| FriendlyName |
Gets and sets the schema's friendly name.
| |
| Icon |
Gets and sets the icon of the page to be created with this schema.
| |
| IsComponent |
Gets and sets whether this schema is for a component page.
| |
| IsDynamicSitePage |
Gets and sets whether the page to be created from this schema is a Dynamic Site Server page or a traditional XSLT page.
Dynamic Site Server pages are not required to have stylesheet values.
| |
| OriginPage |
Gets the page that updated or created this schema. This page will always be a page with
presentations.
| |
| Presentations |
Gets the schema's presentations collection, which is applied to all
pages created from this schema.
| |
| RootName |
Gets and sets the name of the schema's root element.
| |
| Stylesheet |
Gets and sets the entry XSLT style sheet name, located in the "xml/stylesheets" folder.
| |
| ViewName |
Gets and sets the name of this page type's MVC view.
| |
| WorkflowDefinition | ||
| 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.
| |
| 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.
|
See Also