TextMatchGroup Class

A group of text matches found in a PDF document.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

Declaration

C#

public class TextMatchGroup

VB.NET

Public Class TextMatchGroup

Example

How to: Format Found Text in a PDF Document

The following code snippet changes the font color of matching text fragments:

C#

using DevExpress.Docs.Pdf;
using System.Collections.Generic;
using System.Drawing;
using System.IO;

using (FileStream fileStream =
    File.OpenRead(@"Document.pdf"))
{
    using (PdfDocument pdfDocument =
        new PdfDocument(fileStream))
    {
        IEnumerable<TextSearchInfo> results =
            pdfDocument.FindText("DevExpress",
                new TextSearchOptions(true, true), 0, 2);

        foreach (TextSearchInfo searchResult in results)
        {
            foreach (var group in searchResult.Groups)
            {
                // Split the fragment into matched parts.
                var newFragments = group.Fragment
                    .Split(group,
                        out TextFragment[] matched,
                        out TextFragment[] notMatched);

                // Apply formatting to matched fragments.
                foreach (var matchedFragment in matched)
                {
                    matchedFragment.Font = 
                        new TextFont("Arial", TextFontStyle.Bold);
                    matchedFragment.ForegroundFill = new SolidFill(PdfColor.Red);
                }

                pdfDocument.Pages[searchResult.PageIndex]
                    .Fragments.Replace(
                        group.Fragment, newFragments);
            }
        }

        pdfDocument.Save(new FileStream(
            "Result.pdf", FileMode.Create,
            FileAccess.Write));
    }
}

VB.NET

Imports DevExpress.Docs.Pdf
Imports System.Collections.Generic
Imports System.Drawing
Imports System.IO

Using fileStream As FileStream = _
        File.OpenRead("Document.pdf")
    Using pdfDocument As New PdfDocument(fileStream)
        Dim searchResults As IEnumerable(Of TextSearchInfo) = _
            pdfDocument.FindText("DevExpress", _
                New TextSearchOptions(True, True), 0, 2)

        For Each searchResult As TextSearchInfo _
                In searchResults
            For Each group In searchResult.Groups
                ' Split the fragment into matched parts.
                Dim matched As TextFragment() = Nothing
                Dim notMatched As TextFragment() = Nothing
                Dim newFragments As TextFragment() = _
                    group.Fragment.Split( _
                        group, matched, notMatched)

                ' Apply formatting to matched fragments.
                For Each matchedFragment In matched
                    matchedFragment.Font = New TextFont("Arial", TextFontStyle.Bold)
                    matchedFragment.ForegroundFill = New SolidFill(PdfColor.Red)
                Next

                pdfDocument.Pages(searchResult.PageIndex) _
                    .Fragments.Replace( _
                        group.Fragment, newFragments)
            Next
        Next

        pdfDocument.Save(New FileStream( _
            "Result.pdf", FileMode.Create, _
            FileAccess.Write))
    End Using
End Using

Inheritance

Object

TextMatchGroup