A document type used to represent a WorkSite document.
Inheritance Hierarchy
Mocom_WorkSite_LibraryWorkSiteDocument
Namespace: Mocom_WorkSite_Library
Assembly: Mocom WorkSite Library (in Mocom WorkSite Library.dll) Version: 1.0.8.0 (1.0.8)
Syntax
The WorkSiteDocument type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | WorkSiteDocument | Initializes a new instance of the WorkSiteDocument class |
Methods
| Name | Description | |
|---|---|---|
| GetCustomField |
Gets the value of a custom field.
|
| SetCustomField(Int32, Boolean) |
Set the value of a custom field.
|
| SetCustomField(Int32, DateTime) |
Set the value of a custom field.
|
| SetCustomField(Int32, Int64) |
Set the value of a custom field.
|
| SetCustomField(Int32, String) |
Set the value of a custom field.
|
Properties
| Name | Description | |
|---|---|---|
 | Author |
Gets or sets author of the document.
|
| CheckedOutLocation |
Gets the name of the PC that the document is currently checked out on.
|
| CheckedOutPath |
Gets path that the document is currently checked out to.
|
| CheckedOutTo |
Gets the name of the user that the document is currently checked out to.
|
| Client |
Gets or sets Custom Field 1 usually used for 'Client' in WorkSite - parent field for Custom field 2. The client number must be a valid entry in the WorkSite Database.
|
| Comment |
Gets or sets the comments on a document.
|
| CreatedDate |
Gets the date and time the document was created.
|
| Description |
Gets or sets the description to give the document in WorkSite.
|
| DocumentClass |
Gets or sets the class of document such as Discussion, Memo etc.
|
| DocumentNumber |
Gets or sets the ID of the document once it has been imported into WorkSite.
|
| DocumentType |
Gets or sets the type of document as set in the WorkSite database. e.g Word 2007
|
| DocumentVersion |
Gets or sets the Version of the document once it has been imported into WorkSite.
|
| DocumentVersions |
Gets the available versions of a document.
|
| EditDate |
Gets or sets the edit date of a document.
|
| Filename |
Gets or sets the path to the file on the local hard drive.
|
| FolderObjectId |
Sets the folder object id for this document - use when adding a new document to specify a folder to link the document to.
|
| ImportInheritanceOptions |
Gets or sets the options for folder inheritance if the document is imported into WorkSite
|
| IsCheckedOut |
Gets the checked out status of the document.
|
| Matter |
Gets or sets Custom Field 2 usually used for 'Matter' in WorkSite - a child field for Custom Field 2 or 'Client'.
The correct value for the associated Client must be set in the client property, and the Matter number must exist in the WorkSite Database.
|
| Name |
Gets or sets the name of the document.
|
| Operator |
Gets or sets operator/user of the document.
|
See Also