ISearchReportJob Interface

File

File: dten600.idl

Module: COM Interface

Syntax

IDL

interface ISearchReportJob : IDispatch;

Group

Interfaces

Members

Properties

Property	Description
AfterHit	Text to be inserted after each hit
BeforeHit	Text to be inserted before each hit
ContextFooter	Text to appear after each block of context
ContextHeader	Text to appear after each file in the search report.
Errors	A JobErrorInfo (IJobErrorInfo) containing information about any errors that occurred during generation of the search report.
FileFooter	Text to appear after each file in the report
FileHeader	Text to appear in front of each file in the search report.
Flags	ReportFlags specifying how the report should be generated
Footer	Text to be inserted at the end of the report
Header	Text to be inserted at the top of the report
MaxContextBlocks	Number of blocks of context to include in the report. If zero, all hits in each document will be included.
MaxWordsToRead	Number of words to scan in each document looking for blocks of context to include in the report.
OutputFile	The name of the 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	If OutputToString is true, the maximum size of the string to create in OutputString
OutputToString	If true, output will be stored in OutputString instead of in a file
ParagraphsOfContext	Paragraphs of context to include around each hit
TimeoutSeconds	Maximum number of seconds to allow the job to run
WordsOfContext	Number of words or paragraphs of context to include surrounding each hit. If WordsOfContextExact is set, exactly the requested number of words of context will be included. Otherwise, enough paragraphs of context will be included to provide at least the requested number of words.
WordsOfContextExact	Number of words or paragraphs of context to include surrounding each hit. If WordsOfContextExact is set, exactly the requested number of words of context will be included. Otherwise, enough paragraphs of context will be included to provide at least the requested number of words.

Methods

Method	Description
ClearSelections	Clear all selections, so no items from search results will be selected to be included in the report
Execute	Generate the report
SelectAll	Select all items from search results to include in the report
SelectItems	Select a range of items in the SearchResults

Methods

Method	Description
ClearSelections	Clear all selections, so no items from search results will be selected to be included in the report
Execute	Generate the report
SelectAll	Select all items from search results to include in the report
SelectItems	Select a range of items in the SearchResults

Properties

Property	Description
AfterHit	Text to be inserted after each hit
BeforeHit	Text to be inserted before each hit
ContextFooter	Text to appear after each block of context
ContextHeader	Text to appear after each file in the search report.
Errors	A JobErrorInfo (IJobErrorInfo) containing information about any errors that occurred during generation of the search report.
FileFooter	Text to appear after each file in the report
FileHeader	Text to appear in front of each file in the search report.
Flags	ReportFlags specifying how the report should be generated
Footer	Text to be inserted at the end of the report
Header	Text to be inserted at the top of the report
MaxContextBlocks	Number of blocks of context to include in the report. If zero, all hits in each document will be included.
MaxWordsToRead	Number of words to scan in each document looking for blocks of context to include in the report.
OutputFile	The name of the 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	If OutputToString is true, the maximum size of the string to create in OutputString
OutputToString	If true, output will be stored in OutputString instead of in a file
ParagraphsOfContext	Paragraphs of context to include around each hit
TimeoutSeconds	Maximum number of seconds to allow the job to run
WordsOfContext	Number of words or paragraphs of context to include surrounding each hit. If WordsOfContextExact is set, exactly the requested number of words of context will be included. Otherwise, enough paragraphs of context will be included to provide at least the requested number of words.
WordsOfContextExact	Number of words or paragraphs of context to include surrounding each hit. If WordsOfContextExact is set, exactly the requested number of words of context will be included. Otherwise, enough paragraphs of context will be included to provide at least the requested number of words.

Description

Use a SearchReportJob to generate a search report from some or all of the items listed in a SearchResults object.

Remarks

To create a SearchReportJob,

Call the SearchResults object's NewSearchReportJob method (see ISearchResults),
Set up the properties of the SearchReportJob to reflect the format of the report you want to create, and
Call the Execute method of the SearchReportJob to create the report.

For sample code, see frmMakeReport in the vbsearch sample application.

Format

A search report lists the hits found in one or more documents, with each hit surrounded by a specified amount of context. Each block of context starts with a contextHeader and ends with the contextFooter. Contiguous or overlapping blocks of context will be combined. The amount of context included in the report can be specified by words or by paragraphs.

Each block of context is constructed as follows:

[ContextHeader] ...text... [BeforeHit] hit [AfterHit] ...text... [ContextFooter]

The report as a whole is constructed as follows:

[Header] [FileHeader] [ContextHeader] ...text... [BeforeHit] hit [AfterHit] ...text... [ContextFooter] [ContextHeader] ...text... [BeforeHit] hit [AfterHit] ...text... [ContextFooter] ... more blocks of context, if present [FileFooter] ... more files ... [Footer]

Use the following symbols to insert file information into the FileHeader and FileFooter:

Symbol	Meaning
Filename	The name of the file (without path information). For PDF and HTML files, this will be the Title.
Location	The location of the file
Fullname	The path and filename of the file.
Size	File size in bytes
SizeK	File size in kilobytes
Date	Modification date of the file when indexed
Hits	Number of hits in the file
Title	The first 80 characters of the file
DocId	The docId of the file
Type	The file type (Microsoft Word, PDF, HTML, etc.)
Ordinal	The 1-based ordinal of this item in the SearchResults from which it was generated
IndexRetrievedFrom	The index where the file was found

Use the following symbols to insert context information in the contextHeader, which appears in front of each block of context:

Symbol	Meaning
Page	Page number where the hit occurs
Paragraph	Paragraph number where the hit occurs (relative to the start of the page)
Word	Word offset of the block of context from the beginning of the file.
FirstHit	Word offset of the first hit in this block of context.

Use %% around each symbol, like this: %%FullName%%

Class Hierarchy

ISearchReportJob