Therefore Programming Interface 3.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

TheDocument

TheDocument represents and Therefore™ compound file containing one or more document streams (e.g. a Word document and a PDF). The class provides various methods for adding, removing and extracting streams. All meta information for the document is contained in the IndexData member.

Namespace: Therefore.API

Name	Description
AddStream	Adds a file to the compound file.
AddStreamEx	Adds a file to the compound file. The file is converted into the desired format first.
AddStreamsEx	Adds one or more files to the document. The files are converted into the desired format first.
Archive	Archive the current TheDocument.
CheckIn	Checks in the updated document.
CheckOut	Checks out the document or tests if a check out is possible.
Close	Closes the currently opened Therefore™ compound file.
CloseViewer	Closes the Therefore™ Viewer window that was opened with TheDocument.View().
Create	Creates a new Therefore™ compound file.
CreateCaseLink	Creates a link between a Therefore™ document and case.
CreateDocumentLink	Creates a link between two Therefore™ documents.
CreateLink	Creates a new Therefore™ compound file that contains a link to an Therefore™ document.
DeleteCaseLink	Deletes a link between a Therefore™ document and case.
DeleteDocumentLink	Deletes a link between two Therefore™ documents.
Dispose	Closes the currently opened Therefore™ compound file and deletes it from the hard disc. Do Not execute this method when the document has already been closed.
ExtractStream	Extracts a stream from the compound file and writes it to the hard disk.
ExtractStreamEx	Extracts a stream from the compound file, converts it into the desired format and writes it to the hard disk.
ExtractStreamsEx	Extracts streams from the compound file, converts them into the desired format and writes them to the hard disk.
GetCheckInComment	This opens the check in comment dialog.
GetLinkedObjects	Returns a list of TheLinkedObject items.
GetThumbnail	Retrieves the thumbnail of the document.
GetStream	Get a reference to the IStream object representing the file stream.
GetStreamInfo	Gets information on a stream of the Therefore™ compound file.
IsLinkTo	Checks whether the opened document is a link document. A link document does not contain any document data. It only contains the document number, which is a link to a document in the archive.
Open	Opens a Therefore™ document (Therefore™ compound document file).
Retrieve	Overloaded. Retrieves the document from the server and opens it.
SelectDocument
UndoCheckOut	Frees the locked document so that other users may check it out. All changes are lost.
VerifySignature	Verifies the automatic signature of the Therefore™ compound file.
View	Opens Therefore™ Viewer to display the document.

Name	Description
FilePath	Gets the full path to the Therefore™ compound file.
IndexData	Gets or sets the TheIndexData of the document.
StreamCount	Gets the number of streams in the Therefore™ compound file.
ViewerWnd	Gets the handle of the Therefore™ Viewer window that was opened with TheDocument.View().