The following tables list the members exposed by FileConverter.
Public Method |
Description |
Performs the conversion. | |
SetInputItem provides a quick way to set up a FileConvertJob with a particular item from a SearchResults list. |
Public Property |
Description |
If an array of hit offsets has been provided in Hits, then the BeforeHit and AfterHit strings will be used to mark each hit in the document in the converted output (Inherited from OutputBase) | |
The location of the dtSearch alphabet file to use when highlighting hits. SetInputItem() will set this based on information in SearchResults. | |
For HTML output, an HREF for a BASE tag to be inserted in the header. (Inherited from OutputBase) | |
If an array of hit offsets has been provided in Hits, then the BeforeHit and AfterHit strings will be used to mark each hit in the document in the converted output (Inherited from OutputBase) | |
File type of input document detected by dtSearch file parsers. | |
For HTML output, a DocType tag such as <!DOCTYPE html>to go before the first tag in the output. (Inherited from OutputBase) | |
(Inherited from JobBase) | |
Options for extraction of embedded images and attachments | |
Flags that control the conversion. | |
The Footer will be appended to the conversion output and can use tags in the output format, such as HTML tags in a document converted to HTML. (Inherited from OutputBase) | |
The Header will appear at the top of the conversion output and can use tags in the output format, such as HTML tags in a document converted to HTML. (Inherited from OutputBase) | |
Information returned in SearchResultsItem.HitsByWord | |
Use HtmlHead to supply HTML data to appear inside the HEAD section of the output. (Inherited from OutputBase) | |
Use an IndexCache for faster extraction of cached documents from indexes | |
The index in which the document was found. SetInputItem will set this based on information in SearchResults. | |
Use InputBytes to provide a document in a memory buffer rather than as a disk file. | |
The doc id of the document being converted. This is used when the document is being extracted from cached data in the index rather than from InputBytes or InputText. SetInputItem() will set this based on information in SearchResults. | |
If the document was indexed using a DataSource object, supply the same fields in InputFields that the DataSource returned for this document in the DocFields property. | |
Name of the file to convert. This can be a local disk file or a UNC path, but not an HTTP file. | |
Use DocStream to provide access to binary document data for this document. | |
If the document was indexed using a DataSource object, supply the same text in InputText that the DataSource returned for this document in the DocText property. | |
The file type of the input document when it was indexed. SetInputItem() will set this based on information in SearchResults. | |
Name of the converted file to create. (Inherited from OutputBase) | |
By default, a FileConverter converts the input file to HTML. Other supported options are: itRTF, itUTF8 (Unicode text), itAnsi, and itXML (for XML input data only). (Inherited from OutputBase) | |
If OutputToString is true, output will be stored in OutputString rather than in a disk file. (Inherited from OutputBase) | |
When output is directed to an in-memory string, you may wish to limit the maximum amount of memory used. To do this, set OutputStringMaxSize to the maximum size you want to allow. (Inherited from OutputBase) | |
If true, output will be stored in an in-memory string variable rather than a disk file. (OutputFile will be ignored.) After the Execute method is done, the output will be in the OutputString property. (Inherited from OutputBase) | |
Set to a non-zero value to make the job terminate automatically after a specified number of seconds. (Inherited from JobBase) |
Copyright (c) 1998-2023 dtSearch Corp. All rights reserved.
|