| DocumentHelper Methods |
The DocumentHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | 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.
|
| AddAttachment(TreeNode, String, HttpPostedFile, 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, AttachmentSource, 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, Int32, Int32, Int32) |
Adds specified group attachment to the document or updates the attachment if already present.
|
| AddGroupedAttachment(TreeNode, Guid, Guid, HttpPostedFile, Int32, Int32, Int32) |
Adds given group attachment to the document or updates the attachment if already present.
|
| AddUnsortedAttachment(TreeNode, Guid, String, Int32, Int32, Int32) |
Adds specified unsorted attachment to the document or updates the attachment if already present.
|
| AddUnsortedAttachment(TreeNode, Guid, HttpPostedFile, Int32, Int32, Int32) |
Adds given unsorted attachment to the document or updates the attachment if already present.
|
| AttachmentHasUniqueName |
Finds out whether given attachment name is unique.
|
| 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 main document view.
|
| CopyAttachmentsAsTemporary |
Copies unsorted and grouped attachments of the given document as temporary attachments for specified form.
|
| CopyDocument(CopyDocumentSettings) |
Copies the node according to the given settings.
|
| CopyDocument(TreeNode, TreeNode, Boolean, TreeProvider) |
Copies the node to the specified location.
|
| 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) |
Deletes attachment from the given document node, including versioning consideration.
|
| DeleteAttachment(TreeNode, String) |
Deletes attachment from the given document node, including versioning consideration.
|
| DeleteDocument(DeleteDocumentSettings) |
Deletes document according to supplied settings.
|
| DeleteDocument(TreeNode, TreeProvider, Boolean, Boolean) |
Deletes the given document.
|
| DeleteDocumentAttachments |
Deletes attachments bound to the specified field (file field or group attachments field)
|
| DeleteSiteTree |
Deletes complete site tree including the version history.
|
| EnsureBlogPostHierarchy |
Ensures that the parent document of the blog post is blog month.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| GetAttachment(Int32, 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.
|
| GetAttachments(TreeNode, Boolean) |
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.
|
| GetAttachments(TreeNode, String, String, Boolean, TreeProvider, Int32, String) | Obsolete.
Gets attachments for given document filtered by the given parameters.
Returns only attachments which are not variants.
|
| GetAttachmentUrl(Guid, Int32) |
Returns URL to the specified attachment GUID.
|
| GetAttachmentUrl(IAttachment, 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.
|
| 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.
|
| GetDocumentsTDocument |
Gets the query for all documents (latest versions) of specific type
|
| GetPrimaryAttachmentsForDocuments |
Gets the primary attachments for the given document IDs. Used internally to display thumbnails in dialogs
|
| GetPublished |
Gets the published state of the document from the given data container
|
| GetTreeNodeDataSet |
Gets the new DataSet for the given node with specific class name.
|
| GetUniqueAttachmentFileName |
Returns unique attachment file name in the document scope.
|
| ChangeDocumentCultureDataField |
Updates culture data field value for all documents given by where condition.
|
| InsertDocument |
Inserts a new document.
|
| InsertDocumentAsLink |
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.
|
| 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
|
| 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(MoveDocumentSettings) |
Moves the node according to the given settings.
|
| MoveDocument(TreeNode, TreeNode, TreeProvider, Boolean) |
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 |
Updates the document attachment
|
| 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.
|
See Also