FileConverter Class Members

You are here: Symbol Reference > dtSearch.Engine Namespace > Classes > FileConverter Class

Close

dtSearch .NET Standard API 2024.02

Contents | Index | Reference | Home

FileConverter Class Members

FileConverter Class

Members

Topics

Topic	Description
JobBase Members	The following tables list the members exposed by JobBase.
JobBase Properties	The properties of the JobBase class are listed here.

OutputBase Class

Topic	Description
OutputBase Members	The following tables list the members exposed by OutputBase.
OutputBase Properties	The properties of the OutputBase class are listed here.

FileConverter Class

Topic	Description
FileConverter Members	The following tables list the members exposed by FileConverter.
FileConverter Methods	The methods of the FileConverter class are listed here.
FileConverter Properties	The properties of the FileConverter class are listed here.

JobBase Properties

Show:Inherited

No members matching the current filter

JobBase Properties	Description
Errors	(Inherited from JobBase)
TimeoutSeconds	Set to a non-zero value to make the job terminate automatically after a specified number of seconds. (Inherited from JobBase)

OutputBase Class

Show:Inherited

No members matching the current filter

OutputBase Class	Description
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 (Inherited from OutputBase)
BaseHRef	For HTML output, an HREF for a BASE tag to be inserted in the header. (Inherited from OutputBase)
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 (Inherited from OutputBase)
DocTypeTag	For HTML output, a DocType tag such as <!DOCTYPE html>to go before the first tag in the output. (Inherited from OutputBase)
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. (Inherited from OutputBase)
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. (Inherited from OutputBase)
HtmlHead	Use HtmlHead to supply HTML data to appear inside the HEAD section of the output. (Inherited from OutputBase)
OutputFile	Name of the converted file to create. (Inherited from OutputBase)
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). (Inherited from OutputBase)
OutputString	If OutputToString is true, output will be stored in OutputString rather than in a disk file. (Inherited from OutputBase)
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. (Inherited from OutputBase)
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. (Inherited from OutputBase)

FileConverter Class

FileConverter Class	Description
AlphabetLocation	The location of the dtSearch alphabet file to use when highlighting hits. SetInputItem() will set this based on information in SearchResults.
DetectedTypeId	File type of input document detected by dtSearch file parsers.
ExtractionOptions	Options for extraction of embedded images and attachments
Flags	Flags that control the conversion.
Hits	Word offsets of the hits to highlight using the BeforeHit and AfterHit marks.
HitsByWord	Information returned in SearchResultsItem.HitsByWord
IndexCache	Use an IndexCache for faster extraction of cached documents from indexes
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 cached data in 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.

FileConverter Methods

FileConverter Class

FileConverter Class	Description
Execute	Performs the conversion.
SetInputItem	SetInputItem provides a quick way to set up a FileConvertJob with a particular item from a SearchResults list.

Copyright (c) 1998-2023 dtSearch Corp. All rights reserved.