FindReplaceOptions class

FindReplaceOptions class

Specifies options for find/replace operations. To learn more, visit the Find and Replace documentation article.

Constructors

Name	Description
FindReplaceOptions()	Initializes a new instance of the FindReplaceOptions class with default settings.
FindReplaceOptions(direction)	Initializes a new instance of the FindReplaceOptions class with the specified direction.
FindReplaceOptions(replacingCallback)	Initializes a new instance of the FindReplaceOptions class with the specified replacing callback.
FindReplaceOptions(direction, replacingCallback)	Initializes a new instance of the FindReplaceOptions class with the specified direction and replacing callback.

Properties

Name	Description
applyFont	Text formatting applied to new content.
applyParagraphFormat	Paragraph formatting applied to new content.
direction	Selects direction for replace. Default value is FindReplaceDirection.Forward.
findWholeWordsOnly	True indicates the oldValue must be a standalone word.
ignoreDeleted	Gets or sets a boolean value indicating either to ignore text inside delete revisions. The default value is false.
ignoreFieldCodes	Gets or sets a boolean value indicating either to ignore text inside field codes. The default value is false.
ignoreFields	Gets or sets a boolean value indicating either to ignore text inside fields. The default value is false.
ignoreFootnotes	Gets or sets a boolean value indicating either to ignore footnotes. The default value is false.
ignoreInserted	Gets or sets a boolean value indicating either to ignore text inside insert revisions. The default value is false.
ignoreOfficeMath	Gets or sets a boolean value indicating either to ignore text inside OfficeMath/>. The default value is true.
ignoreShapes	Gets or sets a boolean value indicating either to ignore shapes within a text.
ignoreStructuredDocumentTags	Gets or sets a boolean value indicating either to ignore content of StructuredDocumentTag. The default value is false.
legacyMode	Gets or sets a boolean value indicating that old find/replace algorithm is used.
matchCase	True indicates case-sensitive comparison, false indicates case-insensitive comparison.
replacementFormat	Specifies format of the replacement. Default is ReplacementFormat.Text.
replacingCallback	The user-defined method which is called before every replace occurrence.
smartParagraphBreakReplacement	Gets or sets a boolean value indicating either it is allowed to replace paragraph break when there is no next sibling paragraph.
useLegacyOrder	True indicates that a text search is performed sequentially from top to bottom considering the text boxes. Default value is false.
useSubstitutions	Gets or sets a boolean value indicating whether to recognize and use substitutions within replacement patterns. The default value is false.

Examples

Shows how to toggle case sensitivity when performing a find-and-replace operation.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

builder.writeln("Ruby bought a ruby necklace.");

// We can use a "FindReplaceOptions" object to modify the find-and-replace process.
let options = new aw.Replacing.FindReplaceOptions();

// Set the "MatchCase" flag to "true" to apply case sensitivity while finding strings to replace.
// Set the "MatchCase" flag to "false" to ignore character case while searching for text to replace.
options.matchCase = matchCase;

doc.range.replace("Ruby", "Jade", options);

expect(doc.getText().trim()).toEqual(matchCase ? "Jade bought a ruby necklace." : "Jade bought a Jade necklace.");

Shows how to toggle standalone word-only find-and-replace operations.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

builder.writeln("Jackson will meet you in Jacksonville.");

// We can use a "FindReplaceOptions" object to modify the find-and-replace process.
let options = new aw.Replacing.FindReplaceOptions();

// Set the "FindWholeWordsOnly" flag to "true" to replace the found text if it is not a part of another word.
// Set the "FindWholeWordsOnly" flag to "false" to replace all text regardless of its surroundings.
options.findWholeWordsOnly = findWholeWordsOnly;

doc.range.replace("Jackson", "Louis", options);

expect(doc.getText().trim()).toEqual(
  findWholeWordsOnly ? "Louis will meet you in Jacksonville." : "Louis will meet you in Louisville." );

See Also

• module Aspose.Words.Replacing