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.6.308

Syntax

public interface ISchemaVersion : ISchemaVersionCommon, 
	ISchemaCommon, IEntity<ISchemaManager>, IEntity, IEntityEvents, 
	ISchemaBasic

Public Interface ISchemaVersion
	Inherits ISchemaVersionCommon, ISchemaCommon, IEntity(Of ISchemaManager), 
	IEntity, IEntityEvents, ISchemaBasic

public interface class ISchemaVersion : ISchemaVersionCommon, 
	ISchemaCommon, IEntity<ISchemaManager^>, IEntity, IEntityEvents, 
	ISchemaBasic

type ISchemaVersion =  
    interface
        interface ISchemaVersionCommon
        interface ISchemaCommon
        interface IEntity<ISchemaManager>
        interface IEntity
        interface IEntityEvents
        interface ISchemaBasic
    end

The ISchemaVersion type exposes the following members.

Properties

	Name	Description
	Archived	Gets/sets the archived value of this entity (Inherited from IEntity.)
	ContentUnitsInstantiability	Gets the collection of information on whether a Content Unit can be instantiated, and how many times it can be instantiated. (Inherited from ISchemaBasic.)
	Created	Gets the entity's creation date. (Inherited from IEntity.)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	Drafting	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.)
	Errors	Gets any errors associated with this schema. (Inherited from ISchemaBasic.)
	FriendlyName	Gets and sets the schema's friendly name. (Inherited from ISchemaCommon.)
	Icon	Gets and sets the icon of the page to be created with this schema. (Inherited from ISchemaCommon.)
	IsComponent	Gets and sets whether this schema is for a component page. (Inherited from ISchemaBasic.)
	IsCurrentVersion	Gets whether this version is the schema's current version. (Inherited from ISchemaVersionCommon.)
	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. (Inherited from ISchemaBasic.)
	LastModified	Gets the date when the entity was most recently modified. (Inherited from IEntity.)
	LastModifiedUser	Gets the ID of the User who lasted edited the entity. (Inherited from IEntity.)
	Manager	Gets the manager that retrieved this entity instance. (Inherited from IEntityTManager.)
	OriginPage	Gets the page that updated or created this schema. This page will always be a page with presentations. (Inherited from ISchemaBasic.)
	Presentations	Gets the schema's presentations collection, which is applied to all pages created from this schema. (Inherited from ISchemaBasic.)
	RootName	Gets and sets the name of the schema's root element. (Inherited from ISchemaCommon.)
	SchemaId	Gets the entity ID of the schema that this schema version belongs to. (Inherited from ISchemaVersionCommon.)
	Session	Gets the session that retrieved this entity. An entity is always session-specific. (Inherited from IEntity.)
	SessionId	Gets the unique ID of the session that retrieved this entity. (Inherited from IEntity.)
	Stylesheet	Gets and sets the entry XSLT style sheet name, located in the "xml/stylesheets" folder. (Inherited from ISchemaBasic.)
	Versioning	Represents the version number of the object (Inherited from ISchemaCommon.)
	VersionNumber	Gets the this schema version's version number. (Inherited from ISchemaVersionCommon.)
	ViewName	Gets and sets the name of this page type's MVC view. (Inherited from ISchemaBasic.)
	WorkflowDefinition	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.)
	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. (Inherited from ISchemaCommon.)

Top

Methods

	Name	Description
	AddAllowedRootCategory	Adds a new root category to the allowed root categories collection. (Inherited from ISchemaCommon.)
	AddDefaultCategory	Adds a new default category. (Inherited from ISchemaCommon.)
	AddField	Adds a new schema field to the collection, either at the specified position or at the end. (Inherited from ISchemaCommon.)
	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 ISchemaCommon.)
	AllowedCategoryRootsCount	Gets the count of allowed root categories. (Inherited from ISchemaCommon.)
	ClearAllowedCategoryRoots	Clears all allowed root categories. (Inherited from ISchemaCommon.)
	ClearDefaultCategories	Clear all default categories. (Inherited from ISchemaCommon.)
	ClearFields	Clears all Fields from the collection. (Inherited from ISchemaCommon.)
	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 ISchemaCommon.)
	DefaultCategoriesCount	Gets the count of default categories. (Inherited from ISchemaCommon.)
	Field(Int32)	Retrieves a schema field by its positional index. (Inherited from ISchemaCommon.)
	Field(String)	Retrieves a schema field by its name. (Inherited from ISchemaCommon.)
	Fields	Gets the collection of fields in this schema. (Inherited from ISchemaCommon.)
	FieldsCount	Gets the count of fields in this schema. (Inherited from ISchemaCommon.)
	GetDuplicateFieldUniqueIds	Detects if there are fields in the schema that contain colliding UniqueIds (Inherited from ISchemaCommon.)
	RemoveAllowedRootCategory	Removes a category from the the allowed root categories collection. (Inherited from ISchemaCommon.)
	RemoveDefaultCategory	Removes a default category. (Inherited from ISchemaCommon.)
	RemoveField	Removes from the collection a schema field at a specified index. (Inherited from ISchemaCommon.)
	Touch	Updated the entity's LastModified value to the current time. (Inherited from IEntity.)
	ValidateData	Validates this entity's data. Implemented by concrete inheriting types. (Inherited from IEntity.)
	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.)

Top

Events

	Name	Description
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents.)
	BeforeEntitySave	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:

Copy

ISchemaVersion schemaCurrentVersion = schema.CurrentVersion;

To retrieve a previous version, use the Version method:

Copy

ISchemaVerison version3 = schema.Version(3);

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSISchemaManager