Click or drag to resize
VersionManager Class
Class to provide node versioning management.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23
Syntax
C#
public class VersionManager : AbstractManager

The VersionManager type exposes the following members.

Constructors
  NameDescription
Public methodVersionManager Obsolete.
Constructor - Creates version manager.
Protected methodVersionManager(TreeProvider)
Constructor - Creates version manager.
Top
Methods
  NameDescription
Public methodAddAttachmentToVersion
Adds the version - attachment binding to the database.
Protected methodAddAttachmentToVersionInternal
Adds the version - attachment binding to the database.
Public methodApplyDocumentVersionData
Applies the document version data to the document DataSet (only the document data, not the coupled data).
Protected methodApplyDocumentVersionDataInternal
Applies the document version data to the document DataSet (only the document data, not the coupled data).
Public methodApplyLatestVersion
Applies latest version data to the node.
Protected methodApplyLatestVersionInternal
Applies latest version data to the node.
Public methodApplyVersion
Applies version data to the node.
Public methodApplyVersionData
Applies the document version data to the document data row.
Protected methodApplyVersionDataInternal
Applies the document version data to the document data row.
Protected methodApplyVersionInternal
Applies version data to the node.
Public methodClearDocumentHistory
Clears complete history of specified document (keeps latest version).
Protected methodClearDocumentHistoryInternal
Clears complete history of specified document (keeps the latest version).
Public methodCopyVersionAttachments(Int32, Int32)
Copies the version attachment bindings to the given version.
Public methodCopyVersionAttachments(Int32, Int32, Hashtable)
Copies the version attachments to the given version, physically copies the attachment history records.
Protected methodCopyVersionAttachmentsInternal(Int32, Int32)
Copies the version attachment bindings to the given version.
Protected methodCopyVersionAttachmentsInternal(Int32, Int32, Hashtable)
Copies the version attachments to the given version, physically copies the attachment history records.
Public methodCreateNewVersion
Creates new document version. (Moves document to edit step.)
Protected methodCreateNewVersionInternal
Creates new document version. (Moves document to edit step.)
Public methodDeleteOlderVersions
Deletes older document versions to keep specified version history length.
Protected methodDeleteOlderVersionsInternal
Deletes older document versions to keep specified version history length.
Public methodDestroyDocumentHistory
Deletes complete history of specified document.
Protected methodDestroyDocumentHistoryInternal
Deletes complete history of specified document.
Public methodDestroyDocumentVersion
Deletes specified record in the node version history.
Protected methodDestroyDocumentVersionInternal
Deletes specified record in the node version history.
Public methodEnsureVersion
Ensures that the document version history is present for the given document, returns the document version.
Public methodEnsureVersionAttachments
Ensures that the document attachments are present within the AttachmentHistory table.
Protected methodEnsureVersionAttachmentsInternal
Ensures that the document attachments are present within the AttachmentHistory table.
Protected methodEnsureVersionInternal
Ensures that the document version history is present for the given document, returns the document version.
Public methodGetAttachmentDocumentVersions
Returns the DataSet of all the document versions bound to the specified attachment version.
Protected methodGetAttachmentDocumentVersionsInternal
Returns the DataSet of all the document versions bound to the specified attachment version.
Public methodGetAttachmentVersion(Int32, Guid)
Returns the attachment version.
Public methodGetAttachmentVersion(Int32, Guid, Boolean)
Returns the attachment version.
Public methodGetAttachmentVersion(Int32, String, Boolean)
Returns the attachment version.
Protected methodGetAttachmentVersionInternal(Int32, Guid, Boolean)
Returns the attachment version.
Protected methodGetAttachmentVersionInternal(Int32, String, Boolean)
Returns the attachment version.
Public methodGetDocumentHistory
Returns the version history table for the specified document.
Protected methodGetDocumentHistoryInternal
Returns the version history table for the specified document.
Public methodGetHistoryLength
Gets version history length
Protected methodGetHistoryLengthInternal
Gets version history length
Public methodStatic memberGetInstance
Gets the instance of the manager.
Public methodGetLatestAttachmentVersion(Guid, String)
Returns latest attachment version found in the AttachmentHistoryTable.
Public methodGetLatestAttachmentVersion(Guid, String, Boolean)
Returns latest attachment version found in the AttachmentHistoryTable.
Protected methodGetLatestAttachmentVersionInternal
Returns latest attachment version found in the AttachmentHistoryTable.
Public methodGetLatestDocumentVersion
Gets latest document version
Protected methodGetLatestDocumentVersionInternal
Gets latest document version
Public methodGetNewVersion
Returns new version number representation.
Protected methodGetNewVersionInternal
Returns new version number representation.
Public methodGetVersion(Int32)
Returns specified history version.
Public methodGetVersion(Int32, TreeNode)
Returns specified history version.
Public methodGetVersion(VersionHistoryInfo, TreeNode)
Returns node with applied version data.
Public methodGetVersionAttachments(Int32)
Returns the DataSet containing all the attachments for the given document version based on where condition and order by clause.
Public methodGetVersionAttachments(Int32, Boolean)
Returns the DataSet containing all the attachments for the given document version.
Public methodGetVersionAttachments(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 methodGetVersionAttachments(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 methodGetVersionInternal
Returns node with applied version data.
Protected methodChangeManagerTypeOriginalType
Changes the default manager type to the given type
(Inherited from AbstractManager.)
Public methodChangeManagerTypeTo
Changes the manager type to the given type
(Overrides AbstractManagerChangeManagerTypeTo(Type).)
Public methodCheckIn
Checks provided node in and stores it in the versioning history.
Protected methodCheckInInternal
Checks provided node in and stores it in the versioning history.
Public methodCheckOut(TreeNode)
Checks out specified node and creates a new record in the CMS_VersionHistory table.
Public methodCheckOut(TreeNode, Boolean, Boolean)
Checks out specified node and creates a new record in the CMS_VersionHistory table.
Public methodCheckOut(TreeNode, Boolean, Boolean, Boolean)
Checks out specified node and creates a new record in the CMS_VersionHistory table.
Protected methodCheckOutInternal
Checks out specified node and creates a new record in the CMS_VersionHistory table.
Public methodStatic memberIsSystemDocumentColumn
Returns true if the given column name is a system data column name.
Protected methodIsSystemDocumentColumnInternal
Returns true if the given column name is a system data column name.
Public methodStatic memberIsSystemNodeColumn
Returns true if the given column name is a system data column name of the node.
Protected methodIsSystemNodeColumnInternal
Returns true if the given column name is a system data column name of the node.
Public methodStatic memberIsVersionedCoupledColumn
Returns true if the given column name is a versioned data column name.
Protected methodIsVersionedCoupledColumnInternal
Returns true if the given column name is a versioned data column name.
Public methodStatic memberIsVersionedDocumentColumn
Returns true if the given column name is a versioned data column name.
Protected methodIsVersionedDocumentColumnInternal
Returns true if the given column name is a versioned data column name.
Public methodPublishAllScheduled
Publishes all documents scheduled for the current time.
Protected methodPublishAllScheduledInternal
Publishes all documents scheduled for the current time.
Public methodPublishAttachments
Publishes the attachments for the given document.
Protected methodPublishAttachmentsInternal
Publishes the attachments for the given document.
Public methodPublishVersion(Int32)
Puts the specified node history version to the front DB tables.
Public methodPublishVersion(Int32, Boolean)
Puts the specified node history version to the front DB tables.
Protected methodPublishVersionInternal
Puts the specified node history version to the front DB tables.
Public methodRemoveAttachmentFromVersion
Removes the version - attachment binding from the database.
Protected methodRemoveAttachmentFromVersionInternal
Removes the version - attachment binding from the database.
Public methodRemoveAttachmentVersion
Removes the AttachmentHistory binding to the document version history and deletes the AttachmentHistory object if there is no more bindings to that version.
Protected methodRemoveAttachmentVersionInternal
Removes the AttachmentHistory binding to the document version history and deletes the AttachmentHistory object if there is no more bindings to that version.
Public methodRemoveWorkflow
Removes all the workflow information from the document and initializes the document as non-workflow.
Protected methodRemoveWorkflowInternal
Removes all the workflow information from the document and initializes the document as non-workflow.
Public methodRestoreDocument
Restores deleted node and returns the restored node.
Protected methodRestoreDocumentInternal
Restores deleted node and returns the restored node.
Public methodRollbackVersion
Adds specified earlier version to the top of the version history.
Protected methodRollbackVersionInternal
Adds specified earlier version to the top of the version history.
Public methodSaveAttachmentVersion
Saves the attachment version to the database.
Protected methodSaveAttachmentVersionInternal
Saves the attachment version to the database.
Public methodSaveVersion
Saves history version record to the database without checking in.
Protected methodSaveVersionInternal
Saves history version record to the database without checking in.
Public methodUndoCheckOut
Undo all operations made during last checkout.
Protected methodUndoCheckOutInternal
Undo all operations made during last checkout.
Public methodStatic memberUseAutomaticVersionNumbering
Specifies whether the environment is configured to use automatic version numbering.
Protected methodUseAutomaticVersionNumberingInternal
Specifies whether the environment is configured to use automatic version numbering.
Public methodStatic memberUseCheckInCheckOut
Specifies whether the environment is configured to use check-in and check-out actions.
Protected methodUseCheckInCheckOutInternal
Specifies whether the environment is configured to use check-in and check-out actions.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldStatic membermNonVersionedCoupledColumns
Non-versioned coupled columns list.
Protected fieldmTreeProvider
TreeProvider to use for DB access.
Protected fieldmWorkflowManager
WorkflowManager for workflow managing.
Top
Properties
  NameDescription
Public propertyStatic memberNonVersionedCoupledColumns
List of the non-versioned coupled document columns.
Public propertyTreeProvider
TreeProvider instance.
Public propertyWorkflowManager
Gets workflow manager instance.
Top
See Also