PdfDocumentProcessor.GetPageText(Int32, PdfTextExtractionOptions) Method

Obtains text from the specified page.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public string GetPageText(
    int pageNumber,
    PdfTextExtractionOptions options
)

VB.NET

Public Function GetPageText(
    pageNumber As Integer,
    options As PdfTextExtractionOptions
) As String

Parameters

Name	Type	Description
pageNumber	Int32	The page number. The minimum value is 1.
options	PdfTextExtractionOptions	An object that contains extraction options.

Returns

Type	Description
String	The text obtained from the specified page.

Remarks

If a document does not contain the specified page, the GetPageText method returns an empty string.

The GetPageText method returns text as a string of lines separated by newlines (“\r\n”).

C#

PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor();
pdfDocumentProcessor.LoadDocument("PDF32000_2008.pdf");
string firstPageText = processor.GetPageText(1, new PdfTextExtractionOptions { ClipToCropBox = false });

VB.NET

Dim pdfDocumentProcessor As PdfDocumentProcessor = New PdfDocumentProcessor()
pdfDocumentProcessor.LoadDocument("PDF32000_2008.pdf")
Dim firstPageText As String = processor.GetPageText(1, New PdfTextExtractionOptions With {
    .ClipToCropBox = False
})