Click or drag to resize
DocumentHelper Class
Class providing document management methods.
Inheritance Hierarchy
SystemObject
  CMS.DocumentEngineDocumentHelper

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131
Syntax
C#
public static class DocumentHelper

The DocumentHelper type exposes the following members.

Fields
  NameDescription
Public fieldStatic memberDOCUMENT_PREFIX
Document prefix for object type.
Public fieldStatic memberLOGCONTEXT_DOCUMENTS
Log context name for document actions
Top
Methods
  NameDescription
Public methodStatic memberAddAttachment(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 methodStatic memberAddAttachment(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 methodStatic memberAddAttachment(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 methodStatic memberAddAttachment(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 methodStatic memberAddGroupedAttachment(TreeNode, Guid, Guid, IUploadedFile, Int32, Int32, Int32)
Adds given group attachment to the document or updates the attachment if already present.
Public methodStatic memberAddGroupedAttachment(TreeNode, Guid, Guid, String, Int32, Int32, Int32)
Adds specified group attachment to the document or updates the attachment if already present.
Public methodStatic memberAddGroupedAttachment(TreeNode, Guid, Guid, HttpPostedFile, Int32, Int32, Int32) Obsolete.
Adds given group attachment to the document or updates the attachment if already present.
Public methodStatic memberAddUnsortedAttachment(TreeNode, Guid, IUploadedFile, Int32, Int32, Int32)
Adds given unsorted attachment to the document or updates the attachment if already present.
Public methodStatic memberAddUnsortedAttachment(TreeNode, Guid, String, Int32, Int32, Int32)
Adds specified unsorted attachment to the document or updates the attachment if already present.
Public methodStatic memberAddUnsortedAttachment(TreeNode, Guid, HttpPostedFile, Int32, Int32, Int32) Obsolete.
Adds given unsorted attachment to the document or updates the attachment if already present.
Public methodStatic memberAttachmentHasUniqueName
Finds out whether given attachment name is unique.
Public methodStatic memberChangeDocumentCultureDataField
Updates culture data field value for all documents given by where condition.
Public methodStatic memberClearCheckoutInformation
Clears the checkout information from the given document node.
Public methodStatic memberClearWorkflowInformation
Clears the workflow information from the given document node.
Public methodStatic memberColumnExistsInDocumentView
Checks whether specified column exists in main document view.
Public methodStatic memberCopyAttachmentsAsTemporary
Copies unsorted and grouped attachments of the given document as temporary attachments for specified form.
Public methodStatic memberCopyDocument(CopyDocumentSettings)
Copies the node according to the given settings.
Public methodStatic memberCopyDocument(TreeNode, TreeNode, Boolean, TreeProvider)
Copies the node to the specified location.
Public methodStatic memberCopyDocumentCategories
Copies categories from one document to another.
Public methodStatic memberCopyNodeData
Copies the data from the source node to the destination node according to the settings.
Public methodStatic memberDeleteAttachment(TreeNode, Guid)
Deletes attachment from the given document node, including versioning consideration.
Public methodStatic memberDeleteAttachment(TreeNode, String)
Deletes attachment from the given document node, including versioning consideration.
Public methodStatic memberDeleteDocument(DeleteDocumentSettings)
Deletes document according to supplied settings.
Public methodStatic memberDeleteDocument(TreeNode, TreeProvider, Boolean, Boolean)
Deletes the given document.
Public methodStatic memberDeleteDocumentAttachments
Deletes attachments bound to the specified field (file field or group attachments field)
Public methodStatic memberDeleteSiteTree
Deletes complete site tree including the version history.
Public methodStatic memberGetAttachment(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 methodStatic memberGetAttachment(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 methodStatic memberGetAttachment(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 methodStatic memberGetAttachment(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 methodStatic memberGetAttachment(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 methodStatic memberGetAttachment(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 methodStatic memberGetAttachment(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 methodStatic memberGetAttachments
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 methodStatic memberGetDocument(Int32, TreeProvider)
Returns current document version. If versioning is used, gets the current VersionHistory record, otherwise gets the record directly from the database.
Public methodStatic memberGetDocument(NodeSelectionParameters, TreeProvider)
Returns current document version. If versioning used, gets the current VersionHistory record, otherwise gets the record directly from the database.
Public methodStatic memberGetDocument(TreeNode, TreeProvider)
Returns the latest version of the document if versioning is used or the document itself otherwise.
Public methodStatic memberGetDocument(Int32, String, TreeProvider)
Returns current document version. If versioning used, gets the current VersionHistory record, otherwise gets the record directly from the database.
Public methodStatic memberGetDocument(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 methodStatic memberGetDocument(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 methodStatic memberGetDocuments
Gets the query for all documents (latest versions)
Public methodStatic memberGetDocuments(String)
Gets the query for all documents (latest versions) of specific type
Public methodStatic memberGetDocuments(NodeSelectionParameters, TreeProvider)
Returns latest version documents data in a dataset.
Public methodStatic memberGetDocuments(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 methodStatic memberGetDocuments(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 methodStatic memberGetDocuments(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 methodStatic memberGetDocuments(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 methodStatic memberGetDocuments(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 methodStatic memberGetDocumentsTDocument
Gets the query for all documents (latest versions) of specific type
Public methodStatic memberGetPrimaryAttachmentsForDocuments
Gets the primary attachments for the given document IDs. Used internally to display thumbnails in dialogs
Public methodStatic memberGetPublished
Gets the published state of the document from the given data container
Public methodStatic memberGetTreeNodeDataSet
Gets the new DataSet for the given node with specific class name.
Public methodStatic memberGetUniqueAttachmentFileName
Returns unique attachment file name in the document scope.
Public methodStatic memberInsertDocument
Inserts a new document.
Public methodStatic memberInsertDocumentAsLink
Inserts a new linked document.
Public methodStatic memberInsertNewCultureVersion(NewCultureDocumentSettings)
Inserts a new document culture version.
Public methodStatic memberInsertNewCultureVersion(TreeNode, TreeProvider, String, Boolean, Boolean)
Inserts a new document culture version.
Public methodStatic memberIsDocumentObjectType
Indicates if given object type represents document.
Public methodStatic memberIsDocumentTypeAllowed
Returns true if child class is allowed within given parent class and alias path.
Public methodStatic memberIsSearchTaskCreationAllowed
Returns true if the search task for given node should be created.
Public methodStatic memberLogDocumentChange
If synchronization logging is enabled, disables log context and logs the document change.
Public methodStatic memberMoveAttachmentDown
Moves attachment down within node attachments. Supports unordered, grouped and temporary attachments.
Public methodStatic memberMoveAttachmentUp
Moves attachment up within node attachments. Supports unordered, grouped and temporary attachments.
Public methodStatic memberMoveDocument(MoveDocumentSettings)
Moves the node according to the given settings.
Public methodStatic memberMoveDocument(TreeNode, TreeNode, TreeProvider, Boolean)
Moves the specified document to the new location.
Public methodStatic memberSaveTemporaryAttachments
Saves temporary attachments for specified form.
Public methodStatic memberSearchFieldChanged
Returns true if any field included in the search changed (checks fields defined in Class Search Settings).
Public methodStatic memberUpdateAttachment
Updates the document attachment
Public methodStatic memberUpdateDocument
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.
Top
See Also