The DocumentHelper type exposes the following members.
Back to Top
Back to Top
Methods
| Name | Description | |
|---|---|---|
  | AddAttachment(TreeNode, String, String, TreeProvider, Int32, Int32, Int32) |
Adds specified attachment to the document. Does not update the document to the database, updates the attachment if currently present.
|
| AddAttachment(TreeNode, String, HttpPostedFile, TreeProvider, Int32, Int32, Int32) |
Adds given attachment to the document. Does not update the document to the database, updates the attachment if currently present.
|
| AddAttachment(TreeNode, String, Guid, Guid, Object, TreeProvider, Int32, Int32, Int32) |
Adds an attachment to the document. Does not update the document to the database, updates the attachment if currently present.
|
| AddGroupedAttachment(TreeNode, Guid, Guid, String, TreeProvider, Int32, Int32, Int32) |
Adds specified group attachment to the document or updates the attachment if already present.
|
| AddGroupedAttachment(TreeNode, Guid, Guid, HttpPostedFile, TreeProvider, Int32, Int32, Int32) |
Adds given group attachment to the document or updates the attachment if already present.
|
| AddUnsortedAttachment(TreeNode, Guid, String, TreeProvider, Int32, Int32, Int32) |
Adds specified unsorted attachment to the document or updates the attachment if already present.
|
| AddUnsortedAttachment(TreeNode, Guid, HttpPostedFile, TreeProvider, Int32, Int32, Int32) |
Adds given unsorted attachment to the document or updates the attachment if already present.
|
| ApplyVersionData |
Applies the version data to the given DataSet. NodeXML column with XML version data is expected.
|
| ClearCheckoutInformation |
Clears the checkout information from the given document node.
|
| ClearWorkflowInformation |
Clears the workflow information from the given document node.
|
| ColumnExistsInDocumentView |
Checks whether specified column exists in view 'View_CMS_Tree_Joined'.
|
| ConvertContainerToFieldType |
Converts given container class to the field type.
|
| CopyDocument(CopyDocumentSettings) |
Copies the node to the specified location.
|
| CopyDocument(TreeNode, TreeNode, Boolean, TreeProvider) |
Copies the node to the specified location.
|
| CopyDocument(TreeNode, Int32, Boolean, TreeProvider, Int32, Int32, Boolean, String) | Obsolete.
Copies the node to the specified location.
|
| CopyDocumentAttachments |
Copies attachments of the given document as temporary attachments for specified form.
|
| CopyDocumentCategories |
Copies categories from one document to another.
|
| CopyNodeData |
Copies the data from the source node to the destination node according to the settings.
|
| DeleteAttachment(TreeNode, Guid, TreeProvider) |
Deletes attachment from the given document node, including versioning consideration.
|
| DeleteAttachment(TreeNode, String, TreeProvider) |
Deletes attachment from the given document node, including versioning consideration.
|
| DeleteDocument(DeleteDocumentSettings) |
Deletes document according to supplied settings.
|
| DeleteDocument(TreeNode, TreeProvider, Boolean, Boolean, Boolean, String, ArrayList) |
Deletes the given document.
|
| DeleteDocumentAttachments |
Deletes attachments from the specified documents, including versioning consideration.
|
| DeleteSiteTree(String, TreeProvider) |
Deletes complete site tree including the version history.
|
| DeleteSiteTree(String, TreeProvider, DocumentHelper OnAfterDocumentDeletedEventHandler, String) |
Deletes complete site tree including the version history.
|
| EnsureBlogPostHierarchy(TreeNode, TreeNode, TreeProvider) |
Ensures that the parent document of the blog post is blog month.
|
| EnsureBlogPostHierarchy(TreeNode, Int32, TreeProvider) | Obsolete.
Ensures that the parent document of the blog post is blog month.
|
| EnsureOwnAttachments |
Creates document attachments for the given document when the attachments are bound to several documents.
|
| GetAttachment(Guid, TreeProvider, String, Boolean) |
Returns the latest version of the specified attachment.
|
| GetAttachment(Guid, Int32, TreeProvider, Boolean) |
Returns given version of the specified attachment.
|
| GetAttachment(TreeNode, Guid, TreeProvider, Boolean) |
Returns specified attachment for the given node.
|
| GetAttachment(TreeNode, String, TreeProvider, Boolean) |
Returns attachment for the given node specified by file name.
|
| GetAttachment(Guid, TreeProvider, String, Boolean, TreeNode ) |
Returns the latest version of the specified attachment.
|
| GetAttachment(Int32, String, Int32, TreeProvider, Boolean) |
Returns given version of the specified attachment.
|
| GetAttachments |
Gets attachments for given document filtered by the given parameters.
|
| GetAttachmentUrl(Guid, Int32) |
Returns URL to the specified attachment GUID.
|
| GetAttachmentUrl(AttachmentInfo, Int32) |
Returns URL to the given attachment.
|
| GetDocument(Int32, TreeProvider) |
Returns current document version. If versioning is used, gets the current VersionHistory record, otherwise gets the record directly from the database.
|
| GetDocument(NodeSelectionParameters, TreeProvider) |
Returns current document version. If versioning used, gets the current VersionHistory record, otherwise gets the record directly from the database.
|
| GetDocument(TreeNode, TreeProvider) |
Returns the latest version of the document if versioning is used or the document itself otherwise.
|
| GetDocument(Int32, String, TreeProvider) |
Returns current document version. If versioning used, gets the current VersionHistory record, otherwise gets the record directly from the database.
|
| 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.
|
| 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.
|
| GetDocumentEditUrl |
Gets link to edit document in Administration.
|
| GetDocumentMarkImage |
Gets document mark image tag.
|
| GetDocumentMarks |
Gets document mark image tag.
|
| GetDocuments |
Gets the query for all documents (latest versions)
|
| GetDocuments(String) |
Gets the query for all documents (latest versions) of specific type
|
| GetDocuments(NodeSelectionParameters, TreeProvider) |
Returns latest version documents data in a dataset.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| GetDocuments TDocument |
Gets the query for all documents (latest versions) of specific type
|
| GetTreeNodeDataSet |
Gets the new DataSet for the given node with specific class name.
|
| GetUniqueAttachmentFileName |
Returns unique attachment file name in the document scope.
|
| GetVersionsSelectQuery |
Returns versions select query for the given tree provider.
|
| ChangeDocumentCultureDataField |
Updates culture data field value for all documents given by where condition.
|
| ChangeDocumentToLink |
Changes the document so it is link to another document.
|
| IconsUsed |
Returns true if any of the icon is used
|
| InsertDocument(TreeNode, Int32, TreeProvider) | Obsolete.
Inserts a new document.
|
| InsertDocument(TreeNode, TreeNode, TreeProvider, Boolean) |
Inserts a new document.
|
| InsertDocumentAsLink(TreeNode, Int32, TreeProvider, Boolean, Boolean) | Obsolete.
Inserts a new linked document.
|
| InsertDocumentAsLink(TreeNode, TreeNode, TreeProvider, Boolean, Boolean, Int32, Int32) |
Inserts a new linked document.
|
| InsertNewCultureVersion(NewCultureDocumentSettings) |
Inserts a new document culture version.
|
| InsertNewCultureVersion(TreeNode, TreeProvider, String, Boolean, Boolean) |
Inserts a new document culture version.
|
| IsDocumentObjectType |
Indicates if given object type represents document.
|
| IsDocumentTypeAllowed |
Returns true if child class is allowed within given parent class and alias path.
|
| IsIconUsed |
Returns true if icon type is enabled
|
| IsSearchTaskCreationAllowed |
Returns true if the search task for given node should be created.
Returns true if
- search is allowed on general level AND
- search is allowed for document type of given node
- published version for given node exists AND
|
| IsUniqueAttachmentName |
Finds out whether given attachment name is unique.
|
| LogDocumentChange |
If synchronization logging is enabled, disables log context and logs the document change.
|
| MoveAttachmentDown |
Moves attachment down within node attachments. Supports unordered, grouped and temporary attachments.
|
| MoveAttachmentUp |
Moves attachment up within node attachments. Supports unordered, grouped and temporary attachments.
|
| MoveDocument(TreeNode, TreeNode, TreeProvider, Boolean) |
Moves the specified document to the new location.
|
| MoveDocument(TreeNode, Int32, TreeProvider, Boolean) | Obsolete.
Moves the specified document to the new location.
|
| SaveTemporaryAttachments |
Saves temporary attachments for specified form.
|
| SearchFieldChanged |
Returns true if any field included in the search changed (checks fields defined in Class Search Settings).
|
| UpdateAttachment(TreeNode, AttachmentInfo, TreeProvider) |
Updates the document attachment
|
| UpdateAttachment(TreeNode, Guid, Guid) |
Updates the attachment reference within document node. To assign the attachment a new GUID value in special operations.
|
| 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.
|
Fields
| Name | Description | |
|---|---|---|
 | DOCUMENT_FIELDS_PREFIX |
Document fields prefix for object type.
|
| DOCUMENT_PREFIX |
Document prefix for object type.
|
| GETDOCUMENTS_REQUIRED_COLUMNS |
Columns required for the get documents operation to perform successfully in any case.
|
See Also