Core WorkSite functions provided by Mocom WorkSite Library.
Inheritance Hierarchy
Mocom_WorkSite_LibraryWorkSite
Namespace: Mocom_WorkSite_Library
Assembly: Mocom WorkSite Library (in Mocom WorkSite Library.dll) Version: 1.0.8.0 (1.0.8)
Syntax
The WorkSite type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | WorkSite | Initializes a new instance of the WorkSite class |
Methods
| Name | Description | |
|---|---|---|
| ChangeDatabase |
Changes to a different database. By default the user's preferred database is always selected unless this method is called.
|
| CheckinDocument(Int32) |
Checks in an already checked out document.
|
| CheckinDocument(Int32, Int32) |
Checks in an already checked out document version.
|
| CheckoutDocument(String, Int32, WorkSitePathCreationOption) |
Checks out a copy of the latest version of a WorkSite document to a specified path.
|
| CheckoutDocument(String, Int32, Int32, WorkSitePathCreationOption) |
Checks out a copy of the latest version of a WorkSite document to a specified path.
|
| CheckoutDocument(String, Int32, WorkSitePathCreationOption, String, WorkSiteDocumentFileExtensionOptions) |
Checks out a copy of the latest version of a WorkSite document to a specified path and filename.
|
| CheckoutDocument(String, Int32, Int32, WorkSitePathCreationOption, String, WorkSiteDocumentFileExtensionOptions) |
Checks out a copy of a specified version of a WorkSite document to a specified path and filename.
|
| ConnectToWorkSite |
Connect to the WorkSite server using windows credentials. The name of the server is specified in the ServerName property.
|
| ConnectToWorkSite(String) |
Connect to the WorkSite server using windows credentials.
|
| ConnectToWorkSite(String, String) |
Connect to the WorkSite server using supplied credentials.
The name of the server is specified in the ServerName property.
|
| ConnectToWorkSite(String, String, String) |
Connect to the WorkSite server using windows credentials.
|
| CopyDocument(String, Int32, WorkSitePathCreationOption) |
Save a copy of the latest version of a WorkSite document to a specified path.
|
| CopyDocument(String, Int32, Int32, WorkSitePathCreationOption) |
Save a copy of a specified version of a WorkSite document to a specified path.
|
| CopyDocument(String, Int32, WorkSitePathCreationOption, String, WorkSiteDocumentFileExtensionOptions) |
Save a copy of the latest version of a WorkSite document to a specified path and filename.
|
| CopyDocument(String, Int32, Int32, WorkSitePathCreationOption, String, WorkSiteDocumentFileExtensionOptions) |
Save a copy of a specified version of a WorkSite document to a specified path and filename.
|
| CreateFolder |
Create a document folder.
|
| DeleteDocumentFromWorkSite |
Deletes a document from WorkSite.
|
| DisconnectFromWorkSite |
Logs out and disconnects from the WorkSite server.
|
| GetDocumentClasses |
Gets a collection of Document classes for the preferred database.
|
| GetDocumentClasses(String) |
Gets a collection of registered document classes for the specified database.
|
| GetDocumentDetails(Int32) |
Gets the details of the latest version of a document from WorkSite
|
| GetDocumentDetails(Int32, Int32) |
Gets the details of a version of a document from WorkSite
|
| GetDocumentFolderById |
Gets a WorkSiteFolder object for the given Id.
|
| GetDocumentsInFolder |
Gets a list of documents in a document folder
|
| GetSubFolders(String) |
Gets a list of folders contained in the root folder specified by the object id.
|
| GetSubFolders(WorkSiteSpecialFolderAreas) |
Gets a list of the folders contained within the specified folder area.
|
| GetUsers |
Gets a collection of users for the connected database.
|
| GetWorkSiteFolderIdFromName |
Gets the folder ID for the named folder.
|
| GetWorkspaceByClientAndMatter |
Get a list of Workspaces for the supplied Client and Matter
|
| ImportDocumentToWorkSite(WorkSiteDocument) |
Add a document to the connected user's default database.
|
| ImportDocumentToWorkSite(String, String, String, String, String) |
Add a document to the connected user's default database.
|
| ImportDocumentToWorkSite(String, String, String, String, String, String, String) |
Add a document to the connected user's default database.
|
| ImportDocumentToWorkSite(String, String, String, String, String, String, String, String) |
Add a document to the connected database. If the document is added to a folder
it will inherit both the security and profile information of the folder.
|
| ImportDocumentToWorkSite(String, String, String, String, String, String, String, String, WorkSiteDocumentInheritanceOptions) |
Add a document to the connected database.
|
| IsDocumentCheckedOut(Int32) |
Queries WorkSite to see the latest version of a document is checked out.
|
| IsDocumentCheckedOut(Int32, Int32) |
Queries WorkSite to see if a version of document is checked out.
|
| OpenFileWithWorkSite(Int32, NullableIntPtr) |
Opens the latest specified document using Filesite/Desksite
|
| OpenFileWithWorkSite(Int32, Int32, NullableIntPtr) |
Opens the specified document using Filesite/Desksite
|
| UpdateDocumentDetails |
Updates the profile of a document.
|
Properties
| Name | Description | |
|---|---|---|
 | Databases |
Gets a list of the WorkSite databases for the currently connected WorkSite session.
|
| DefaultDatabase |
Gets the default database for the connected user.
|
| IsConnectedToWorkSite |
Gets a value indicating whether there is a current logged on session to the WorkSite server.
|
| Licence |
Gets or sets the licence code for the installed site.
|
| ServerName |
Gets or sets the name of the WorkSite server used for the current connection.
|
See Also