com.aspose.words

Class Replacer

java.lang.Object

com.aspose.words.Processor

com.aspose.words.Replacer

public class Replacer
extends Processor

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

Field Summary

Fields inherited from class com.aspose.words.Processor

mResultDocument

Method Summary

Modifier and Type	Method and Description
protected void	checkArgumentsSet()
static Replacer	create(ReplacerContext context) Creates new instance of the replacer processor.
protected void	executeCore()
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.util.regex.Pattern pattern, java.lang.String replacement)
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.util.regex.Pattern pattern, java.lang.String replacement, FindReplaceOptions options)
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.String pattern, java.lang.String replacement)
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.String pattern, java.lang.String replacement, FindReplaceOptions options)
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement)
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement, FindReplaceOptions options)
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement)
static int	replace(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement, FindReplaceOptions options)
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.util.regex.Pattern pattern, java.lang.String replacement)
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.util.regex.Pattern pattern, java.lang.String replacement, FindReplaceOptions options)
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.String pattern, java.lang.String replacement)
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.String pattern, java.lang.String replacement, FindReplaceOptions options)
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, java.util.regex.Pattern pattern, java.lang.String replacement) Replaces all occurrences of a specified character string pattern with a replacement string in the input file using a regular expression.
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement)
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement, FindReplaceOptions options) 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.
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement)
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement, FindReplaceOptions options) 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.
static int	replace(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.String pattern, java.lang.String replacement) Replaces all occurrences of a specified character string pattern with a replacement string in the input file.
static java.io.OutputStream[]	replaceToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement)
static java.io.OutputStream[]	replaceToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement, FindReplaceOptions options) Replaces all occurrences of a specified regular expression pattern with a replacement string in the input file.
static java.io.OutputStream[]	replaceToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement)
static java.io.OutputStream[]	replaceToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement, FindReplaceOptions options) Replaces all occurrences of a specified character string pattern with a replacement string in the input file.
static java.io.OutputStream[]	replaceToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement)
static java.io.OutputStream[]	replaceToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.util.regex.Pattern pattern, java.lang.String replacement, FindReplaceOptions options) Replaces all occurrences of a specified regular expression pattern with a replacement string in the input file.
static java.io.OutputStream[]	replaceToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement)
static java.io.OutputStream[]	replaceToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.lang.String pattern, java.lang.String replacement, FindReplaceOptions options) Replaces all occurrences of a specified character string pattern with a replacement string in the input file.

Methods inherited from class com.aspose.words.Processor

execute, from, from, from, from, getPartFileName, to, to, to, to, to, to, to, toOutput, toOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Replacer create(ReplacerContext context)

Creates new instance of the replacer processor.

Examples:

Shows how to replace string with regex in the document using context.

 
 // There is a several ways to replace string with regex in the document:
 String doc = getMyDir() + "Footer.docx";
 Pattern pattern = Pattern.compile("gr(a|e)y");
 String replacement = "lavender";

 ReplacerContext replacerContext = new ReplacerContext();
 replacerContext.setReplacement(pattern, replacement);
 replacerContext.getFindReplaceOptions().setFindWholeWordsOnly(false);

 Replacer.create(replacerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ReplaceContextRegex.docx")
         .execute();
 
 

Shows how to replace string in the document using context.

 
 // There is a several ways to replace string in the document:
 String doc = getMyDir() + "Footer.docx";
 String pattern = "(C)2006 Aspose Pty Ltd.";
 String replacement = "Copyright (C) 2024 by Aspose Pty Ltd.";

 ReplacerContext replacerContext = new ReplacerContext();
 replacerContext.setReplacement(pattern, replacement);
 replacerContext.getFindReplaceOptions().setFindWholeWordsOnly(false);

 Replacer.create(replacerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ReplaceContext.docx")
         .execute();
 
 

Shows how to replace string with regex in the document using documents from the stream using context.

 
 // There is a several ways to replace string with regex in the document using documents from the stream:
 Pattern pattern = Pattern.compile("gr(a|e)y");
 String replacement = "lavender";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Replace regex.docx")) {
     ReplacerContext replacerContext = new ReplacerContext();
     replacerContext.setReplacement(pattern, replacement);
     replacerContext.getFindReplaceOptions().setFindWholeWordsOnly(false);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.ReplaceContextStreamRegex.docx")) {
         Replacer.create(replacerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

Shows how to replace string in the document using documents from the stream using context.

 
 // There is a several ways to replace string in the document using documents from the stream:
 String pattern = "(C)2006 Aspose Pty Ltd.";
 String replacement = "Copyright (C) 2024 by Aspose Pty Ltd.";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Footer.docx")) {
     ReplacerContext replacerContext = new ReplacerContext();
     replacerContext.setReplacement(pattern, replacement);
     replacerContext.getFindReplaceOptions().setFindWholeWordsOnly(false);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.ReplaceContextStream.docx")) {
         Replacer.create(replacerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

executeCore

protected void executeCore()
                    throws java.lang.Exception

Overrides:

executeCore in class Processor

Throws:

java.lang.Exception

checkArgumentsSet

protected void checkArgumentsSet()

Overrides:

checkArgumentsSet in class Processor

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          java.lang.String pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

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

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.

Examples:

Shows how to replace string in the document.

 
 // There is a several ways to replace string in the document:
 String doc = getMyDir() + "Footer.docx";
 String pattern = "(C)2006 Aspose Pty Ltd.";
 String replacement = "Copyright (C) 2024 by Aspose Pty Ltd.";

 FindReplaceOptions options = new FindReplaceOptions();
 options.setFindWholeWordsOnly(false);
 Replacer.replace(doc, getArtifactsDir() + "LowCode.Replace.1.docx", pattern, replacement);
 Replacer.replace(doc, getArtifactsDir() + "LowCode.Replace.2.docx", SaveFormat.DOCX, pattern, replacement);
 Replacer.replace(doc, getArtifactsDir() + "LowCode.Replace.3.docx", SaveFormat.DOCX, pattern, replacement, options);
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

pattern - A string to be replaced.

replacement - A string to replace all occurrences of pattern.

Returns:

The number of replacements made.

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          int saveFormat,
                          java.lang.String pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          int saveFormat,
                          java.lang.String pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          SaveOptions saveOptions,
                          java.lang.String pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          SaveOptions saveOptions,
                          java.lang.String pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

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.

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.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The save options.

pattern - A string to be replaced.

replacement - A string to replace all occurrences of pattern.

options - FindReplaceOptions object to specify additional options.

Returns:

The number of replacements made.

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          int saveFormat,
                          java.lang.String pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          int saveFormat,
                          java.lang.String pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          SaveOptions saveOptions,
                          java.lang.String pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          SaveOptions saveOptions,
                          java.lang.String pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

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

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.

Examples:

Shows how to replace string with regex in the document.

 
 // There is a several ways to replace string with regex in the document:
 String doc = getMyDir() + "Footer.docx";
 String pattern = "gr(a|e)y";
 String replacement = "lavender";

 Replacer.replace(doc, getArtifactsDir() + "LowCode.ReplaceRegex.1.docx", pattern, replacement);
 Replacer.replace(doc, getArtifactsDir() + "LowCode.ReplaceRegex.2.docx", SaveFormat.DOCX, pattern, replacement);
 FindReplaceOptions options = new FindReplaceOptions();
 options.setFindWholeWordsOnly(false);
 Replacer.replace(doc, getArtifactsDir() + "LowCode.ReplaceRegex.3.docx", SaveFormat.DOCX, pattern, replacement, options);
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

pattern - A regular expression pattern used to find matches.

replacement - A string to replace all occurrences of pattern.

Returns:

The number of replacements made.

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          int saveFormat,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          int saveFormat,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          SaveOptions saveOptions,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.lang.String inputFileName,
                          java.lang.String outputFileName,
                          SaveOptions saveOptions,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

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.

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.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The save options.

pattern - A regular expression pattern used to find matches.

replacement - A string to replace all occurrences of pattern.

options - FindReplaceOptions object to specify additional options.

Returns:

The number of replacements made.

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          int saveFormat,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          int saveFormat,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          SaveOptions saveOptions,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replace

public static int replace(java.io.InputStream inputStream,
                          java.io.OutputStream outputStream,
                          SaveOptions saveOptions,
                          java.util.regex.Pattern pattern,
                          java.lang.String replacement,
                          FindReplaceOptions options)
                   throws java.lang.Exception

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String pattern,
                                                     java.lang.String replacement)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String pattern,
                                                     java.lang.String replacement,
                                                     FindReplaceOptions options)
                                              throws java.lang.Exception

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

Examples:

Shows how to replace string in the document and save result to images.

 
 // There is a several ways to replace string in the document:
 String doc = getMyDir() + "Footer.docx";
 String pattern = "(C)2006 Aspose Pty Ltd.";
 String replacement = "Copyright (C) 2024 by Aspose Pty Ltd.";

 OutputStream[] images = Replacer.replaceToImages(doc, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement);

 FindReplaceOptions options = new FindReplaceOptions();
 options.setFindWholeWordsOnly(false);
 images = Replacer.replaceToImages(doc, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement, options);
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The save options.

pattern - A string to be replaced.

replacement - A string to replace all occurrences of pattern.

options - FindReplaceOptions object to specify additional options.

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String pattern,
                                                     java.lang.String replacement)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     java.lang.String pattern,
                                                     java.lang.String replacement,
                                                     FindReplaceOptions options)
                                              throws java.lang.Exception

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

Examples:

Shows how to replace string in the document using documents from the stream and save result to images.

 
 // There is a several ways to replace string in the document using documents from the stream:
 String pattern = "(C)2006 Aspose Pty Ltd.";
 String replacement = "Copyright (C) 2024 by Aspose Pty Ltd.";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Footer.docx")) {
     OutputStream[] images = Replacer.replaceToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement);

     FindReplaceOptions options = new FindReplaceOptions();
     options.setFindWholeWordsOnly(false);
     images = Replacer.replaceToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement, options);
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The save options.

pattern - A string to be replaced.

replacement - A string to replace all occurrences of pattern.

options - FindReplaceOptions object to specify additional options.

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     java.util.regex.Pattern pattern,
                                                     java.lang.String replacement)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.lang.String inputFileName,
                                                     ImageSaveOptions saveOptions,
                                                     java.util.regex.Pattern pattern,
                                                     java.lang.String replacement,
                                                     FindReplaceOptions options)
                                              throws java.lang.Exception

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

Examples:

Shows how to replace string with regex in the document and save result to images.

 
 // There is a several ways to replace string with regex in the document:
 String doc = getMyDir() + "Footer.docx";
 Pattern pattern = Pattern.compile("gr(a|e)y");
 String replacement = "lavender";

 OutputStream[] images = Replacer.replaceToImages(doc, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement);
 FindReplaceOptions options = new FindReplaceOptions();
 options.setFindWholeWordsOnly(false);
 images = Replacer.replaceToImages(doc, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement, options);
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The save options.

pattern - A regular expression pattern used to find matches.

replacement - A string to replace all occurrences of pattern.

options - FindReplaceOptions object to specify additional options.

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     java.util.regex.Pattern pattern,
                                                     java.lang.String replacement)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

replaceToImages

public static java.io.OutputStream[] replaceToImages(java.io.InputStream inputStream,
                                                     ImageSaveOptions saveOptions,
                                                     java.util.regex.Pattern pattern,
                                                     java.lang.String replacement,
                                                     FindReplaceOptions options)
                                              throws java.lang.Exception

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

Examples:

Shows how to replace string with regex in the document using documents from the stream and save result to images.

 
 // There is a several ways to replace string with regex in the document using documents from the stream:
 Pattern pattern = Pattern.compile("gr(a|e)y");
 String replacement = "lavender";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Replace regex.docx")) {
     OutputStream[] images = Replacer.replaceToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement);
     FindReplaceOptions options = new FindReplaceOptions();
     options.setFindWholeWordsOnly(false);
     images = Replacer.replaceToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), pattern, replacement, options);
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The save options.

pattern - A regular expression pattern used to find matches.

replacement - A string to replace all occurrences of pattern.

options - FindReplaceOptions object to specify additional options.

Throws:

java.lang.Exception