Click or drag to resize

ISchemaVersion Interface


Represents a version entry of a Schema. Can be the current version or the previous version.

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

The ISchemaVersion 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.
(Inherited from ISchemaBasic.)
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.
(Inherited from ISchemaCommon.)
Public propertyErrors
Gets any errors associated with this schema.
(Inherited from ISchemaBasic.)
Public propertyFriendlyName
Gets and sets the schema's friendly name.
(Inherited from ISchemaCommon.)
Public propertyIcon
Gets and sets the icon of the page to be created with this schema.
(Inherited from ISchemaCommon.)
Public propertyIsComponent
Gets and sets whether this schema is for a component page.
(Inherited from ISchemaBasic.)
Public propertyIsCurrentVersion
Checks whether this version is the schema's current version.
(Inherited from ISchemaVersionCommon.)
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.
(Inherited from ISchemaBasic.)
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 propertyOriginPage
Gets the page that updated or created this schema. This page will always be a page with presentations.
(Inherited from ISchemaBasic.)
Public propertyPresentations
Gets the schema's presentations collection, which is applied to all pages created from this schema.
(Inherited from ISchemaBasic.)
Public propertyRootName
Gets and sets the name of the schema's root element.
(Inherited from ISchemaCommon.)
Public propertySchemaId
Gets the entity ID of the schema that this schema version belongs to.
(Inherited from ISchemaVersionCommon.)
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 propertyStylesheet
Gets and sets the entry XSLT style sheet name, located in the "xml/stylesheets" folder.
(Inherited from ISchemaBasic.)
Public propertyVersioning (Inherited from ISchemaCommon.)
Public propertyVersionNumber
Gets the this schema version's version number.
(Inherited from ISchemaVersionCommon.)
Public propertyViewName
Gets and sets the name of this page type's MVC view.
(Inherited from ISchemaBasic.)
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.
(Inherited from ISchemaCommon.)
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.
(Inherited from ISchemaCommon.)
Top
Methods
  NameDescription
Public methodAddAllowedRootCategory
Adds a new root category to the allowed root categories collection.
(Inherited from ISchemaCommon.)
Public methodAddDefaultCategory
Adds a new default category.
(Inherited from ISchemaCommon.)
Public methodAddField
Adds a new schema field to the collection, either at the specified position or at the end.
(Inherited from ISchemaCommon.)
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.
(Inherited from ISchemaCommon.)
Public methodAllowedCategoryRootsCount
Gets the count of allowed root categories.
(Inherited from ISchemaCommon.)
Public methodClearAllowedCategoryRoots
Clears all allowed root categories.
(Inherited from ISchemaCommon.)
Public methodClearDefaultCategories
Clear all default categories.
(Inherited from ISchemaCommon.)
Public methodClearFields
Clears all Fields from the collection.
(Inherited from ISchemaCommon.)
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.
(Inherited from ISchemaCommon.)
Public methodDefaultCategoriesCount
Gets the count of default categories.
(Inherited from ISchemaCommon.)
Public methodField(Int32)
Retrieves a schema field by its positional index.
(Inherited from ISchemaCommon.)
Public methodField(String)
Retrieves a schema field by its name.
(Inherited from ISchemaCommon.)
Public methodFields
Gets the collection of fields in this schema.
(Inherited from ISchemaCommon.)
Public methodFieldsCount
Gets the count of fields in this schema.
(Inherited from ISchemaCommon.)
Public methodRemoveAllowedRootCategory
Removes a category from the the allowed root categories collection.
(Inherited from ISchemaCommon.)
Public methodRemoveDefaultCategory
Removes a default category.
(Inherited from ISchemaCommon.)
Public methodRemoveField
Removes from the collection a schema field at a specified index.
(Inherited from ISchemaCommon.)
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
Examples

Schemas versions are retrieved from schemas.

To retrieve the current version, use the CurrentVersion property:

C#
ISchemaVersion schemaCurrentVersion = schema.CurrentVersion;

To retrieve a previous version, use the Version method:

C#
ISchemaVerison version3 = schema.Version(3);
See Also