Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]
public class

# FindReplaceOptions

extends OptionsBase

java.lang.Object
↳ | com.pdftron.pdf.OptionsBase
| ↳ | com.pdftron.pdf.FindReplaceOptions

## Summary

Nested Classes
enum | FindReplaceOptions.HorizAlignment | An enumeration used to specify the horizontal alignment of the new text added.
enum | FindReplaceOptions.MatchType | An enumeration used to specify the mode used to match text.
enum | FindReplaceOptions.ReflowType | An enumeration used to specify the mode used to reflow the replaced text.

Public Constructors
| FindReplaceOptions() Constructor.
| FindReplaceOptions(String json_string) Constructor.

Public Methods
FindReplaceOptions.HorizAlignment | getAlignment() Gets the value Alignment from the options object.
int | getBatchSize() Gets the value BatchSize from the options object.
boolean | getMatchCase() Gets the value MatchCase from the options object.
FindReplaceOptions.MatchType | getMatchMode() Gets the MatchMode value from the options object.
String | getPages() Gets the value Pages from the options object.
FindReplaceOptions.ReflowType | getReflowMode() Gets the value ReflowMode from the options object.
boolean | getWholeWords() Gets the value WholeWords from the options object.
FindReplaceOptions | setAlignment(FindReplaceOptions.HorizAlignment value) Sets the value for Alignment in the options object.
FindReplaceOptions | setBatchSize(int value) Sets the value for BatchSize in the options object.
FindReplaceOptions | setMatchCase(boolean value) Sets the value for MatchCase in the options object.
FindReplaceOptions | setMatchMode(FindReplaceOptions.MatchType value) Sets MatchMode value in the options object.
FindReplaceOptions | setPages(String value) Sets the value for Pages in the options object.
FindReplaceOptions | setReflowMode(FindReplaceOptions.ReflowType value) Sets the value for ReflowMode in the options object.
FindReplaceOptions | setWholeWords(boolean value) Sets the value for WholeWords in the options object.

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Constructors

#### public FindReplaceOptions ()

Constructor.

##### Throws

PDFNetException |

#### public FindReplaceOptions (String json_string)

Constructor.

##### Throws

PDFNetException |

## Public Methods

#### public FindReplaceOptions.HorizAlignment getAlignment ()

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

##### Returns

- The current value for Alignment.

##### Throws

PDFNetException |

#### public int 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.

##### Returns

- The current value for BatchSize.

##### Throws

PDFNetException |

#### public boolean 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.

##### Returns

- The current value for MatchCase.

##### Throws

PDFNetException |

#### public FindReplaceOptions.MatchType 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.

##### Returns

- The current value for MatchMode.

##### Throws

PDFNetException |

#### public String 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.

##### Returns

- The current value for Pages.

##### Throws

PDFNetException |

#### public FindReplaceOptions.ReflowType getReflowMode ()

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

##### Returns

- The current value for ReflowMode.

##### Throws

PDFNetException |

#### public boolean 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.

##### Returns

- The current value for WholeWords.

##### Throws

PDFNetException |

#### public FindReplaceOptions setAlignment (FindReplaceOptions.HorizAlignment value)

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

##### Parameters

value | The new value for Alignment.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public FindReplaceOptions setBatchSize (int value)

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.

##### Parameters

value | The new value for BatchSize.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public FindReplaceOptions setMatchCase (boolean value)

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.

##### Parameters

value | The new value for MatchCase.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public FindReplaceOptions setMatchMode (FindReplaceOptions.MatchType value)

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.

##### Parameters

value | The new value for MatchMode.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public FindReplaceOptions setPages (String value)

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.

##### Parameters

value | The new value for Pages.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public FindReplaceOptions setReflowMode (FindReplaceOptions.ReflowType value)

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

##### Parameters

value | The new value for ReflowMode.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public FindReplaceOptions setWholeWords (boolean value)

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.

##### Parameters

value | The new value for WholeWords.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |