A helper class that encapsulates the process of extracting a document attached to a Trim object. More...

Inheritance diagram for TRIM.SDK.ExtractDocument:

Public Member Functions
	ExtractDocument ()

void	DoExtract (string toWindowsFolder, bool overwriteOk, bool checkoutDocument, string rootURLForHyperlinks)
	Extracts the document to the specified windows folder, giving it the name as specified by the FileName property. If the FileName property is blank, a temporary file will be created. After extraction, the FileName property will be updated to contained the full file name of the extracted file. More...

Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
string	FileName `[get, set]`
	Gets or sets a string containing the file name to be given to the document of this Extract Document when extracted. The directory to which it should be extracted is passed as a parameter of the 'DoExtract' method. More...

string	FileType `[get]`
	Gets a string containing the file extension of the electronic document corresponding to this ExtractDocument object. More...

long	FileSize `[get]`
	Gets an integer containing the size of the electronic document corresponding to this ExtractDocument in bytes. More...

TrimDateTime	FileDateTimeModified `[get]`
	Gets the date and time the electronic document corresponding to this ExtractDocument was last modified. More...

bool	ForWebBrowserViewing `[get, set]`
	Gets or sets a Boolean value indicating whether extracting this ExtractDocument will retrieve a 'browser friendly' version. That is, whether it is the type of document that may be viewed within a web browser. More...

bool	ConvertToHTML `[get, set]`
	Gets or sets a Boolean value indicating whether to convert the document to HTML More...

bool	HasOleLinks `[get]`
	Gets a Boolean value indicating whether the electronic document corresponding to this Extract Document contains OLE links to other documents. More...

bool	ConvertToZipIfHasOleLinks `[get, set]`
	Gets or sets a Boolean value indicating whether the electronic document should be converted to ZIP format if it contains OLE links to other documents. More...

bool	IsTRIMMail `[get]`
	Gets a Boolean value indicating whether the electronic document corresponding to this Extract Document is a TRIM mail message More...

string	CheckoutAs `[get, set]`
	Gets or sets a string that will be remembered by Content Manager as the checkout path of the electronic document. More...

string	HighlightWords `[get, set]`
	Gets or sets a string which contains a specification of which words to highlight when preparing an HTML format. The string is a comma delimited list of words. More...

string	HighlightForegroundColour `[get, set]`
	Gets or sets the value of the foreground colour used to highlight words. The value should be a hexadecimal representation of the standard RGB values used in HTML markup. For example, the colour red would be FF0000 and black would be 000000. More...

string	HighlightBackgroundColour `[get, set]`
	Gets or sets the value of the background colour used to highlight words. The value should be a hexadecimal representation of the standard RGB values used in HTML markup. For example, the colour red would be FF0000 and black would be 000000. More...

string	HTMLHeader `[get, set]`
	Gets or sets a string which contains HTML that will be placed at the start of the HTML file created when using the ConvertToHTML/ForWebBrowserViewing options. More...

string	HTMLFooter `[get, set]`
	Gets or sets a string which contains HTML that will be placed at the end of the HTML file created when using the ConvertToHTML/ForWebBrowserViewing options. More...

bool	SuppressLastAction `[get, set]`
	Gets or sets a Boolean property which indicates that the extract operation should not update the LastActionDate of a record. More...

bool	LogAsViewed `[get, set]`
	Gets or sets a Boolean property which indicates that the extract operation should log in the audit log as a "Document Viewed" event not a "Document Extracted" event. More...

Properties inherited from TRIM.SDK.TrimSDKObject
string	ErrorMessage `[get]`
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...

TrimException	Error `[get]`
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Detailed Description

A helper class that encapsulates the process of extracting a document attached to a Trim object.

Constructor & Destructor Documentation

◆ ExtractDocument()

TRIM.SDK.ExtractDocument.ExtractDocument ( )

Member Function Documentation

◆ DoExtract()

void TRIM.SDK.ExtractDocument.DoExtract	(	string	toWindowsFolder,
		bool	overwriteOk,
		bool	checkoutDocument,
		string	rootURLForHyperlinks
	)

Extracts the document to the specified windows folder, giving it the name as specified by the FileName property. If the FileName property is blank, a temporary file will be created. After extraction, the FileName property will be updated to contained the full file name of the extracted file.

Property Documentation

◆ CheckoutAs

string TRIM.SDK.ExtractDocument.CheckoutAs

getset

Gets or sets a string that will be remembered by Content Manager as the checkout path of the electronic document.

◆ ConvertToHTML

bool TRIM.SDK.ExtractDocument.ConvertToHTML

getset

Gets or sets a Boolean value indicating whether to convert the document to HTML

◆ ConvertToZipIfHasOleLinks

bool TRIM.SDK.ExtractDocument.ConvertToZipIfHasOleLinks

getset

Gets or sets a Boolean value indicating whether the electronic document should be converted to ZIP format if it contains OLE links to other documents.

◆ FileDateTimeModified

TrimDateTime TRIM.SDK.ExtractDocument.FileDateTimeModified

get

Gets the date and time the electronic document corresponding to this ExtractDocument was last modified.

◆ FileName

string TRIM.SDK.ExtractDocument.FileName

getset

Gets or sets a string containing the file name to be given to the document of this Extract Document when extracted. The directory to which it should be extracted is passed as a parameter of the 'DoExtract' method.

◆ FileSize

long TRIM.SDK.ExtractDocument.FileSize

get

Gets an integer containing the size of the electronic document corresponding to this ExtractDocument in bytes.

◆ FileType

string TRIM.SDK.ExtractDocument.FileType

get

Gets a string containing the file extension of the electronic document corresponding to this ExtractDocument object.

◆ ForWebBrowserViewing

bool TRIM.SDK.ExtractDocument.ForWebBrowserViewing

getset

Gets or sets a Boolean value indicating whether extracting this ExtractDocument will retrieve a 'browser friendly' version. That is, whether it is the type of document that may be viewed within a web browser.

◆ HasOleLinks

bool TRIM.SDK.ExtractDocument.HasOleLinks

get

Gets a Boolean value indicating whether the electronic document corresponding to this Extract Document contains OLE links to other documents.

◆ HighlightBackgroundColour

string TRIM.SDK.ExtractDocument.HighlightBackgroundColour

getset

Gets or sets the value of the background colour used to highlight words. The value should be a hexadecimal representation of the standard RGB values used in HTML markup. For example, the colour red would be FF0000 and black would be 000000.

◆ HighlightForegroundColour

string TRIM.SDK.ExtractDocument.HighlightForegroundColour

getset

Gets or sets the value of the foreground colour used to highlight words. The value should be a hexadecimal representation of the standard RGB values used in HTML markup. For example, the colour red would be FF0000 and black would be 000000.

◆ HighlightWords

string TRIM.SDK.ExtractDocument.HighlightWords

getset

Gets or sets a string which contains a specification of which words to highlight when preparing an HTML format. The string is a comma delimited list of words.

◆ HTMLFooter

string TRIM.SDK.ExtractDocument.HTMLFooter

getset

Gets or sets a string which contains HTML that will be placed at the end of the HTML file created when using the ConvertToHTML/ForWebBrowserViewing options.

◆ HTMLHeader

string TRIM.SDK.ExtractDocument.HTMLHeader

getset

Gets or sets a string which contains HTML that will be placed at the start of the HTML file created when using the ConvertToHTML/ForWebBrowserViewing options.

◆ IsTRIMMail

bool TRIM.SDK.ExtractDocument.IsTRIMMail

get

Gets a Boolean value indicating whether the electronic document corresponding to this Extract Document is a TRIM mail message

◆ LogAsViewed

bool TRIM.SDK.ExtractDocument.LogAsViewed

getset

Gets or sets a Boolean property which indicates that the extract operation should log in the audit log as a "Document Viewed" event not a "Document Extracted" event.

◆ SuppressLastAction

bool TRIM.SDK.ExtractDocument.SuppressLastAction

getset

Gets or sets a Boolean property which indicates that the extract operation should not update the LastActionDate of a record.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ExtractDocument()

Member Function Documentation

◆ DoExtract()

Property Documentation

◆ CheckoutAs

◆ ConvertToHTML

◆ ConvertToZipIfHasOleLinks

◆ FileDateTimeModified

◆ FileName

◆ FileSize

◆ FileType

◆ ForWebBrowserViewing

◆ HasOleLinks

◆ HighlightBackgroundColour

◆ HighlightForegroundColour

◆ HighlightWords

◆ HTMLFooter

◆ HTMLHeader

◆ IsTRIMMail

◆ LogAsViewed

◆ SuppressLastAction