replace_regex method

replace_regex(pattern, replacement)

Replaces all occurrences of a character pattern specified by a regular expression with another string.

def replace_regex(self, pattern: str, replacement: str):
    ...
ParameterTypeDescription
patternstrA regular expression pattern used to find matches.
replacementstrA string to replace all occurrences of pattern.

Remarks

Replaces the whole match captured by the regular expression.

Method is able to process breaks in both pattern and replacement strings.

You should use special meta-characters if you need to work with breaks:

  • &p - paragraph break

  • &b - section break

  • &m - page break

  • &l - manual line break

Use methodRange.replace_regex() to have more flexible customization.

Returns

The number of replacements made.

replace_regex(pattern, replacement, options)

Replaces all occurrences of a character pattern specified by a regular expression with another string.

def replace_regex(self, pattern: str, replacement: str, options: aspose.words.replacing.FindReplaceOptions):
    ...
ParameterTypeDescription
patternstrA regular expression pattern used to find matches.
replacementstrA string to replace all occurrences of pattern.
optionsFindReplaceOptionsFindReplaceOptions object to specify additional options.

Remarks

Replaces the whole match captured by the regular expression.

Method is able to process breaks in both pattern and replacement strings.

You should use special meta-characters if you need to work with breaks:

  • &p - paragraph break

  • &b - section break

  • &m - page break

  • &l - manual line break

  • && - & character

Returns

The number of replacements made.

See Also