Show / Hide Table of Contents

# Class FindReplaceOptions

##### Inheritance

object
OptionsBase
FindReplaceOptions

##### Implements

IDisposable

##### Inherited Members

OptionsBase.mObjSet
OptionsBase.mDict
OptionsBase.ColorPtToNumber(ColorPt)
OptionsBase.ColorPtFromNumber(double)
OptionsBase.GetArray(string)
OptionsBase.PutNumber(string, double)
OptionsBase.PutBool(string, bool)
OptionsBase.PutText(string, string)
OptionsBase.PutRect(string, Rect)
OptionsBase.PushBackNumber(string, double)
OptionsBase.PushBackBool(string, bool)
OptionsBase.PushBackText(string, string)
OptionsBase.PushBackRect(string, Rect)
OptionsBase.RectFromArray(Obj)
OptionsBase.insertRectCollection(string, RectCollection, int)
OptionsBase.GetInternalObj()
OptionsBase.Dispose()
OptionsBase.Dispose(bool)
OptionsBase.Destroy()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.PDF

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class FindReplaceOptions : OptionsBase, IDisposable

### Constructors

#### FindReplaceOptions()

Constructor.

##### Declaration

    public FindReplaceOptions()

### Methods

#### GetAlignment()

Gets the value Alignment from the options object. Specifies the horizontal alignment of the new text added.

##### Declaration

    public FindReplaceOptions.HorizAlignment GetAlignment()

##### Returns

Type | Description
--- | ---
FindReplaceOptions.HorizAlignment | The current value for Alignment.

#### GetBatchSize()

Gets the value BatchSize from the options object. The number of pages to process before saving an intermediate PDF to free resources. A greater number of pages will increase memory usage, and a smaller number will increase processing time. Default is 20.

##### Declaration

    public int GetBatchSize()

##### Returns

Type | Description
--- | ---
int | The current value for BatchSize.

#### GetMatchCase()

Gets the value MatchCase from the options object. Specifies whether the case of the 'from' string should be exactly matched when finding text to replace. Ignored if MatchType is regex.

##### Declaration

    public bool GetMatchCase()

##### Returns

Type | Description
--- | ---
bool | The current value for MatchCase.

#### GetMatchMode()

Gets the MatchMode value from the options object. Specifies the mode used to match the text. the types of match are exact matching, wildcard matching and regular expression matching.

##### Declaration

    public FindReplaceOptions.MatchType GetMatchMode()

##### Returns

Type | Description
--- | ---
FindReplaceOptions.MatchType | The current value for MatchMode.

#### GetPages()

Gets the value Pages from the options object. Specifies a set of pages to process, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are processed. The first page is page number 1.

##### Declaration

    public string GetPages()

##### Returns

Type | Description
--- | ---
string | The current value for Pages.

#### GetReflowMode()

Gets the value ReflowMode from the options object. Specifies the mode used to reflow the replaced text.

##### Declaration

    public FindReplaceOptions.ReflowType GetReflowMode()

##### Returns

Type | Description
--- | ---
FindReplaceOptions.ReflowType | The current value for ReflowMode.

#### GetWholeWords()

Gets the value WholeWords from the options object. Specifies whether whole words should be matched when finding text to replace. Ignored if MatchType is regex.

##### Declaration

    public bool GetWholeWords()

##### Returns

Type | Description
--- | ---
bool | The current value for WholeWords.

#### SetAlignment(HorizAlignment)

Sets the value for Alignment in the options object. Specifies the horizontal alignment of the new text added.

##### Declaration

    public FindReplaceOptions SetAlignment(FindReplaceOptions.HorizAlignment value)

##### Parameters

Type | Name | Description
--- | --- | ---
FindReplaceOptions.HorizAlignment | value | The new value for Alignment.

##### Returns

Type | Description
--- | ---
FindReplaceOptions | This object, for call chaining.

#### SetBatchSize(int)

Sets the value for BatchSize in the options object. The number of pages to process before saving an intermediate PDF to free resources. A greater number of pages will increase memory usage, and a smaller number will increase processing time. Default is 20.

##### Declaration

    public FindReplaceOptions SetBatchSize(int value)

##### Parameters

Type | Name | Description
--- | --- | ---
int | value | The new value for BatchSize.

##### Returns

Type | Description
--- | ---
FindReplaceOptions | This object, for call chaining.

#### SetMatchCase(bool)

Sets the value for MatchCase in the options object. Specifies whether the case of the 'from' string should be exactly matched when finding text to replace. Ignored if MatchType is regex.

##### Declaration

    public FindReplaceOptions SetMatchCase(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | The new value for MatchCase.

##### Returns

Type | Description
--- | ---
FindReplaceOptions | This object, for call chaining.

#### SetMatchMode(MatchType)

Sets MatchMode value in the options object. Specifies the mode used to match the text. the types of match are exact matching, wildcard matching and regular expression matching.

##### Declaration

    public FindReplaceOptions SetMatchMode(FindReplaceOptions.MatchType value)

##### Parameters

Type | Name | Description
--- | --- | ---
FindReplaceOptions.MatchType | value | The new value for MatchMode.

##### Returns

Type | Description
--- | ---
FindReplaceOptions | This object, for call chaining.

#### SetPages(string)

Sets the value for Pages in the options object. Specifies a set of pages to process, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are processed. The first page is page number 1.

##### Declaration

    public FindReplaceOptions SetPages(string value)

##### Parameters

Type | Name | Description
--- | --- | ---
string | value | The new value for Pages.

##### Returns

Type | Description
--- | ---
FindReplaceOptions | This object, for call chaining.

#### SetReflowMode(ReflowType)

Sets the value for ReflowMode in the options object. Specifies the mode used to reflow the replaced text.

##### Declaration

    public FindReplaceOptions SetReflowMode(FindReplaceOptions.ReflowType value)

##### Parameters

Type | Name | Description
--- | --- | ---
FindReplaceOptions.ReflowType | value | The new value for ReflowMode.

##### Returns

Type | Description
--- | ---
FindReplaceOptions | This object, for call chaining.

#### SetWholeWords(bool)

Sets the value for WholeWords in the options object. Specifies whether whole words should be matched when finding text to replace. Ignored if MatchType is regex.

##### Declaration

    public FindReplaceOptions SetWholeWords(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | The new value for WholeWords.

##### Returns

Type | Description
--- | ---
FindReplaceOptions | This object, for call chaining.

### Implements

IDisposable