FindReplaceOptions

FindReplaceOptions

Overview

FindReplaceOptions is a class in Aspose.Words FOSS for Java.

Specifies options for find/replace operations.

Edition status of its 53 listed members (a property and its accessor methods are listed separately, overloads once): 52 not yet exercised by a verified example.

This class declares 38 methods for FindReplaceOptions objects in Java programs. Available methods include: FindReplaceOptions, getApplyFont, getApplyParagraphFormat, getDirection, getFindWholeWordsOnly, getIgnoreDeleted, getIgnoreFieldCodes, getIgnoreFields, getIgnoreFootnotes, getIgnoreInserted, getIgnoreOfficeMath, getIgnoreShapes, and 23 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: applyFont, applyParagraphFormat, direction, findWholeWordsOnly, ignoreDeleted, ignoreFieldCodes, and 12 more.

Properties

NameTypeAccessDescription
applyFontFontReadText formatting applied to new content.
applyParagraphFormatParagraphFormatReadParagraph formatting applied to new content.
directionintRead/WriteSelects direction for replace.
matchCasebooleanRead/WriteTrue indicates case-sensitive comparison, false indicates case-insensitive comparison.
findWholeWordsOnlybooleanRead/WriteTrue indicates the oldValue must be a standalone word.
replacingCallbackIReplacingCallbackRead/WriteThe user-defined method which is called before every replace occurrence.
useLegacyOrderbooleanRead/WriteTrue indicates that a text search is performed sequentially from top to bottom considering the text boxes.
ignoreDeletedbooleanRead/WriteGets or sets a boolean value indicating either to ignore text inside delete revisions.
ignoreInsertedbooleanRead/WriteGets or sets a boolean value indicating either to ignore text inside insert revisions.
ignoreFieldsbooleanRead/WriteGets or sets a boolean value indicating either to ignore text inside fields.
ignoreFieldCodesbooleanRead/WriteGets or sets a boolean value indicating either to ignore text inside field codes.
ignoreFootnotesbooleanRead/WriteGets or sets a boolean value indicating either to ignore footnotes.
useSubstitutionsbooleanRead/WriteGets or sets a boolean value indicating whether to recognize and use substitutions within replacement patterns.
legacyModebooleanRead/WriteGets or sets a boolean value indicating that old find/replace algorithm is used.
ignoreStructuredDocumentTagsbooleanRead/WriteGets or sets a boolean value indicating either to ignore content of StructuredDocumentTag.
smartParagraphBreakReplacementbooleanRead/WriteGets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph.
ignoreShapesbooleanRead/WriteGets or sets a boolean value indicating either to ignore shapes within a text.
ignoreOfficeMathbooleanRead/WriteGets or sets a boolean value indicating either to ignore text inside OfficeMath/>.

Methods

SignatureDescription
FindReplaceOptions()Initializes a new instance of the FindReplaceOptions class with default settings.
FindReplaceOptions(direction: int)Initializes a new instance of the FindReplaceOptions class with the specified direction.
FindReplaceOptions(replacingCallback: IReplacingCallback)Initializes a new instance of the FindReplaceOptions class with the specified replacing callback.
FindReplaceOptions(direction: int, replacingCallback: IReplacingCallback)Initializes a new instance of the FindReplaceOptions class with the specified direction and replacing callback.
getApplyFont() → FontText formatting applied to new content.
getApplyParagraphFormat() → ParagraphFormatParagraph formatting applied to new content.
getDirection() → intSelects direction for replace.
setDirection(value: int)Sets the direction value.
getMatchCase() → booleanTrue indicates case-sensitive comparison, false indicates case-insensitive comparison.
setMatchCase(value: boolean)Sets the match case value.
getFindWholeWordsOnly() → booleanTrue indicates the oldValue must be a standalone word.
setFindWholeWordsOnly(value: boolean)Sets the find whole words only value.
getReplacingCallback() → IReplacingCallbackThe user-defined method which is called before every replace occurrence.
setReplacingCallback(value: IReplacingCallback)Sets the replacing callback value.
getUseLegacyOrder() → booleanTrue indicates that a text search is performed sequentially from top to bottom considering the text boxes.
setUseLegacyOrder(value: boolean)Sets the use legacy order value.
getIgnoreDeleted() → booleanGets or sets a boolean value indicating either to ignore text inside delete revisions.
setIgnoreDeleted(value: boolean)Sets the ignore deleted value.
getIgnoreInserted() → booleanGets or sets a boolean value indicating either to ignore text inside insert revisions.
setIgnoreInserted(value: boolean)Sets the ignore inserted value.
getIgnoreFields() → booleanGets or sets a boolean value indicating either to ignore text inside fields.
setIgnoreFields(value: boolean)Sets the ignore fields value.
getIgnoreFieldCodes() → booleanGets or sets a boolean value indicating either to ignore text inside field codes.
setIgnoreFieldCodes(value: boolean)Sets the ignore field codes value.
getIgnoreFootnotes() → booleanGets or sets a boolean value indicating either to ignore footnotes.
setIgnoreFootnotes(value: boolean)Sets the ignore footnotes value.
getUseSubstitutions() → booleanGets or sets a boolean value indicating whether to recognize and use substitutions within replacement patterns.
setUseSubstitutions(value: boolean)Sets the use substitutions value.
getLegacyMode() → booleanGets or sets a boolean value indicating that old find/replace algorithm is used.
setLegacyMode(value: boolean)Sets the legacy mode value.
getIgnoreStructuredDocumentTags() → booleanGets or sets a boolean value indicating either to ignore content of StructuredDocumentTag.
setIgnoreStructuredDocumentTags(value: boolean)Sets the ignore structured document tags value.
getSmartParagraphBreakReplacement() → booleanGets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph.
setSmartParagraphBreakReplacement(value: boolean)Sets the smart paragraph break replacement value.
getIgnoreShapes() → booleanGets or sets a boolean value indicating either to ignore shapes within a text.
setIgnoreShapes(value: boolean)Sets the ignore shapes value.
getIgnoreOfficeMath() → booleanGets or sets a boolean value indicating either to ignore text inside OfficeMath/>.
setIgnoreOfficeMath(value: boolean)Sets the ignore office math value.

See Also