Class Replacer

Class Replacer

Namespace: Aspose.Words.LowCode
Assembly: Aspose.Words.dll (25.4.0)

Provides methods intended to find and replace text in the document.

public class Replacer : Processor

Inheritance

object Processor Replacer

Inherited Members

Processor.mResultDocument , Processor.From(string, LoadOptions) , Processor.From(Stream, LoadOptions) , Processor.To(string, SaveOptions) , Processor.To(string, SaveFormat) , Processor.To(Stream, SaveOptions) , Processor.To(Stream, SaveFormat) , Processor.To(List<stream>, SaveOptions) , Processor.To(List<stream>, SaveFormat) , Processor.Execute() , Processor.ExecuteCore() , Processor.CheckArgumentsSet() , Processor.GetPartFileName(string, int, SaveFormat) , object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Methods

CheckArgumentsSet()

protected override void CheckArgumentsSet()

Create(ReplacerContext)

Creates new instance of the replacer processor.

public static Replacer Create(ReplacerContext context)

Parameters

context ReplacerContext

Returns

Replacer

ExecuteCore()

protected override void ExecuteCore()

Replace(string, string, string, string)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file.

public static int Replace(string inputFileName, string outputFileName, string pattern, string replacement)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

pattern string

A string to be replaced.

replacement string

A string to replace all occurrences of pattern.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Replace(string, string, SaveFormat, string, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file, with the specified save format and additional options.

public static int Replace(string inputFileName, string outputFileName, SaveFormat saveFormat, string pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The save format.

pattern string

A string to be replaced.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Replace(string, string, SaveOptions, string, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file, with the specified save format and additional options.

public static int Replace(string inputFileName, string outputFileName, SaveOptions saveOptions, string pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveOptions SaveOptions

The save options.

pattern string

A string to be replaced.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Replace(Stream, Stream, SaveFormat, string, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input stream, with the specified save format and additional options.

public static int Replace(Stream inputStream, Stream outputStream, SaveFormat saveFormat, string pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputStream Stream

The input stream.

outputStream Stream

The output stream.

saveFormat SaveFormat

The save format.

pattern string

A string to be replaced.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.

Replace(Stream, Stream, SaveOptions, string, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input stream, with the specified save format and additional options.

public static int Replace(Stream inputStream, Stream outputStream, SaveOptions saveOptions, string pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputStream Stream

The input stream.

outputStream Stream

The output stream.

saveOptions SaveOptions

The save options.

pattern string

A string to be replaced.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.

Replace(string, string, Regex, string)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file using a regular expression.

public static int Replace(string inputFileName, string outputFileName, Regex pattern, string replacement)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

pattern Regex

A regular expression pattern used to find matches.

replacement string

A string to replace all occurrences of pattern.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Replace(string, string, SaveFormat, Regex, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file using a regular expression, with the specified save format and additional options.

public static int Replace(string inputFileName, string outputFileName, SaveFormat saveFormat, Regex pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The save format.

pattern Regex

A regular expression pattern used to find matches.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Replace(string, string, SaveOptions, Regex, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file using a regular expression, with the specified save format and additional options.

public static int Replace(string inputFileName, string outputFileName, SaveOptions saveOptions, Regex pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveOptions SaveOptions

The save options.

pattern Regex

A regular expression pattern used to find matches.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Replace(Stream, Stream, SaveFormat, Regex, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input stream using a regular expression, with the specified save format and additional options.

public static int Replace(Stream inputStream, Stream outputStream, SaveFormat saveFormat, Regex pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputStream Stream

The input stream.

outputStream Stream

The output stream.

saveFormat SaveFormat

The save format.

pattern Regex

A regular expression pattern used to find matches.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.

Replace(Stream, Stream, SaveOptions, Regex, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input stream using a regular expression, with the specified save format and additional options.

public static int Replace(Stream inputStream, Stream outputStream, SaveOptions saveOptions, Regex pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputStream Stream

The input stream.

outputStream Stream

The output stream.

saveOptions SaveOptions

The save options.

pattern Regex

A regular expression pattern used to find matches.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

int

The number of replacements made.

Remarks

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.

ReplaceToImages(string, ImageSaveOptions, string, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file. Renders output to images.

public static Stream[] ReplaceToImages(string inputFileName, ImageSaveOptions saveOptions, string pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputFileName string

The input file name.

saveOptions ImageSaveOptions

The save options.

pattern string

A string to be replaced.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

Stream []

ReplaceToImages(Stream, ImageSaveOptions, string, string, FindReplaceOptions)

Replaces all occurrences of a specified character string pattern with a replacement string in the input file. Renders output to images.

public static Stream[] ReplaceToImages(Stream inputStream, ImageSaveOptions saveOptions, string pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputStream Stream

The input file stream.

saveOptions ImageSaveOptions

The save options.

pattern string

A string to be replaced.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

Stream []

ReplaceToImages(string, ImageSaveOptions, Regex, string, FindReplaceOptions)

Replaces all occurrences of a specified regular expression pattern with a replacement string in the input file. Renders output to images.

public static Stream[] ReplaceToImages(string inputFileName, ImageSaveOptions saveOptions, Regex pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputFileName string

The input file name.

saveOptions ImageSaveOptions

The save options.

pattern Regex

A regular expression pattern used to find matches.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

Stream []

ReplaceToImages(Stream, ImageSaveOptions, Regex, string, FindReplaceOptions)

Replaces all occurrences of a specified regular expression pattern with a replacement string in the input file. Renders output to images.

public static Stream[] ReplaceToImages(Stream inputStream, ImageSaveOptions saveOptions, Regex pattern, string replacement, FindReplaceOptions options = null)

Parameters

inputStream Stream

The input file stream.

saveOptions ImageSaveOptions

The save options.

pattern Regex

A regular expression pattern used to find matches.

replacement string

A string to replace all occurrences of pattern.

options FindReplaceOptions

Aspose.Words.Replacing.FindReplaceOptions object to specify additional options.

Returns

Stream [] </stream></stream>

 English