IFileConverter Interface

Converts files to HTML, RTF, or text, optionally highlighting hits in the output.

File

File: dten600.idl

Module: COM Interface

Syntax

IDL

interface IFileConverter : IDispatch;

Group

Interfaces

Members

Properties

Property	Description
AfterHit	Text to insert after each hit
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	Text to insert before each hit
DetectedTypeId	File format of the input document, as detected by the dtSearch Engine.
Errors	A JobErrorInfo (IJobErrorInfo) containing information about any errors that occurred during conversion.
Flags	ConvertFlags specifying how the conversion is to be done
Footer	Text to insert at the end of each file
Header	Text to insert at the start of the file
Hits	A string containing word offsets of the hits to be marked in the document, separated by spaces. SetInputItem will set this based on information in SearchResults
HtmlHead	For HTML output, tags to insert after the HEAD tag.
IndexRetrievedFrom	The index this item was found in. SetInputItem will set this based on information in SearchResults.
InputDocId	The document ID of this document in the index it was found in. SetInputItem will set this based on information in SearchResults.
InputFields	If the document was indexed using IndexJob.DataSourceToIndex, supply the same fields in InputFields that the DataSourceToIndex object returned for this document in the DocFields property.
InputFile	Name of the file to convert
InputText	If the document was indexed using IndexJob.DataSourceToIndex, supply the same text in InputText that the DataSourceToIndex object returned for this document in the DocText property.
InputTypeId	Type id of the file parser to use to convert this file. SetInputItem will set this based on information in SearchResults.
OutputFile	Name of the converted file to create
OutputFormat	Output format for the conversion (see OutputFormats enum for a list of types). By default, a FileConverter converts the input file to HTML. Other supported options are: it_RTF (212), it_Utf8 (238) (Unicode text), and it_Ansi (202).
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. When this time is exceeded, Execute will halt leaving incomplete results in the OutputFile or OutputString. If TimeoutSeconds is 0 (the default), no time limit will be set. After a timeout has occured, the Errors property will contain an message with the numeric code dtsErTimeout.

Methods

Method	Description
Execute	Performs the conversion
SetInputItem	Set up the FileConverter to highlight hits in an item retrieved from SearchResults. SetInputItem sets up InputFile, Hits, InputTypeId, InputDocId, IndexRetrievedFrom, and AlphabetLocation.

Methods

Method	Description
Execute	Performs the conversion
SetInputItem	Set up the FileConverter to highlight hits in an item retrieved from SearchResults. SetInputItem sets up InputFile, Hits, InputTypeId, InputDocId, IndexRetrievedFrom, and AlphabetLocation.

Properties

Property	Description
AfterHit	Text to insert after each hit
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	Text to insert before each hit
DetectedTypeId	File format of the input document, as detected by the dtSearch Engine.
Errors	A JobErrorInfo (IJobErrorInfo) containing information about any errors that occurred during conversion.
Flags	ConvertFlags specifying how the conversion is to be done
Footer	Text to insert at the end of each file
Header	Text to insert at the start of the file
Hits	A string containing word offsets of the hits to be marked in the document, separated by spaces. SetInputItem will set this based on information in SearchResults
HtmlHead	For HTML output, tags to insert after the HEAD tag.
IndexRetrievedFrom	The index this item was found in. SetInputItem will set this based on information in SearchResults.
InputDocId	The document ID of this document in the index it was found in. SetInputItem will set this based on information in SearchResults.
InputFields	If the document was indexed using IndexJob.DataSourceToIndex, supply the same fields in InputFields that the DataSourceToIndex object returned for this document in the DocFields property.
InputFile	Name of the file to convert
InputText	If the document was indexed using IndexJob.DataSourceToIndex, supply the same text in InputText that the DataSourceToIndex object returned for this document in the DocText property.
InputTypeId	Type id of the file parser to use to convert this file. SetInputItem will set this based on information in SearchResults.
OutputFile	Name of the converted file to create
OutputFormat	Output format for the conversion (see OutputFormats enum for a list of types). By default, a FileConverter converts the input file to HTML. Other supported options are: it_RTF (212), it_Utf8 (238) (Unicode text), and it_Ansi (202).
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. When this time is exceeded, Execute will halt leaving incomplete results in the OutputFile or OutputString. If TimeoutSeconds is 0 (the default), no time limit will be set. After a timeout has occured, the Errors property will contain an message with the numeric code dtsErTimeout.

Remarks

The FileConverter object converts files to HTML (or RTF or plain text), optionally marking hits with caller-supplied HTML tags. To convert a file to HTML, create a FileConverter, use the properties below to describe the conversion task you want to perform, and call the Execute() method.

Use the NewFileConverter method of the Server object to create a new FileConverter object.

When highlighting hits from search results, use SetInputItem to initialize the FileConverter with information obtained from SearchResults.

BeforeHit, AfterHit, Header, and Footer control the appearance of converted text. Header and Footer are inserted before and after the body of the document. The BeforeHit and AfterHit markers are inserted before and after each hit word. The BeforeHit and AfterHit markers can contain hypertext links. To facilitate creation of hit navigation markers, the strings "%%ThisHit%%", "%%NextHit%%", and "%%PrevHit%%" will be replaced with ordinals representing the current hit, the next hit, and the previous hit in the document. The example code below uses the BeforeHit and NextHit marks as HTML "Previous Hit" and "Next Hit" buttons.

Example

This example converts a file to HTML, adding tags around each hit to facilitate navigation of the document (the tags are hypertext links to the previous/next hit in the document). Results is a SearchResults object with the results of a search.

Dim cj As Object Set cj = TheEngine.NewFileConverter ' Set up the FileConverter to convert an item from a SearchResults ' object, Results cj.SetInputItem(Results, whichDocumentToDisplay) Dim quote As String quote = Chr$(34) ' ' Surround each hit with angle brackets (<< and >>) and make each ' angle bracket a link to the next/prev hit ' cj.BeforeHit = "<A NAME=" + quote + "hit%%ThisHit%%" + quote + "></A>" + _ "<A HREF=" + quote + "#hit%%PrevHit%%" + quote + ">" + _ "<<</A><b>" cj.AfterHit = "</b><A HREF=" + quote + "#hit%%NextHit%%" + quote + ">" + _ ">></A>" cj.Header = "<HR><A HREF=" + quote + "#hit1" + quote + ">Click here for first hit</A><BR><HR>" cj.Footer = "<HR>Converted by the dtSearch Engine" cj.OutputFile = tempName cj.Execute

Class Hierarchy

IFileConverter