VisualVault SDK

Document Members

Document overview

Public Instance Properties

Abstract Returns the abstract for this Document
ArchiveState Returns the Archive State for this Document being Active, Archived or Deleted
ChangeReason Returns the change reason for this Document revision
CreateBy Returns the UsID of the user that created the Document
CreateDate Returns the date the Document was created
CurrentLibraryStatus Returns a structure that contains last checked in and last checked out information
CurrentRole Return the Users current Security Role
Description Returns the description of the Document
DhID Returns the ID of the Document
DhRev Returns the internal revision number
DlID Returns the DlID of the Document
DocID Returns the DocID of the Document
DocumentLink Returns an Anchor Link to the Document that can be used to return the latest released revision of the Document
DocumentState Returns the Document State for this revision of Released, Un-Released or Pending
DocumentStatus Returns the Document Status for this revision of Checked In or Checked Out
ErrorCode Returns error code
ExpirationDate Returns the Expiration Date for this Document when the folder requires Documents to expire
Extension Returns the extension of the filename for this Document
Filename Returns the filename for the Document
FileSize Returns the file size of the Document's file
FolderID Returns the ID of the folder for this Document
FolderName Returns the folder name of this Document
FolderPath Returns the FolderPath of this Document
IsError Returns true if the document is in an error state
Keywords Returns the keywords for this Document
ModifyBy Returns the UsID of the user that created this revision of the Document
ModifyDate Returns the date this revision of the Document was created
ReviewDate Returns the Review Date for this Document when the folder requires Document Reviews
Revision Returns the revision of this Document

Public Instance Methods

ArchiveDocument Changes the Archive Status of the Document to Archive
ChangeArchiveStatus Change the Archive Status of the Document to Active, Archived or Deleted
ChangeDocumentState Changes the Document State to Released or Un-Released
CheckInOverloaded. Checks in a new revision of the Document
CheckOutOverloaded. Attempts to Check the Document out
CompareToOverloaded. Compares DocIDs of two Documents
CopyDocumentOverloaded. Copies the Document to another Folder location
DeleteDocument Changes the Archive Status of the Document to Delete
GetChildDocuments 
GetFileOverloaded. Retrieves the file as a byte array
GetIndexFieldCollection Returns the Collection of IndexFields
GetRelatedDocuments Gets related documents
GetRelatedForms Gets related forms
GetRelatedFormsDataSet Gets a DataSet of related forms
GetRelatedProjectDataSet Gets a DataSet of related projects
GetRelatedProjects Gets related projects
GetRevisionOverloaded. Returns a specific Revision of a Document based on the Revision
GetRevisions Returns a Collection of all revisions of the current document
GetSecurityMemberCollection Returns the Collection of Security Members
MoveDocumentOverloaded. Moves the Document to another Folder
PurgeDocumentRevision Purges a single revision of a document.
RelateToDocument Relates the current to another document
RemoveAllDocumentRelationships Removes all relationships for the specified document
RemoveAllFormRelationships Removes all form relationships from this document
RemoveDocumentRelationshipOverloaded. Removes the relationship to another document
RemoveFormRelationshipOverloaded. Removes the relationship to a form by the FormID
Rename 
UndoCheckOut Changes the Document Status to CheckedIn on a previously Checked out Document
UpdateAbstract Updates the Abstract of the Document
UpdateDescription Updates the Description of the Document
UpdateExpireDate Updates the Expire Date of the Document if the Folder requires Documents to be Reviewed
UpdateFilename Updates the Filename of the Document
UpdateKeywords Updates the Keywords of the Document
UpdateReviewDate Updates the Review Date of the Document if the Folder requires Documents to be Reviewed

See Also

Document Class | VVRuntime.Library.Documents Namespace