A helper class that encapsulates the process of extracting a document attached to a Trim object.
More...
|
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 HP TRIM 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...
|
|
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...
|
|
A helper class that encapsulates the process of extracting a document attached to a Trim object.
void HP.HPTRIM.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. If there is any failure in the extraction, e.g. could not convert to HTML, the FileName property will set be blank and the ErrorMessage property will explain what went wrong.