FileConverter Members

The following tables list the members exposed by FileConverter.

Public Methods

Execute	Performs the conversion.
SetIndexCache	Use an IndexCache for faster extraction of cached documents from indexes
SetInputItem	SetInputItem provides a quick way to set up a FileConvertJob with a particular item from a SearchResults list.

Public Properties

AfterHit	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
AlphabetLocation	The location of the dtSearch alphabet file to use when highlighting hits. SetInputItem() will set this based on information in SearchResults.
BaseHRef	For HTML output, an HREF for a BASE tag to be inserted in the header.
BeforeHit	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
DetectedTypeId	File type of input document detected by dtSearch file parsers.
DocTypeTag	For HTML output, a DocType tag such as <!DOCTYPE html>to go before the first tag in the output.
Errors	A JobErrorInfo containing information about any errors that occurred during conversion.
ExtractionOptions	Options for extraction of embedded images and attachments
Flags	Flags that control the conversion.
Footer	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.
Header	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.
Hits	Word offsets of the hits to highlight using the BeforeHit and AfterHit marks.
HitsByWord	Information returned in SearchResultsItem.HitsByWord
HtmlHead	Use HtmlHead to supply HTML data to appear inside the HEAD section of the output.
IndexRetrievedFrom	The index in which the document was found. SetInputItem will set this based on information in SearchResults.
InputBytes	Use InputBytes to provide a document in a memory buffer rather than as a disk file.
InputDocId	The doc id of the document being converted. This is used when the document is being extracted from the index rather than from InputBytes or InputText. SetInputItem() will set this based on information in SearchResults.
InputFields	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.
InputFile	Name of the file to convert. This can be a local disk file or a UNC path, but not an HTTP file.
InputStream	Use DocStream to provide access to binary document data for this document.
InputText	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.
InputTypeId	The file type of the input document when it was indexed. SetInputItem() will set this based on information in SearchResults.
OutputFile	Name of the converted file to create.
OutputFormat	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).
OutputString	If OutputToString is true, output will be stored in OutputString rather than in a disk file.
OutputStringMaxSize	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.
OutputToString	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.
TimeoutSeconds	Set TimeoutSeconds to the maximum amount of time you want to permit. The default is 0, in which case Execute will not timeout.