ISchemaBasic Interface Ingeniux CMS Content Store API

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

public interface ISchemaBasic

The ISchemaBasic type exposes the following members.

Properties

  NameDescription
Public propertyContentUnitsInstantiability
Gets the collection of information on whether a Content Unit can be instantiated, and how many times it can be instantiated.
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 propertyErrors
Gets any errors associated with this schema.
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 propertyIsComponent
Gets and sets whether this schema is for a component page.
Public propertyIsDynamicSitePage
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.
Public propertyOriginPage
Gets the page that updated or created this schema. This page will always be a page with presentations.
Public propertyPresentations
Gets the schema's presentations collection, which is applied to all pages created from this schema.
Public propertyRootName
Gets and sets the name of the schema's root element.
Public propertyStylesheet
Gets and sets the entry XSLT style sheet name, located in the "xml/stylesheets" folder.
Public propertyViewName
Gets and sets the name of this page type's MVC view.
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.
Top
See Also

Reference