DocumentHelper Class

Class providing document management methods.

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.DocumentHelper

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

Syntax

public static class DocumentHelper

The DocumentHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	DOCUMENT_PREFIX	Document prefix for object type.
Public field Static member	LOGCONTEXT_DOCUMENTS	Log context name for document actions

Methods

	Name	Description
Public method Static member	AddAttachment(TreeNode, String, IUploadedFile, Int32, Int32, Int32)	Adds given attachment to the document. Does not update the document to the database, updates the attachment if currently present.
Public method Static member	AddAttachment(TreeNode, String, String, Int32, Int32, Int32)	Adds specified attachment to the document. Does not update the document to the database, updates the attachment if currently present.
Public method Static member	AddAttachment(TreeNode, String, HttpPostedFile, Int32, Int32, Int32)	Obsolete. Adds given attachment to the document. Does not update the document to the database, updates the attachment if currently present.
Public method Static member	AddAttachment(TreeNode, String, Guid, Guid, AttachmentSource, Int32, Int32, Int32)	Adds an attachment to the document. Does not update the document to the database, updates the attachment if currently present.
Public method Static member	AddGroupedAttachment(TreeNode, Guid, Guid, IUploadedFile, Int32, Int32, Int32)	Adds given group attachment to the document or updates the attachment if already present.
Public method Static member	AddGroupedAttachment(TreeNode, Guid, Guid, String, Int32, Int32, Int32)	Adds specified group attachment to the document or updates the attachment if already present.
Public method Static member	AddGroupedAttachment(TreeNode, Guid, Guid, HttpPostedFile, Int32, Int32, Int32)	Obsolete. Adds given group attachment to the document or updates the attachment if already present.
Public method Static member	AddUnsortedAttachment(TreeNode, Guid, IUploadedFile, Int32, Int32, Int32)	Adds given unsorted attachment to the document or updates the attachment if already present.
Public method Static member	AddUnsortedAttachment(TreeNode, Guid, String, Int32, Int32, Int32)	Adds specified unsorted attachment to the document or updates the attachment if already present.
Public method Static member	AddUnsortedAttachment(TreeNode, Guid, HttpPostedFile, Int32, Int32, Int32)	Obsolete. Adds given unsorted attachment to the document or updates the attachment if already present.
Public method Static member	AttachmentHasUniqueName	Finds out whether given attachment name is unique.
Public method Static member	ChangeDocumentCultureDataField	Updates culture data field value for all documents given by where condition.
Public method Static member	ClearCheckoutInformation	Clears the checkout information from the given document node.
Public method Static member	ClearWorkflowInformation	Clears the workflow information from the given document node.
Public method Static member	ColumnExistsInDocumentView	Checks whether specified column exists in main document view.
Public method Static member	CopyAttachmentsAsTemporary	Copies unsorted and grouped attachments of the given document as temporary attachments for specified form.
Public method Static member	CopyDocument(CopyDocumentSettings)	Copies the node according to the given settings.
Public method Static member	CopyDocument(TreeNode, TreeNode, Boolean, TreeProvider)	Copies the node to the specified location.
Public method Static member	CopyDocumentCategories	Copies categories from one document to another.
Public method Static member	CopyNodeData	Copies the data from the source node to the destination node according to the settings.
Public method Static member	DeleteAttachment(TreeNode, Guid)	Deletes attachment from the given document node, including versioning consideration.
Public method Static member	DeleteAttachment(TreeNode, String)	Deletes attachment from the given document node, including versioning consideration.
Public method Static member	DeleteDocument(DeleteDocumentSettings)	Deletes document according to supplied settings.
Public method Static member	DeleteDocument(TreeNode, TreeProvider, Boolean, Boolean)	Deletes the given document.
Public method Static member	DeleteDocumentAttachments	Deletes attachments bound to the specified field (file field or group attachments field)
Public method Static member	DeleteSiteTree	Deletes complete site tree including the version history.
Public method Static member	GetAttachment(Guid, Int32, Boolean)	Returns given version of the specified attachment. Returns only an attachment which is not a variant. For an attachment variant returns null.
Public method Static member	GetAttachment(Guid, String, Boolean)	Returns the latest version of the specified attachment. Returns only an attachment which is not a variant. For an attachment variant returns null.
Public method Static member	GetAttachment(String, Int32, Boolean)	Returns given version of the specified attachment. Returns only an attachment which is not a variant. For an attachment variant returns null.
Public method Static member	GetAttachment(TreeNode, Guid, Boolean)	Returns specified attachment for the given node. Returns only an attachment which is not a variant. For an attachment variant returns null.
Public method Static member	GetAttachment(TreeNode, String, Boolean)	Returns attachment for the given node specified by file name. Returns only an attachment which is not a variant. For an attachment variant returns null.
Public method Static member	GetAttachment(Guid, String, Boolean, TreeNode)	Returns the latest version of the specified attachment. Returns only an attachment which is not a variant. For an attachment variant returns null.
Public method Static member	GetAttachment(Int32, String, Int32, Boolean)	Obsolete. Returns given version of the specified attachment. Returns only an attachment which is not a variant. For an attachment variant returns null.
Public method Static member	GetAttachments	Gets attachments (AttachmentInfo) or attachments versions (AttachmentHistoryInfo) for given document. Result contains objects of type AttachmentHistoryInfo if given document is under workflow. Otherwise result contains AttachmentInfo. Returns only main attachments, not attachment variants.
Public method Static member	GetDocument(Int32, TreeProvider)	Returns current document version. If versioning is used, gets the current VersionHistory record, otherwise gets the record directly from the database.
Public method Static member	GetDocument(NodeSelectionParameters, TreeProvider)	Returns current document version. If versioning used, gets the current VersionHistory record, otherwise gets the record directly from the database.
Public method Static member	GetDocument(TreeNode, TreeProvider)	Returns the latest version of the document if versioning is used or the document itself otherwise.
Public method Static member	GetDocument(Int32, String, TreeProvider)	Returns current document version. If versioning used, gets the current VersionHistory record, otherwise gets the record directly from the database.
Public method Static member	GetDocument(Int32, String, Boolean, TreeProvider)	Returns current document version. If versioning used, gets the current VersionHistory record, if not, gets the record directly from the database.
Public method Static member	GetDocument(String, String, String, Boolean, String, String, String, Int32, Boolean, String, TreeProvider)	Returns current document version. If versioning is used, gets the current VersionHistory record, otherwise gets the record directly from the database. Result contains coupled data only if classNames are specified.
Public method Static member	GetDocuments()	Gets the query for all documents (latest versions)
Public method Static member	GetDocuments(String)	Gets the query for all documents (latest versions) of specific type
Public method Static member	GetDocuments(NodeSelectionParameters, TreeProvider)	Returns latest version documents data in a dataset.
Public method Static member	GetDocuments(String, String, String, Boolean, String, String, String, Int32, Boolean, TreeProvider)	Returns latest version documents data in a dataset. Result contains coupled data only if classNames are specified.
Public method Static member	GetDocuments(String, String, String, Boolean, String, String, String, Int32, Boolean, Int32, TreeProvider)	Returns latest version documents data in a dataset. Result contains coupled data only if classNames are specified.
Public method Static member	GetDocuments(String, String, String, Boolean, String, String, String, Int32, Boolean, Int32, String, TreeProvider)	Returns latest version documents data in a dataset. Result contains coupled data only if classNames are specified.
Public method Static member	GetDocuments(String, String, String, Boolean, String, String, String, Int32, Boolean, Guid, String, Boolean, TreeProvider)	Returns latest version documents data in a dataset. Result contains coupled data only if classNames are specified.
Public method Static member	GetDocuments(String, String, String, Boolean, String, String, String, Int32, Boolean, Guid, String, Boolean, Int32, String, TreeProvider)	Returns latest version documents data in a dataset. Result contains coupled data only if classNames are specified.
Public method Static member	GetDocuments<TDocument>()	Gets the query for all documents (latest versions) of specific type
Public method Static member	GetPrimaryAttachmentsForDocuments	Gets the primary attachments for the given document IDs. Used internally to display thumbnails in dialogs
Public method Static member	GetPublished	Gets the published state of the document from the given data container
Public method Static member	GetTreeNodeDataSet	Gets the new DataSet for the given node with specific class name.
Public method Static member	GetUniqueAttachmentFileName	Returns unique attachment file name in the document scope.
Public method Static member	InsertDocument	Inserts a new document.
Public method Static member	InsertDocumentAsLink	Inserts a new linked document.
Public method Static member	InsertNewCultureVersion(NewCultureDocumentSettings)	Inserts a new document culture version.
Public method Static member	InsertNewCultureVersion(TreeNode, TreeProvider, String, Boolean, Boolean)	Inserts a new document culture version.
Public method Static member	IsDocumentObjectType	Indicates if given object type represents document.
Public method Static member	IsDocumentTypeAllowed	Returns true if child class is allowed within given parent class and alias path.
Public method Static member	IsSearchTaskCreationAllowed	Returns true if the search task for given node should be created.
Public method Static member	LogDocumentChange	If synchronization logging is enabled, disables log context and logs the document change.
Public method Static member	MoveAttachmentDown	Moves attachment down within node attachments. Supports unordered, grouped and temporary attachments.
Public method Static member	MoveAttachmentUp	Moves attachment up within node attachments. Supports unordered, grouped and temporary attachments.
Public method Static member	MoveDocument(MoveDocumentSettings)	Moves the node according to the given settings.
Public method Static member	MoveDocument(TreeNode, TreeNode, TreeProvider, Boolean)	Moves the specified document to the new location.
Public method Static member	SaveTemporaryAttachments	Saves temporary attachments for specified form.
Public method Static member	SearchFieldChanged	Returns true if any field included in the search changed (checks fields defined in Class Search Settings).
Public method Static member	UpdateAttachment	Updates the document attachment
Public method Static member	UpdateDocument	Updates the current version of the document within the database. If versioning is used, updates the last version within the VersionHistory, otherwise updates directly the database document record.