DocumentObject Class

This object represents a Document.

This object is derived from the ContentObject class. All properties and methods from the ContentObject are supported for the Document object, plus the properties below.

Properties

PROPERTY NAME

 DATA TYPE

DESCRIPTION

FileType

 String

The file extension of the document

DOS_FileName

 String

The DOS “friendly” file name of the document

CheckedOut

 Boolean

Is the document currently checked out?

CheckedOutUID

 String

If this document is checked out, the UID of the user

FilePath

String

This property will return the physical file path of an attachment that is stored on the file system. This property will return no value if the document is stored in the Process Director database.

WebViewableOID

 String

The OID of the optional web viewable object

ManagedOID

 String

The OID of the actual document object

Methods

Link

This method implements a simple routine that creates a thumbnail image of the first page of a document.

Parameters

BP: The Process Director BP Object.

DID: The ID of the document to retrieve.

Returns

N/A

Example

BPLogix.WorkflowDirector.SDK.Document.CreateThumbnail(bp, "DID");

Link

This API will return the bytes for a document.

Parameters

None

Returns

byte: Will return null if document isn't found.

Example

byte[] DocBytes = Document.GetBytes();

Link

This API will get a document object from the specified ID.

Parameters

BP: The Process Director BP Object.

DID: The ID of the document to retrieve.

Returns

Document: Will return null if document isn't found.

Example

// Normally not used directly
var oDocument = Document.GetDocumentByDID(bp, "DID");

Link

This API will return the stream for a document.

Parameters

None

Returns

stream: Will return null if document isn't found.

Example

stream DocBytes = Document.GetStream();

Link

This method implements a simple routine that removes a thumbnail image.

Parameters

BP: The Process Director BP Object.

DID: The ID of the document to retrieve.

Returns

N/A

Example

BPLogix.WorkflowDirector.SDK.Document.RemoveThumbnail(bp, "DID");

Link

This API will set the web viewable object for a document

Parameters

SourcePath: The full path to the local file system of the web viewable object.

Returns

Boolean: True if the operation succeeds.

Example

BPLogix.WorkflowDirector.SDK.Document.SetDocReviewable("c:\\Import\\File.pdf");

Link

This API enables you to set or replace the contents of a documen.

Parameters

pData: The Stream object to be updated.

Description (Optional): The String description of the new document data.

Returns

Boolean: True if the operation succeeds.

Example

This example overwrites a document in the Content List from a document stored in a local file system.

Document doc = Document.GetDocumentByDID(bp, "DID")
Stream pData = File.Open("C:\Filepath\file.txt", FileMode.Open);
doc.UpdateDocData(pData);

Link

This API will write the document to a local file.

Parameters

DestPath: The full path of the local output file.

Returns

Boolean: True if the operation succeeds.

Example

Document oDocument = Document.GetDocumentByDID(bp, "DID")
oDocument.WriteDocumentToDisk("c:\\Documents\\SavedDoc.docx");