SDMSClient Members

Functions

Name Description
AddDocument Add a document to SDMS.

Return value: Boolean.

AddDocumentNoUI Add a document to SDMS with no UI.

Return value:

CheckIn Check a document in to SDMS.

Return value: Boolean.

CheckInNoUI Check a document in to SDMS with no UI.

Return value: .

Checkout Checkout documents identified by a SDMSDocuments collection, a single SDMSDocument, or array/single string of form 'doc_id[:revision]' (revision defaults to current revision).

Return value: .

ComputeChecksum Return value: Integer.
CreateSession Integrated login, creates a session for the current user.
CreateSession2 Integrated login, creates a session for the current user.
CustomOpenFileDialog Displays a standard windows file open dialog customized to allow open from SDMS.

Return value: Boolean.

DeleteDocument Mark a document deleted in the system.
DownloadDocuments Download documents identified by a SDMSDocuments collection, a single SDMSDocument, or array/single string of form 'doc_id[:revision]' (revision defaults to current revision).

Return value: Boolean.

EditBindings Displays a dialog with a list of one or more local file names and an associated binding to a document in SDMS. Allows modifying the binding, downloading the document, checking in/out, etc. Return value: Boolean.
FolderPrompt Displays a dialog to allow user to select a local folder for downloading documents to.

Return value: Boolean.

GenerateNewDocumentId Generate a new GUID to use as a document id for AddDocument. Return value: String.
GetDocument Get a SDMSDocument object by doc id and revision. Defaults to current revision.

Return value: .

GetDocuments Get a SDMSDocument object by doc id and revision. Defaults to current revision. Returns a single SDMSDocument if passed a single doc id, a SDMSDocuments collection if passed array of document ids.

Return value: Variant.

IsLoggedIn Return value: Boolean
Login Log in to SDMS.
Login2 Log in to SDMS
Logout Log out from SDMS.
OpenFileDialog Displays a 'file open dialog' to select one or more files from SDMS.

Return value: Boolean.

OpenFileDialogWithDownload Displays an open file dialog, and downloads the selected documents, with optional checkout. Return value: Boolean.
RenameDocument Rename a document.
UndoCheckout Undo checkout of documents identified by a SDMSDocuments collection, a single SDMSDocument, or array/single string of form 'doc_id[:revision]' (revision defaults to current revision).

Return value: .

UndoCheckout2 Undo checkout of a single document, prompting user for local file disposition (replace/leave). Return value: .

Properties

Name Description
AutoLogout Get or set whether to automatically log out when this object is released.

Return or assignment value: Boolean.

IdToken Get or set the identity token for the current session.

Return or assignment value: String.

ParentHwnd Parent window for dialogs displayed by this library.

Assignment value: Long.

SendKeepAlives Get or set whether to send keep alive messages or not.

Return or assignment value: Boolean.

Url The URL of the SDMS Server.

Return or assignment value: String.

UserName Get the SDMS user name of the user who is currently logged in to SDMS.

Return value: String.

This property is read only.

Events

Name Description
BeforeEditBindingsAddToSDMS -
BeforeEditBindingsCheckIn -
OnChangeBinding -