PdfToTextConverterFindTextAsync(String, String, Int32, Boolean, Boolean, CancellationToken) Method

Asynchronously searches for the specified text in pages of a PDF file starting at a given page number through the end of the document

Definition

Namespace: HiQPdf.Next
Assembly: HiQPdf.Next.PdfProcessor (in HiQPdf.Next.PdfProcessor.dll) Version: 1.0.0
C#
public Task<FindTextLocation[]> FindTextAsync(
	string pdfFile,
	string textToFind,
	int startPageNumber,
	bool caseSensitive,
	bool wholeWord,
	CancellationToken ct = default
)

Parameters

pdfFile  String
Full path of the PDF file to search
textToFind  String
Text to find
startPageNumber  Int32
Start page number
caseSensitive  Boolean
Flag indicating whether the search should match case
wholeWord  Boolean
Flag indicating whether the search should match whole words
ct  CancellationToken  (Optional)
A cancellation token that can be used to cancel the asynchronous operation. When cancellation is requested the task returned by this method will complete by throwing OperationCanceledException as soon as possible

Return Value

TaskFindTextLocation
Records containing the locations of the searched text in PDF pages

See Also