GrapeCity.Documents

GrapeCity.Documents.Pdf.FindTextParams

Class FindTextParams

Namespace: GrapeCity.Documents.Pdf

Assembly: GcDocs.Pdf.dll

Represents find text parameters.

public class FindTextParams

Inheritance: object

FindTextParams

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

FindTextParams(string, bool, bool, ViewState, float, float, bool, bool)

Initializes a new instance of the FindTextParams class.

public FindTextParams(string text, bool wholeWord, bool matchCase, ViewState viewState, float dpiX = 72, float dpiY = 72, bool ignoreErrors = true, bool regex = false)

Parameters

text string: The text to find.
wholeWord bool: Indicates whether to match whole words only.
matchCase bool: Indicates whether to match case.
viewState ViewState: The ViewState object.
dpiX float: The horizontal resolution used to calculate bounds of the found text on the page.
dpiY float: The vertical resolution used to calculate bounds of the found text on the page.
ignoreErrors bool: Indicates whether to ignore errors in PDF content stream if possible.
regex bool: Indicates whether to interpret text as a regular expression.

FindTextParams(string, bool, bool, float, float, bool, bool)

Initializes a new instance of the FindTextParams class.

public FindTextParams(string text, bool wholeWord, bool matchCase, float dpiX = 72, float dpiY = 72, bool ignoreErrors = true, bool regex = false)

Parameters

text string: The text to find.
wholeWord bool: Indicates whether to match whole words only.
matchCase bool: Indicates whether to match case.
dpiX float: The horizontal resolution used to calculate bounds of the found text on the page.
dpiY float: The vertical resolution used to calculate bounds of the found text on the page.
ignoreErrors bool: Indicates whether to ignore errors in PDF content stream if possible.
regex bool: Indicates whether to interpret text as a regular expression.

Properties

DpiX

Gets the horizontal resolution used to calculate bounds of the found text on the page.

public float DpiX { get; }

Property Value

float

DpiY

Gets the vertical resolution used to calculate bounds of the found text on the page.

public float DpiY { get; }

Property Value

float

IgnoreErrors

Gets a value indicating whether to ignore errors in PDF content stream if possible.

The default is true.

public bool IgnoreErrors { get; }

Property Value

bool

MatchCase

Gets a value indicating whether to match case.

public bool MatchCase { get; }

Property Value

bool

Regex

Gets a value indicating whether the Text should be interpreted as a regular expression.

public bool Regex { get; }

Property Value

bool

Text

Gets the text to find.

public string Text { get; }

Property Value

string

ViewState

Gets the ViewState object.

public ViewState ViewState { get; }

Property Value

ViewState

WholeWord

Gets a value indicating whether to match whole words only.

public bool WholeWord { get; }

Property Value

bool

Methods

CreatRegex(string, bool, float, float, bool)

Creates a new FindTextParams object with the Regex property set to true.

public static FindTextParams CreatRegex(string pattern, bool matchCase = false, float dpiX = 72, float dpiY = 72, bool ignoreErrors = true)

Parameters

pattern string: The Regex pattern to search.
matchCase bool: Indicates whether to match case.
dpiX float: The horizontal resolution used to calculate bounds of the found text on the page.
dpiY float: The vertical resolution used to calculate bounds of the found text on the page.
ignoreErrors bool: Indicates whether to ignore errors in PDF content stream if possible.

Returns

FindTextParams