VersionManager Class

Class to provide node versioning management.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractManager
    CMS.DocumentEngine.VersionManager

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23

Syntax

public class VersionManager : AbstractManager

The VersionManager type exposes the following members.

Constructors

	Name	Description
Public method	VersionManager()	Obsolete. Constructor - Creates version manager.
Protected method	VersionManager(TreeProvider)	Constructor - Creates version manager.

Methods

	Name	Description
Public method	AddAttachmentToVersion	Adds the version - attachment binding to the database.
Protected method	AddAttachmentToVersionInternal	Adds the version - attachment binding to the database.
Public method	ApplyDocumentVersionData	Applies the document version data to the document DataSet (only the document data, not the coupled data).
Protected method	ApplyDocumentVersionDataInternal	Applies the document version data to the document DataSet (only the document data, not the coupled data).
Public method	ApplyLatestVersion	Applies latest version data to the node.
Protected method	ApplyLatestVersionInternal	Applies latest version data to the node.
Public method	ApplyVersion	Applies version data to the node.
Public method	ApplyVersionData	Applies the document version data to the document data row.
Protected method	ApplyVersionDataInternal	Applies the document version data to the document data row.
Protected method	ApplyVersionInternal	Applies version data to the node.
Public method	ClearDocumentHistory	Clears complete history of specified document (keeps latest version).
Protected method	ClearDocumentHistoryInternal	Clears complete history of specified document (keeps the latest version).
Public method	CopyVersionAttachments(Int32, Int32)	Copies the version attachment bindings to the given version.
Public method	CopyVersionAttachments(Int32, Int32, Hashtable)	Copies the version attachments to the given version, physically copies the attachment history records.
Protected method	CopyVersionAttachmentsInternal(Int32, Int32)	Copies the version attachment bindings to the given version.
Protected method	CopyVersionAttachmentsInternal(Int32, Int32, Hashtable)	Copies the version attachments to the given version, physically copies the attachment history records.
Public method	CreateNewVersion	Creates new document version. (Moves document to edit step.)
Protected method	CreateNewVersionInternal	Creates new document version. (Moves document to edit step.)
Public method	DeleteOlderVersions	Deletes older document versions to keep specified version history length.
Protected method	DeleteOlderVersionsInternal	Deletes older document versions to keep specified version history length.
Public method	DestroyDocumentHistory	Deletes complete history of specified document.
Protected method	DestroyDocumentHistoryInternal	Deletes complete history of specified document.
Public method	DestroyDocumentVersion	Deletes specified record in the node version history.
Protected method	DestroyDocumentVersionInternal	Deletes specified record in the node version history.
Public method	EnsureVersion	Ensures that the document version history is present for the given document, returns the document version.
Public method	EnsureVersionAttachments	Ensures that the document attachments are present within the AttachmentHistory table.
Protected method	EnsureVersionAttachmentsInternal	Ensures that the document attachments are present within the AttachmentHistory table.
Protected method	EnsureVersionInternal	Ensures that the document version history is present for the given document, returns the document version.
Public method	GetAttachmentDocumentVersions	Returns the DataSet of all the document versions bound to the specified attachment version.
Protected method	GetAttachmentDocumentVersionsInternal	Returns the DataSet of all the document versions bound to the specified attachment version.
Public method	GetAttachmentVersion(Int32, Guid)	Returns the attachment version.
Public method	GetAttachmentVersion(Int32, Guid, Boolean)	Returns the attachment version.
Public method	GetAttachmentVersion(Int32, String, Boolean)	Returns the attachment version.
Protected method	GetAttachmentVersionInternal(Int32, Guid, Boolean)	Returns the attachment version.
Protected method	GetAttachmentVersionInternal(Int32, String, Boolean)	Returns the attachment version.
Public method	GetDocumentHistory	Returns the version history table for the specified document.
Protected method	GetDocumentHistoryInternal	Returns the version history table for the specified document.
Public method	GetHistoryLength	Gets version history length
Protected method	GetHistoryLengthInternal	Gets version history length
Public method Static member	GetInstance	Gets the instance of the manager.
Public method	GetLatestAttachmentVersion(Guid, String)	Returns latest attachment version found in the AttachmentHistoryTable.
Public method	GetLatestAttachmentVersion(Guid, String, Boolean)	Returns latest attachment version found in the AttachmentHistoryTable.
Protected method	GetLatestAttachmentVersionInternal	Returns latest attachment version found in the AttachmentHistoryTable.
Public method	GetLatestDocumentVersion	Gets latest document version
Protected method	GetLatestDocumentVersionInternal	Gets latest document version
Public method	GetNewVersion	Returns new version number representation.
Protected method	GetNewVersionInternal	Returns new version number representation.
Public method	GetVersion(Int32)	Returns specified history version.
Public method	GetVersion(Int32, TreeNode)	Returns specified history version.
Public method	GetVersion(VersionHistoryInfo, TreeNode)	Returns node with applied version data.
Public method	GetVersionAttachments(Int32)	Returns the DataSet containing all the attachments for the given document version based on where condition and order by clause.
Public method	GetVersionAttachments(Int32, Boolean)	Returns the DataSet containing all the attachments for the given document version.
Public method	GetVersionAttachments(Int32, String, String, Boolean)	Returns the DataSet containing all the attachments for the given document version based on where condition and order by clause.
Public method	GetVersionAttachments(Int32, String, String, Boolean, Int32, String)	Returns the DataSet containing all the attachments for the given document version based on where condition and order by clause.
Protected method	GetVersionInternal	Returns node with applied version data.
Protected method	ChangeManagerType<OriginalType>	Changes the default manager type to the given type (Inherited from AbstractManager.)
Public method	ChangeManagerTypeTo	Changes the manager type to the given type (Overrides AbstractManager.ChangeManagerTypeTo(Type).)
Public method	CheckIn	Checks provided node in and stores it in the versioning history.
Protected method	CheckInInternal	Checks provided node in and stores it in the versioning history.
Public method	CheckOut(TreeNode)	Checks out specified node and creates a new record in the CMS_VersionHistory table.
Public method	CheckOut(TreeNode, Boolean, Boolean)	Checks out specified node and creates a new record in the CMS_VersionHistory table.
Public method	CheckOut(TreeNode, Boolean, Boolean, Boolean)	Checks out specified node and creates a new record in the CMS_VersionHistory table.
Protected method	CheckOutInternal	Checks out specified node and creates a new record in the CMS_VersionHistory table.
Public method Static member	IsSystemDocumentColumn	Returns true if the given column name is a system data column name.
Protected method	IsSystemDocumentColumnInternal	Returns true if the given column name is a system data column name.
Public method Static member	IsSystemNodeColumn	Returns true if the given column name is a system data column name of the node.
Protected method	IsSystemNodeColumnInternal	Returns true if the given column name is a system data column name of the node.
Public method Static member	IsVersionedCoupledColumn	Returns true if the given column name is a versioned data column name.
Protected method	IsVersionedCoupledColumnInternal	Returns true if the given column name is a versioned data column name.
Public method Static member	IsVersionedDocumentColumn	Returns true if the given column name is a versioned data column name.
Protected method	IsVersionedDocumentColumnInternal	Returns true if the given column name is a versioned data column name.
Public method	PublishAllScheduled	Publishes all documents scheduled for the current time.
Protected method	PublishAllScheduledInternal	Publishes all documents scheduled for the current time.
Public method	PublishAttachments	Publishes the attachments for the given document.
Protected method	PublishAttachmentsInternal	Publishes the attachments for the given document.
Public method	PublishVersion(Int32)	Puts the specified node history version to the front DB tables.
Public method	PublishVersion(Int32, Boolean)	Puts the specified node history version to the front DB tables.
Protected method	PublishVersionInternal	Puts the specified node history version to the front DB tables.
Public method	RemoveAttachmentFromVersion	Removes the version - attachment binding from the database.
Protected method	RemoveAttachmentFromVersionInternal	Removes the version - attachment binding from the database.
Public method	RemoveAttachmentVersion	Removes the AttachmentHistory binding to the document version history and deletes the AttachmentHistory object if there is no more bindings to that version.
Protected method	RemoveAttachmentVersionInternal	Removes the AttachmentHistory binding to the document version history and deletes the AttachmentHistory object if there is no more bindings to that version.
Public method	RemoveWorkflow	Removes all the workflow information from the document and initializes the document as non-workflow.
Protected method	RemoveWorkflowInternal	Removes all the workflow information from the document and initializes the document as non-workflow.
Public method	RestoreDocument	Restores deleted node and returns the restored node.
Protected method	RestoreDocumentInternal	Restores deleted node and returns the restored node.
Public method	RollbackVersion	Adds specified earlier version to the top of the version history.
Protected method	RollbackVersionInternal	Adds specified earlier version to the top of the version history.
Public method	SaveAttachmentVersion	Saves the attachment version to the database.
Protected method	SaveAttachmentVersionInternal	Saves the attachment version to the database.
Public method	SaveVersion	Saves history version record to the database without checking in.
Protected method	SaveVersionInternal	Saves history version record to the database without checking in.
Public method	UndoCheckOut	Undo all operations made during last checkout.
Protected method	UndoCheckOutInternal	Undo all operations made during last checkout.
Public method Static member	UseAutomaticVersionNumbering	Specifies whether the environment is configured to use automatic version numbering.
Protected method	UseAutomaticVersionNumberingInternal	Specifies whether the environment is configured to use automatic version numbering.
Public method Static member	UseCheckInCheckOut	Specifies whether the environment is configured to use check-in and check-out actions.
Protected method	UseCheckInCheckOutInternal	Specifies whether the environment is configured to use check-in and check-out actions.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field Static member	mNonVersionedCoupledColumns	Non-versioned coupled columns list.
Protected field	mTreeProvider	TreeProvider to use for DB access.
Protected field	mWorkflowManager	WorkflowManager for workflow managing.

Properties

	Name	Description
Public property Static member	NonVersionedCoupledColumns	List of the non-versioned coupled document columns.
Public property	TreeProvider	TreeProvider instance.
Public property	WorkflowManager	Gets workflow manager instance.