PdfTextOptions Class

Namespace:
GemBox.Pdf.Content
Assembly:
GemBox.Pdf.dll

Represents options used for extracting text from a PDF content.

public sealed class PdfTextOptions
Public NotInheritable Class PdfTextOptions
Inheritance:
System.Object
PdfTextOptions

Constructors

PdfTextOptions()

Initializes a new instance of the PdfTextOptions class.

public PdfTextOptions()
Public Sub New

Properties

Bounds

Gets or sets the bounds of the extracted text or null if the extracted text is unbounded.

Default value: null (the extracted text is unbounded).

public PdfQuad? Bounds { get; set; }
Public Property Bounds As PdfQuad?
Property Value
System.Nullable<PdfQuad>

The bounds of the extracted text or null if the extracted text is unbounded.

Default

Gets the default options used for extracting any text from a PDF content.

public static PdfTextOptions Default { get; }
Public Shared ReadOnly Property Default As PdfTextOptions
Property Value
PdfTextOptions

The default options used for extracting any text from a PDF content.

FontFace

Gets or sets the font face used for measuring insignificant whitespace characters inserted in the extracted text if the Blank flag is set in the Whitespaces property.

Default value: Courier.

public PdfFontFace FontFace { get; set; }
Public Property FontFace As PdfFontFace
Property Value
PdfFontFace

The font face used for measuring insignificant whitespace characters inserted in the extracted text if the Blank flag is set in the Whitespaces property.

Exceptions
System.ArgumentNullException

The value assigned to the FontFace is null.

NewLineChars

Gets or sets the character string to use for line breaks in the extracted text if the NewLine flag is set in the Whitespaces property.

Default value: System.Environment.NewLine.

public string NewLineChars { get; set; }
Public Property NewLineChars As String
Property Value
System.String

The character string to use for line breaks in the extracted text if the NewLine flag is set in the Whitespaces property.

Exceptions
System.ArgumentNullException

The value assigned to the NewLineChars is null.

Order

Gets or sets the order in which the text should be extracted.

Default value: Reading.

public PdfTextOrder Order { get; set; }
Public Property Order As PdfTextOrder
Property Value
PdfTextOrder

The order in which the text should be extracted.

Whitespaces

Gets or sets a value that specifies how whitespace characters are inserted in the extracted text.

Default value: Space | NewLine.

public PdfTextWhitespaces Whitespaces { get; set; }
Public Property Whitespaces As PdfTextWhitespaces
Property Value
PdfTextWhitespaces

A value that specifies how whitespace characters are inserted in the extracted text.