PdfTextSearchResults.Status Property

Indicates the current text search operation status.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfTextSearchStatus Status { get; }

VB.NET

Public ReadOnly Property Status As PdfTextSearchStatus

Property Value

Type	Description
PdfTextSearchStatus	A PdfTextSearchStatus enumeration value.

Available values:

Name	Description
Found	The text, which is being searched for, has been found.
NotFound	The text, which is being searched for, has not been found.
Finished	The text search has finished.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Status property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-bookmark-search-results-in-document/CS/Destination/Program.cs#L30

// to be displayed at the upper corner of the window.
if (results.Status == PdfTextSearchStatus.Found) {
    PdfXYZDestination destination = new PdfXYZDestination(results.Page, 0, results.Rectangles[0].Top, null);

pdf-document-api-operate-pdf-content-at-runtime/CS/WindowsFormsApplication1/MainForm.cs#L42

documentProcessor.LoadDocument(filePath);
while (documentProcessor.FindText(word).Status == PdfTextSearchStatus.Found) {
    count++;

pdf-document-api-highlight-search-results/CS/HighlightSearchResults/Program.cs#L29

//Get the search results from the FindText method call with search text and search parameters
while ((result = documentProcessor.FindText(word, searchParameters)).Status == PdfTextSearchStatus.Found)
{

VB.NET

pdf-document-api-bookmark-search-results-in-document/VB/Destination/Program.vb#L26

' to be displayed at the upper corner of the window.
If results.Status = DevExpress.Pdf.PdfTextSearchStatus.Found Then
    Dim destination As DevExpress.Pdf.PdfXYZDestination = New DevExpress.Pdf.PdfXYZDestination(results.Page, 0, results.Rectangles(CInt((0))).Top, Nothing)

pdf-document-api-operate-pdf-content-at-runtime/VB/WindowsFormsApplication1/MainForm.vb#L45

documentProcessor.LoadDocument(filePath)
While documentProcessor.FindText(word).Status = PdfTextSearchStatus.Found
    count += 1

pdf-document-api-highlight-search-results/VB/HighlightSearchResults/Program.vb#L22

'Get the search results from the FindText method call with search text and search parameters
While(CSharpImpl.__Assign(result, documentProcessor.FindText(word, searchParameters))).Status = PdfTextSearchStatus.Found
    'HighlightResultWithGraphics(documentProcessor, result);