DCalcPdfHitRectsJob Class

Calculate hit locations in a PDF file to highlight after a search.

File

File: dtsfc.h

Namespace: dtSearch

Syntax

C++

class DCalcPdfHitRectsJob : public DJobBase;

Data Members

Data Member	Description
HitRects	Array of hit rectangle data (populated after Execute returns). See the PdfHighlightItemTable class in PdfHighlightItemTable.cs for sample code demonstrating how to interpret this data.
InputFile	The input PDF file to calculate hit rects for. If the PDF file does not exist on disk under the name returned in search results, set this field to the location where the file can be found.

Group

Classes

Members

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Execute	Calculate the hit rects for the item specified by SetResults()
Execute	Called to execute a job. (Inherited from DJobBase)
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnQuestion	Not used (Inherited from DJobBase)
SetResults	The search results and item ordinal in search results of the item to calculate hit rects for.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

Data Members

Data Member	Description
HitRects	Array of hit rectangle data (populated after Execute returns). See the PdfHighlightItemTable class in PdfHighlightItemTable.cs for sample code demonstrating how to interpret this data.
InputFile	The input PDF file to calculate hit rects for. If the PDF file does not exist on disk under the name returned in search results, set this field to the location where the file can be found.

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Execute	Calculate the hit rects for the item specified by SetResults()
Execute	Called to execute a job. (Inherited from DJobBase)
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnQuestion	Not used (Inherited from DJobBase)
SetResults	The search results and item ordinal in search results of the item to calculate hit rects for.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

Remarks

dtSearch returns hit locations as word offsets after a search. Use DCalcPdfHitRectsJob to convert these word offsets to PDF page coordinates. The PDF page coordinates are returned as an array of integers. This data can then be used with DFileConvertJob to add hit highlight annotations to a PDF file for display.

Class Hierarchy

dtSearch::DJobBase | dtSearch::DCalcPdfHitRectsJob