Macro Reference — Selection Object — Replace Method (Selection Object)

# Replace Method (Selection Object)

Replaces a string in the document.

##

### [JavaScript]

    nFound = document.selection.Replace( strFind, strReplace, nFlags[, nExFlags] );

### [VBScript]

    nFound = document.selection.Replace( strFind, strReplace, nFlags[, nExFlags] )

## Parameters

strFind

Specifies a string to search for. If eeExFindNumberRange is specified, this string is a number range in interval notation.

strReplace

Specifies a string to replace with.

nFlags

Specifies a combination of the following values:

eeFindAround | Moves to the start of the document when reaches the end of the document.
eeFindExtract | If eeExFindInsertColumn is not specified in nExFlags, this method extracts find results to a new document using a regular expression. eeFindReplaceRegExp must be specified in nFlags, and strReplace must not be empty. If eeExFindInsertColumn is specified in nExFlags, a CSV document must be active, and one or more columns must be selected. Moreover, if eeFindReplaceRegExp is not specified in nFlags, the method inserts a new column with the matched strings. if eeFindReplaceRegExp is specified in nFlags, the method inserts a new column with the replacement expressions using a regular expression.
eeFindMatchDotNL | The regular expression "." can match newline characters.
eeFindOutput | Displays the extract results as a list in the Output Bar. Must combine with eeFindExtract.
eeFindReplaceCase | Matches cases.
eeFindReplaceEmbeddedNL | Matches embedded newlines in CSV documents and does not match other newlines.
eeFindReplaceEscSeq | Uses escape sequences. Cannot be combined with eeFindReplaceRegExp or eeExFindNumberRange.
eeFindReplaceOnlyWord | Matches only whole words.
eeFindReplaceOpenDoc | Searches all open documents in the same frame window.
eeFindReplaceQuiet | Does not display a message on the status bar if no string is found.
eeFindReplaceRegExp | Uses a regular expression for strFind. Cannot be combined with eeFindReplaceEscSeq or eeExFindNumberRange. If this flag is combined with eeFindExtract, the resulting matches will be replaced with strReplace.
eeFindReplaceSelOnly | Replaces only in the selection.
eeFindSaveHistory | Saves the searched string for repeated search.
eeReplaceAll | Replaces all at once.
eeReplaceSelOnly | Replaces only in the selection. (same as eeFindReplaceSelOnly)

nExFlags

Specifies a combination of the following values. However, only one of eeExFindRegexBoost, eeExFindRegexOnigmo, and eeExFindRegexOnigmoPerl can be specified. If none of them is specified, the default regular expression engine is used.

eeExFindBOL | The regular expression ‘^’ can match the beginning of the selection.
eeExFindEOL | The regular expression ‘$’ can match the end of the selection.
eeExFindFuzzy | Uses fuzzy matching.
eeExFindInsertColumn | Creates a new CSV column for extracted columns. eeFindExtract must be specified in nFlags. The new column is inserted just to the right of the original.
eeExFindLookaround | Looks around during selection only regular-expression searches.
eeExFindNumberRange | Matches a number range expression. This flag cannot be combined with eeFindReplaceEscSeq or eeFindReplaceRegExp.
eeExFindRegexBoost | Uses Boost.Regex as the regular expression engine. Cannot be combined with eeExFindRegexOnigmo.
eeExFindRegexOnigmo | Uses Onigmo as the regular expression engine, using the Ruby syntax.
eeExFindRegexOnigmoPerl | Uses Onigmo as the regular expression engine, using the Perl syntax.
eeExFindSeparateCRLF | Treats CR and LF separately.

## Return Values

Returns the number of replaced strings if eeReplaceAll or eeFindExtract is specified. Otherwise, returns 1 if a matching string was found, or 0 if it was not found.

## Version

Supported on EmEditor Professional Version 4.00 or later.