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
| Name | Type | Access | Description |
|---|---|---|---|
applyFont | Font | Read | Text formatting applied to new content. |
applyParagraphFormat | ParagraphFormat | Read | Paragraph formatting applied to new content. |
direction | int | Read/Write | Selects direction for replace. |
matchCase | boolean | Read/Write | True indicates case-sensitive comparison, false indicates case-insensitive comparison. |
findWholeWordsOnly | boolean | Read/Write | True indicates the oldValue must be a standalone word. |
replacingCallback | IReplacingCallback | Read/Write | The user-defined method which is called before every replace occurrence. |
useLegacyOrder | boolean | Read/Write | True indicates that a text search is performed sequentially from top to bottom considering the text boxes. |
ignoreDeleted | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore text inside delete revisions. |
ignoreInserted | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore text inside insert revisions. |
ignoreFields | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore text inside fields. |
ignoreFieldCodes | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore text inside field codes. |
ignoreFootnotes | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore footnotes. |
useSubstitutions | boolean | Read/Write | Gets or sets a boolean value indicating whether to recognize and use substitutions within replacement patterns. |
legacyMode | boolean | Read/Write | Gets or sets a boolean value indicating that old find/replace algorithm is used. |
ignoreStructuredDocumentTags | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore content of StructuredDocumentTag. |
smartParagraphBreakReplacement | boolean | Read/Write | Gets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph. |
ignoreShapes | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore shapes within a text. |
ignoreOfficeMath | boolean | Read/Write | Gets or sets a boolean value indicating either to ignore text inside OfficeMath/>. |
Methods
| Signature | Description |
|---|---|
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() → Font | Text formatting applied to new content. |
getApplyParagraphFormat() → ParagraphFormat | Paragraph formatting applied to new content. |
getDirection() → int | Selects direction for replace. |
setDirection(value: int) | Sets the direction value. |
getMatchCase() → boolean | True indicates case-sensitive comparison, false indicates case-insensitive comparison. |
setMatchCase(value: boolean) | Sets the match case value. |
getFindWholeWordsOnly() → boolean | True indicates the oldValue must be a standalone word. |
setFindWholeWordsOnly(value: boolean) | Sets the find whole words only value. |
getReplacingCallback() → IReplacingCallback | The user-defined method which is called before every replace occurrence. |
setReplacingCallback(value: IReplacingCallback) | Sets the replacing callback value. |
getUseLegacyOrder() → boolean | True 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() → boolean | Gets or sets a boolean value indicating either to ignore text inside delete revisions. |
setIgnoreDeleted(value: boolean) | Sets the ignore deleted value. |
getIgnoreInserted() → boolean | Gets or sets a boolean value indicating either to ignore text inside insert revisions. |
setIgnoreInserted(value: boolean) | Sets the ignore inserted value. |
getIgnoreFields() → boolean | Gets or sets a boolean value indicating either to ignore text inside fields. |
setIgnoreFields(value: boolean) | Sets the ignore fields value. |
getIgnoreFieldCodes() → boolean | Gets or sets a boolean value indicating either to ignore text inside field codes. |
setIgnoreFieldCodes(value: boolean) | Sets the ignore field codes value. |
getIgnoreFootnotes() → boolean | Gets or sets a boolean value indicating either to ignore footnotes. |
setIgnoreFootnotes(value: boolean) | Sets the ignore footnotes value. |
getUseSubstitutions() → boolean | Gets or sets a boolean value indicating whether to recognize and use substitutions within replacement patterns. |
setUseSubstitutions(value: boolean) | Sets the use substitutions value. |
getLegacyMode() → boolean | Gets or sets a boolean value indicating that old find/replace algorithm is used. |
setLegacyMode(value: boolean) | Sets the legacy mode value. |
getIgnoreStructuredDocumentTags() → boolean | Gets or sets a boolean value indicating either to ignore content of StructuredDocumentTag. |
setIgnoreStructuredDocumentTags(value: boolean) | Sets the ignore structured document tags value. |
getSmartParagraphBreakReplacement() → boolean | Gets 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() → boolean | Gets or sets a boolean value indicating either to ignore shapes within a text. |
setIgnoreShapes(value: boolean) | Sets the ignore shapes value. |
getIgnoreOfficeMath() → boolean | Gets or sets a boolean value indicating either to ignore text inside OfficeMath/>. |
setIgnoreOfficeMath(value: boolean) | Sets the ignore office math value. |