FindReplaceOptions (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.FindReplaceOptions

```
public class FindReplaceOptions
extends java.lang.Object
```
Specifies options for find/replace operations.
To learn more, visit the Find and Replace documentation article.

Constructor Summary

Constructors
Constructor and Description
`FindReplaceOptions()` Initializes a new instance of this class.
`FindReplaceOptions(int direction)` Initializes a new instance of this class.
`FindReplaceOptions(int direction, IReplacingCallback replacingCallback)` Initializes a new instance of this class.
`FindReplaceOptions(IReplacingCallback replacingCallback)` Initializes a new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Font`	`getApplyFont()` Text formatting applied to new content.
`ParagraphFormat`	`getApplyParagraphFormat()` Paragraph formatting applied to new content.
`int`	`getDirection()` Selects direction for replace.
`boolean`	`getFindWholeWordsOnly()` True indicates the oldValue must be a standalone word.
`boolean`	`getIgnoreDeleted()` Gets a boolean value indicating either to ignore text inside delete revisions.
`boolean`	`getIgnoreFieldCodes()` Gets a boolean value indicating either to ignore text inside field codes.
`boolean`	`getIgnoreFields()` Gets a boolean value indicating either to ignore text inside fields.
`boolean`	`getIgnoreFootnotes()` Gets a boolean value indicating either to ignore footnotes.
`boolean`	`getIgnoreInserted()` Gets a boolean value indicating either to ignore text inside insert revisions.
`boolean`	`getIgnoreStructuredDocumentTags()` Gets a boolean value indicating either to ignore content of `StructuredDocumentTag`.
`boolean`	`getLegacyMode()` Gets a boolean value indicating that old find/replace algorithm is used.
`boolean`	`getMatchCase()` True indicates case-sensitive comparison, false indicates case-insensitive comparison.
`IReplacingCallback`	`getReplacingCallback()` The user-defined method which is called before every replace occurrence.
`boolean`	`getSmartParagraphBreakReplacement()` Gets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph.
`boolean`	`getUseLegacyOrder()` True indicates that a text search is performed sequentially from top to bottom considering the text boxes.
`boolean`	`getUseSubstitutions()` Gets a boolean value indicating whether to recognize and use substitutions within replacement patterns.
`void`	`setDirection(int value)` Selects direction for replace.
`void`	`setFindWholeWordsOnly(boolean value)` True indicates the oldValue must be a standalone word.
`void`	`setIgnoreDeleted(boolean value)` Sets a boolean value indicating either to ignore text inside delete revisions.
`void`	`setIgnoreFieldCodes(boolean value)` Sets a boolean value indicating either to ignore text inside field codes.
`void`	`setIgnoreFields(boolean value)` Sets a boolean value indicating either to ignore text inside fields.
`void`	`setIgnoreFootnotes(boolean value)` Sets a boolean value indicating either to ignore footnotes.
`void`	`setIgnoreInserted(boolean value)` Sets a boolean value indicating either to ignore text inside insert revisions.
`void`	`setIgnoreStructuredDocumentTags(boolean value)` Sets a boolean value indicating either to ignore content of `StructuredDocumentTag`.
`void`	`setLegacyMode(boolean value)` Sets a boolean value indicating that old find/replace algorithm is used.
`void`	`setMatchCase(boolean value)` True indicates case-sensitive comparison, false indicates case-insensitive comparison.
`void`	`setReplacingCallback(IReplacingCallback value)` The user-defined method which is called before every replace occurrence.
`void`	`setSmartParagraphBreakReplacement(boolean value)` Gets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph.
`void`	`setUseLegacyOrder(boolean value)` True indicates that a text search is performed sequentially from top to bottom considering the text boxes.
`void`	`setUseSubstitutions(boolean value)` Sets a boolean value indicating whether to recognize and use substitutions within replacement patterns.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FindReplaceOptions
```
public FindReplaceOptions()
```
    Initializes a new instance of this class.
  - FindReplaceOptions
```
public FindReplaceOptions(int direction)
```
    Initializes a new instance of this class.
  - FindReplaceOptions
```
public FindReplaceOptions(IReplacingCallback replacingCallback)
```
    Initializes a new instance of this class.
  - FindReplaceOptions
```
public FindReplaceOptions(int direction,
                          IReplacingCallback replacingCallback)
```
    Initializes a new instance of this class.
- Method Detail
  - getApplyFont
```
public Font getApplyFont()
```
    Text formatting applied to new content.
    
    Returns:
    
    The corresponding Font value.
  - getApplyParagraphFormat
```
public ParagraphFormat getApplyParagraphFormat()
```
    Paragraph formatting applied to new content.
    
    Returns:
    
    The corresponding ParagraphFormat value.
  - getDirection
```
public int getDirection()
```
    Selects direction for replace. Default value is FindReplaceDirection.FORWARD.
    
    Returns:
    
    The corresponding int value. The returned value is one of FindReplaceDirection constants.
  - setDirection
```
public void setDirection(int value)
```
    Selects direction for replace. Default value is FindReplaceDirection.FORWARD.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of FindReplaceDirection constants.
  - getMatchCase
```
public boolean getMatchCase()
```
    True indicates case-sensitive comparison, false indicates case-insensitive comparison.
    
    Returns:
    
    The corresponding boolean value.
  - setMatchCase
```
public void setMatchCase(boolean value)
```
    True indicates case-sensitive comparison, false indicates case-insensitive comparison.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getFindWholeWordsOnly
```
public boolean getFindWholeWordsOnly()
```
    True indicates the oldValue must be a standalone word.
    
    Returns:
    
    The corresponding boolean value.
  - setFindWholeWordsOnly
```
public void setFindWholeWordsOnly(boolean value)
```
    True indicates the oldValue must be a standalone word.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getReplacingCallback
```
public IReplacingCallback getReplacingCallback()
```
    The user-defined method which is called before every replace occurrence.
    
    Returns:
    
    The corresponding IReplacingCallback value.
  - setReplacingCallback
```
public void setReplacingCallback(IReplacingCallback value)
```
    The user-defined method which is called before every replace occurrence.
    
    Parameters:
    
    value - The corresponding IReplacingCallback value.
  - getUseLegacyOrder
```
public boolean getUseLegacyOrder()
```
    True indicates that a text search is performed sequentially from top to bottom considering the text boxes. Default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setUseLegacyOrder
```
public void setUseLegacyOrder(boolean value)
```
    True indicates that a text search is performed sequentially from top to bottom considering the text boxes. Default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getIgnoreDeleted
```
public boolean getIgnoreDeleted()
```
    Gets a boolean value indicating either to ignore text inside delete revisions. The default value is false.
    
    Returns:
    
    A boolean value indicating either to ignore text inside delete revisions.
  - setIgnoreDeleted
```
public void setIgnoreDeleted(boolean value)
```
    Sets a boolean value indicating either to ignore text inside delete revisions. The default value is false.
    
    Parameters:
    
    value - A boolean value indicating either to ignore text inside delete revisions.
  - getIgnoreInserted
```
public boolean getIgnoreInserted()
```
    Gets a boolean value indicating either to ignore text inside insert revisions. The default value is false.
    
    Returns:
    
    A boolean value indicating either to ignore text inside insert revisions.
  - setIgnoreInserted
```
public void setIgnoreInserted(boolean value)
```
    Sets a boolean value indicating either to ignore text inside insert revisions. The default value is false.
    
    Parameters:
    
    value - A boolean value indicating either to ignore text inside insert revisions.
  - getIgnoreFields
```
public boolean getIgnoreFields()
```
    Gets a boolean value indicating either to ignore text inside fields. The default value is false.
    This option affects whole field (all nodes between NodeType.FIELD_START and NodeType.FIELD_END).
    
    To ignore only field codes, please use corresponding option getIgnoreFieldCodes() / setIgnoreFieldCodes(boolean).
    
    Returns:
    
    A boolean value indicating either to ignore text inside fields.
  - setIgnoreFields
```
public void setIgnoreFields(boolean value)
```
    Sets a boolean value indicating either to ignore text inside fields. The default value is false.
    This option affects whole field (all nodes between NodeType.FIELD_START and NodeType.FIELD_END).
    
    To ignore only field codes, please use corresponding option getIgnoreFieldCodes() / setIgnoreFieldCodes(boolean).
    
    Parameters:
    
    value - A boolean value indicating either to ignore text inside fields.
  - getIgnoreFieldCodes
```
public boolean getIgnoreFieldCodes()
```
    Gets a boolean value indicating either to ignore text inside field codes. The default value is false.
    This option affects only field codes (it does not ignore nodes between NodeType.FIELD_SEPARATOR and NodeType.FIELD_END).
    
    To ignore whole field, please use corresponding option getIgnoreFields() / setIgnoreFields(boolean).
    
    Returns:
    
    A boolean value indicating either to ignore text inside field codes.
  - setIgnoreFieldCodes
```
public void setIgnoreFieldCodes(boolean value)
```
    Sets a boolean value indicating either to ignore text inside field codes. The default value is false.
    This option affects only field codes (it does not ignore nodes between NodeType.FIELD_SEPARATOR and NodeType.FIELD_END).
    
    To ignore whole field, please use corresponding option getIgnoreFields() / setIgnoreFields(boolean).
    
    Parameters:
    
    value - A boolean value indicating either to ignore text inside field codes.
  - getIgnoreFootnotes
```
public boolean getIgnoreFootnotes()
```
    Gets a boolean value indicating either to ignore footnotes. The default value is false.
    
    Returns:
    
    A boolean value indicating either to ignore footnotes.
  - setIgnoreFootnotes
```
public void setIgnoreFootnotes(boolean value)
```
    Sets a boolean value indicating either to ignore footnotes. The default value is false.
    
    Parameters:
    
    value - A boolean value indicating either to ignore footnotes.
  - getUseSubstitutions
```
public boolean getUseSubstitutions()
```
    Gets a boolean value indicating whether to recognize and use substitutions within replacement patterns. The default value is false. For the details on substitution elements please refer to: https://docs.microsoft.com/en-us/dotnet/standard/base-types/substitutions-in-regular-expressions.
    
    Returns:
    
    A boolean value indicating whether to recognize and use substitutions within replacement patterns.
  - setUseSubstitutions
```
public void setUseSubstitutions(boolean value)
```
    Sets a boolean value indicating whether to recognize and use substitutions within replacement patterns. The default value is false. For the details on substitution elements please refer to: https://docs.microsoft.com/en-us/dotnet/standard/base-types/substitutions-in-regular-expressions.
    
    Parameters:
    
    value - A boolean value indicating whether to recognize and use substitutions within replacement patterns.
  - getLegacyMode
```
public boolean getLegacyMode()
```
    Gets a boolean value indicating that old find/replace algorithm is used. Use this flag if you need exactly the same behavior as before advanced find/replace feature was introduced. Note that old algorithm does not support advanced features such as replace with breaks, apply formatting and so on.
    
    Returns:
    
    A boolean value indicating that old find/replace algorithm is used.
  - setLegacyMode
```
public void setLegacyMode(boolean value)
```
    Sets a boolean value indicating that old find/replace algorithm is used. Use this flag if you need exactly the same behavior as before advanced find/replace feature was introduced. Note that old algorithm does not support advanced features such as replace with breaks, apply formatting and so on.
    
    Parameters:
    
    value - A boolean value indicating that old find/replace algorithm is used.
  - getIgnoreStructuredDocumentTags
```
public boolean getIgnoreStructuredDocumentTags()
```
    Gets a boolean value indicating either to ignore content of StructuredDocumentTag. The default value is false.
    When this option is set to true, the content of StructuredDocumentTag will be treated as a simple text.
    
    Otherwise, StructuredDocumentTag will be processed as standalone Story and replacing pattern will be searched separately for each StructuredDocumentTag, so that if pattern crosses a StructuredDocumentTag, then replacement will not be performed for such pattern.
    
    Returns:
    
    A boolean value indicating either to ignore content of StructuredDocumentTag.
  - setIgnoreStructuredDocumentTags
```
public void setIgnoreStructuredDocumentTags(boolean value)
```
    Sets a boolean value indicating either to ignore content of StructuredDocumentTag. The default value is false.
    When this option is set to true, the content of StructuredDocumentTag will be treated as a simple text.
    
    Otherwise, StructuredDocumentTag will be processed as standalone Story and replacing pattern will be searched separately for each StructuredDocumentTag, so that if pattern crosses a StructuredDocumentTag, then replacement will not be performed for such pattern.
    
    Parameters:
    
    value - A boolean value indicating either to ignore content of StructuredDocumentTag.
  - getSmartParagraphBreakReplacement
```
public boolean getSmartParagraphBreakReplacement()
```
    Gets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph.
    
    The default value is false.
    This option allows to replace paragraph break when there is no next sibling paragraph to which all child nodes can be moved, by finding any (not necessarily sibling) next paragraph after the paragraph being replaced.
    
    Returns:
    
    The corresponding boolean value.
  - setSmartParagraphBreakReplacement
```
public void setSmartParagraphBreakReplacement(boolean value)
```
    Gets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph.
    
    The default value is false.
    This option allows to replace paragraph break when there is no next sibling paragraph to which all child nodes can be moved, by finding any (not necessarily sibling) next paragraph after the paragraph being replaced.
    
    Parameters:
    
    value - The corresponding boolean value.

Class FindReplaceOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FindReplaceOptions

FindReplaceOptions

FindReplaceOptions

FindReplaceOptions

Method Detail

getApplyFont

getApplyParagraphFormat

getDirection

setDirection

getMatchCase

setMatchCase

getFindWholeWordsOnly

setFindWholeWordsOnly

getReplacingCallback

setReplacingCallback

getUseLegacyOrder

setUseLegacyOrder

getIgnoreDeleted

setIgnoreDeleted

getIgnoreInserted

setIgnoreInserted

getIgnoreFields

setIgnoreFields

getIgnoreFieldCodes

setIgnoreFieldCodes

getIgnoreFootnotes

setIgnoreFootnotes

getUseSubstitutions

setUseSubstitutions

getLegacyMode

setLegacyMode

getIgnoreStructuredDocumentTags

setIgnoreStructuredDocumentTags

getSmartParagraphBreakReplacement

setSmartParagraphBreakReplacement