Replacer

Inheritance: java.lang.Object, com.aspose.words.Processor

public class Replacer extends Processor

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

Methods

Method	Description
create(ReplacerContext context)	Creates new instance of the replacer processor.
execute()	Execute the processor action.
from(InputStream input)
from(InputStream input, LoadOptions loadOptions)	Specifies input document for processing.
from(String input)
from(String input, LoadOptions loadOptions)	Specifies input document for processing.
replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String pattern, String replacement)
replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)
replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, Pattern pattern, String replacement)
replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)
replace(InputStream inputStream, OutputStream outputStream, int saveFormat, String pattern, String replacement)
replace(InputStream inputStream, OutputStream outputStream, int saveFormat, String pattern, String replacement, FindReplaceOptions options)
replace(InputStream inputStream, OutputStream outputStream, int saveFormat, Pattern pattern, String replacement)
replace(InputStream inputStream, OutputStream outputStream, int saveFormat, Pattern pattern, String replacement, FindReplaceOptions options)
replace(String inputFileName, String outputFileName, SaveOptions saveOptions, String pattern, String replacement)
replace(String inputFileName, String outputFileName, SaveOptions saveOptions, String pattern, 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.
replace(String inputFileName, String outputFileName, SaveOptions saveOptions, Pattern pattern, String replacement)
replace(String inputFileName, String outputFileName, SaveOptions saveOptions, Pattern pattern, 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.
replace(String inputFileName, String outputFileName, int saveFormat, String pattern, String replacement)
replace(String inputFileName, String outputFileName, int saveFormat, String pattern, String replacement, FindReplaceOptions options)
replace(String inputFileName, String outputFileName, int saveFormat, Pattern pattern, String replacement)
replace(String inputFileName, String outputFileName, int saveFormat, Pattern pattern, String replacement, FindReplaceOptions options)
replace(String inputFileName, String outputFileName, String pattern, String replacement)	Replaces all occurrences of a specified character string pattern with a replacement string in the input file.
replace(String inputFileName, String outputFileName, Pattern pattern, String replacement)	Replaces all occurrences of a specified character string pattern with a replacement string in the input file using a regular expression.
replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, String pattern, String replacement)
replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)	Replaces all occurrences of a specified character string pattern with a replacement string in the input file.
replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, Pattern pattern, String replacement)
replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)	Replaces all occurrences of a specified regular expression pattern with a replacement string in the input file.
replaceToImages(String inputFileName, ImageSaveOptions saveOptions, String pattern, String replacement)
replaceToImages(String inputFileName, ImageSaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)	Replaces all occurrences of a specified character string pattern with a replacement string in the input file.
replaceToImages(String inputFileName, ImageSaveOptions saveOptions, Pattern pattern, String replacement)
replaceToImages(String inputFileName, ImageSaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)	Replaces all occurrences of a specified regular expression pattern with a replacement string in the input file.
to(OutputStream output, SaveOptions saveOptions)
to(OutputStream output, int saveFormat)
to(String output)
to(String output, SaveOptions saveOptions)	Specifies output file for the processor.
to(String output, int saveFormat)
to(ArrayList output, SaveOptions saveOptions)
to(ArrayList output, int saveFormat)
toOutput(ArrayList output, SaveOptions saveOptions)
toOutput(ArrayList output, int saveFormat)

create(ReplacerContext context)

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();
     }
 }
 

Parameters:

Parameter	Type	Description
context	ReplacerContext

Returns: Replacer

execute()

public void execute()

Execute the processor action.

Examples:

Shows how to convert documents with a single line of code using context.

 String doc = getMyDir() + "Big document.docx";

 ConverterContext converterContext = new ConverterContext();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.1.pdf")
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.2.pdf", SaveFormat.RTF)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 LoadOptions loadOptions = new LoadOptions();
 {
     loadOptions.setIgnoreOleData(true);
 }
 Converter.create(converterContext)
         .from(doc, loadOptions)
         .to(getArtifactsDir() + "LowCode.ConvertContext.3.docx", saveOptions)
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.4.png", new ImageSaveOptions(SaveFormat.PNG))
         .execute();
 

Shows how to convert documents from a stream with a single line of code using context.

 String doc = getMyDir() + "Document.docx";
 ConverterContext converterContext = new ConverterContext();

 try (FileInputStream streamIn = new FileInputStream(doc)) {
     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.1.docx")) {
         Converter.create(converterContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.RTF)
                 .execute();
     }

     OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
     {
         saveOptions.setPassword("Aspose.Words");
     }
     LoadOptions loadOptions = new LoadOptions();
     {
         loadOptions.setIgnoreOleData(true);
     }
     try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.2.docx")) {
         Converter.create(converterContext)
                 .from(streamIn, loadOptions)
                 .to(streamOut1, saveOptions)
                 .execute();
     }
 }
 

Shows how to merge documents into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.1.docx")
         .execute();

 LoadOptions firstLoadOptions = new LoadOptions();
 {
     firstLoadOptions.setIgnoreOleData(true);
 }
 LoadOptions secondLoadOptions = new LoadOptions();
 {
     secondLoadOptions.setIgnoreOleData(false);
 }
 Merger.create(mergerContext)
         .from(inputDoc1, firstLoadOptions)
         .from(inputDoc2, secondLoadOptions)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.2.docx", SaveFormat.DOCX)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.3.docx", saveOptions)
         .execute();
 

Shows how to merge documents from stream into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 try (FileInputStream firstStreamIn = new FileInputStream(inputDoc1)) {
     try (FileInputStream secondStreamIn = new FileInputStream(inputDoc2)) {
         OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
         {
             saveOptions.setPassword("Aspose.Words");
         }
         try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.1.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn)
                     .from(secondStreamIn)
                     .to(streamOut, saveOptions)
                     .execute();
         }

         LoadOptions firstLoadOptions = new LoadOptions();
         {
             firstLoadOptions.setIgnoreOleData(true);
         }
         LoadOptions secondLoadOptions = new LoadOptions();
         {
             secondLoadOptions.setIgnoreOleData(false);
         }
         try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.2.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn, firstLoadOptions)
                     .from(secondStreamIn, secondLoadOptions)
                     .to(streamOut1, SaveFormat.DOCX)
                     .execute();
         }
     }
 }
 

from(InputStream input)

public Processor from(InputStream input)

Parameters:

Parameter	Type	Description
input	java.io.InputStream

Returns: Processor

from(InputStream input, LoadOptions loadOptions)

public Processor from(InputStream input, LoadOptions loadOptions)

Specifies input document for processing.

Remarks:

If the processor accepts only one file as an input, only the last specified file will be processed. Merger processor accepts multiple files as an input, as the result all the specified documents will be merged. Converter processor accepts only one file as an input, so only the last specified file will be converted.

Examples:

Shows how to convert documents from a stream with a single line of code using context.

 String doc = getMyDir() + "Document.docx";
 ConverterContext converterContext = new ConverterContext();

 try (FileInputStream streamIn = new FileInputStream(doc)) {
     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.1.docx")) {
         Converter.create(converterContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.RTF)
                 .execute();
     }

     OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
     {
         saveOptions.setPassword("Aspose.Words");
     }
     LoadOptions loadOptions = new LoadOptions();
     {
         loadOptions.setIgnoreOleData(true);
     }
     try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.2.docx")) {
         Converter.create(converterContext)
                 .from(streamIn, loadOptions)
                 .to(streamOut1, saveOptions)
                 .execute();
     }
 }
 

Shows how to merge documents from stream into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 try (FileInputStream firstStreamIn = new FileInputStream(inputDoc1)) {
     try (FileInputStream secondStreamIn = new FileInputStream(inputDoc2)) {
         OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
         {
             saveOptions.setPassword("Aspose.Words");
         }
         try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.1.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn)
                     .from(secondStreamIn)
                     .to(streamOut, saveOptions)
                     .execute();
         }

         LoadOptions firstLoadOptions = new LoadOptions();
         {
             firstLoadOptions.setIgnoreOleData(true);
         }
         LoadOptions secondLoadOptions = new LoadOptions();
         {
             secondLoadOptions.setIgnoreOleData(false);
         }
         try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.2.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn, firstLoadOptions)
                     .from(secondStreamIn, secondLoadOptions)
                     .to(streamOut1, SaveFormat.DOCX)
                     .execute();
         }
     }
 }
 

Parameters:

Parameter	Type	Description
input	java.io.InputStream	Input document stream.
loadOptions	LoadOptions	Optional load options used to load the document.

Returns: Processor - Returns processor with specified input file stream.

from(String input)

public Processor from(String input)

Parameters:

Parameter	Type	Description
input	java.lang.String

Returns: Processor

from(String input, LoadOptions loadOptions)

public Processor from(String input, LoadOptions loadOptions)

Specifies input document for processing.

Remarks:

If the processor accepts only one file as an input, only the last specified file will be processed. Merger processor accepts multiple files as an input, as the result all the specified documents will be merged. Converter processor accepts only one file as an input, so only the last specified file will be converted.

Examples:

Shows how to convert documents with a single line of code using context.

 String doc = getMyDir() + "Big document.docx";

 ConverterContext converterContext = new ConverterContext();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.1.pdf")
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.2.pdf", SaveFormat.RTF)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 LoadOptions loadOptions = new LoadOptions();
 {
     loadOptions.setIgnoreOleData(true);
 }
 Converter.create(converterContext)
         .from(doc, loadOptions)
         .to(getArtifactsDir() + "LowCode.ConvertContext.3.docx", saveOptions)
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.4.png", new ImageSaveOptions(SaveFormat.PNG))
         .execute();
 

Shows how to merge documents into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.1.docx")
         .execute();

 LoadOptions firstLoadOptions = new LoadOptions();
 {
     firstLoadOptions.setIgnoreOleData(true);
 }
 LoadOptions secondLoadOptions = new LoadOptions();
 {
     secondLoadOptions.setIgnoreOleData(false);
 }
 Merger.create(mergerContext)
         .from(inputDoc1, firstLoadOptions)
         .from(inputDoc2, secondLoadOptions)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.2.docx", SaveFormat.DOCX)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.3.docx", saveOptions)
         .execute();
 

Parameters:

Parameter	Type	Description
input	java.lang.String	Input document file name.
loadOptions	LoadOptions	Optional load options used to load the document.

Returns: Processor - Returns processor with specified input file.

replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String pattern, String replacement)

public static int replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String pattern, String replacement)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
pattern	java.lang.String
replacement	java.lang.String

Returns: int

replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)

public static int replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
pattern	java.lang.String
replacement	java.lang.String
options	FindReplaceOptions

Returns: int

replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, Pattern pattern, String replacement)

public static int replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, Pattern pattern, String replacement)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
pattern	java.util.regex.Pattern
replacement	java.lang.String

Returns: int

replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)

public static int replace(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
pattern	java.util.regex.Pattern
replacement	java.lang.String
options	FindReplaceOptions

Returns: int

replace(InputStream inputStream, OutputStream outputStream, int saveFormat, String pattern, String replacement)

public static int replace(InputStream inputStream, OutputStream outputStream, int saveFormat, String pattern, String replacement)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
pattern	java.lang.String
replacement	java.lang.String

Returns: int

replace(InputStream inputStream, OutputStream outputStream, int saveFormat, String pattern, String replacement, FindReplaceOptions options)

public static int replace(InputStream inputStream, OutputStream outputStream, int saveFormat, String pattern, String replacement, FindReplaceOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
pattern	java.lang.String
replacement	java.lang.String
options	FindReplaceOptions

Returns: int

replace(InputStream inputStream, OutputStream outputStream, int saveFormat, Pattern pattern, String replacement)

public static int replace(InputStream inputStream, OutputStream outputStream, int saveFormat, Pattern pattern, String replacement)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
pattern	java.util.regex.Pattern
replacement	java.lang.String

Returns: int

replace(InputStream inputStream, OutputStream outputStream, int saveFormat, Pattern pattern, String replacement, FindReplaceOptions options)

public static int replace(InputStream inputStream, OutputStream outputStream, int saveFormat, Pattern pattern, String replacement, FindReplaceOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
pattern	java.util.regex.Pattern
replacement	java.lang.String
options	FindReplaceOptions

Returns: int

replace(String inputFileName, String outputFileName, SaveOptions saveOptions, String pattern, String replacement)

public static int replace(String inputFileName, String outputFileName, SaveOptions saveOptions, String pattern, String replacement)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveOptions	SaveOptions
pattern	java.lang.String
replacement	java.lang.String

Returns: int

replace(String inputFileName, String outputFileName, SaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)

public static int replace(String inputFileName, String outputFileName, SaveOptions saveOptions, String pattern, 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.

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:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
saveOptions	SaveOptions	The save options.
pattern	java.lang.String	A string to be replaced.
replacement	java.lang.String	A string to replace all occurrences of pattern.
options	FindReplaceOptions	FindReplaceOptions object to specify additional options.

Returns: int - The number of replacements made.

replace(String inputFileName, String outputFileName, SaveOptions saveOptions, Pattern pattern, String replacement)

public static int replace(String inputFileName, String outputFileName, SaveOptions saveOptions, Pattern pattern, String replacement)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveOptions	SaveOptions
pattern	java.util.regex.Pattern
replacement	java.lang.String

Returns: int

replace(String inputFileName, String outputFileName, SaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)

public static int replace(String inputFileName, String outputFileName, SaveOptions saveOptions, Pattern pattern, 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.

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:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
saveOptions	SaveOptions	The save options.
pattern	java.util.regex.Pattern	A regular expression pattern used to find matches.
replacement	java.lang.String	A string to replace all occurrences of pattern.
options	FindReplaceOptions	FindReplaceOptions object to specify additional options.

Returns: int - The number of replacements made.

replace(String inputFileName, String outputFileName, int saveFormat, String pattern, String replacement)

public static int replace(String inputFileName, String outputFileName, int saveFormat, String pattern, String replacement)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
pattern	java.lang.String
replacement	java.lang.String

Returns: int

replace(String inputFileName, String outputFileName, int saveFormat, String pattern, String replacement, FindReplaceOptions options)

public static int replace(String inputFileName, String outputFileName, int saveFormat, String pattern, String replacement, FindReplaceOptions options)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
pattern	java.lang.String
replacement	java.lang.String
options	FindReplaceOptions

Returns: int

replace(String inputFileName, String outputFileName, int saveFormat, Pattern pattern, String replacement)

public static int replace(String inputFileName, String outputFileName, int saveFormat, Pattern pattern, String replacement)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
pattern	java.util.regex.Pattern
replacement	java.lang.String

Returns: int

replace(String inputFileName, String outputFileName, int saveFormat, Pattern pattern, String replacement, FindReplaceOptions options)

public static int replace(String inputFileName, String outputFileName, int saveFormat, Pattern pattern, String replacement, FindReplaceOptions options)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
pattern	java.util.regex.Pattern
replacement	java.lang.String
options	FindReplaceOptions

Returns: int

replace(String inputFileName, String outputFileName, String pattern, String replacement)

public static int replace(String inputFileName, String outputFileName, String pattern, String replacement)

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:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
pattern	java.lang.String	A string to be replaced.
replacement	java.lang.String	A string to replace all occurrences of pattern.

Returns: int - The number of replacements made.

replace(String inputFileName, String outputFileName, Pattern pattern, String replacement)

public static int replace(String inputFileName, String outputFileName, Pattern pattern, String replacement)

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:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
pattern	java.util.regex.Pattern	A regular expression pattern used to find matches.
replacement	java.lang.String	A string to replace all occurrences of pattern.

Returns: int - The number of replacements made.

replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, String pattern, String replacement)

public static OutputStream[] replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, String pattern, String replacement)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
saveOptions	ImageSaveOptions
pattern	java.lang.String
replacement	java.lang.String

Returns: java.io.OutputStream[]

replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)

public static OutputStream[] replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)

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:

Parameter	Type	Description
inputStream	java.io.InputStream	The input file stream.
saveOptions	ImageSaveOptions	The save options.
pattern	java.lang.String	A string to be replaced.
replacement	java.lang.String	A string to replace all occurrences of pattern.
options	FindReplaceOptions	FindReplaceOptions object to specify additional options.

Returns: java.io.OutputStream[]

replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, Pattern pattern, String replacement)

public static OutputStream[] replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, Pattern pattern, String replacement)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
saveOptions	ImageSaveOptions
pattern	java.util.regex.Pattern
replacement	java.lang.String

Returns: java.io.OutputStream[]

replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)

public static OutputStream[] replaceToImages(InputStream inputStream, ImageSaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)

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:

Parameter	Type	Description
inputStream	java.io.InputStream	The input file stream.
saveOptions	ImageSaveOptions	The save options.
pattern	java.util.regex.Pattern	A regular expression pattern used to find matches.
replacement	java.lang.String	A string to replace all occurrences of pattern.
options	FindReplaceOptions	FindReplaceOptions object to specify additional options.

Returns: java.io.OutputStream[]

replaceToImages(String inputFileName, ImageSaveOptions saveOptions, String pattern, String replacement)

public static OutputStream[] replaceToImages(String inputFileName, ImageSaveOptions saveOptions, String pattern, String replacement)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
saveOptions	ImageSaveOptions
pattern	java.lang.String
replacement	java.lang.String

Returns: java.io.OutputStream[]

replaceToImages(String inputFileName, ImageSaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)

public static OutputStream[] replaceToImages(String inputFileName, ImageSaveOptions saveOptions, String pattern, String replacement, FindReplaceOptions options)

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:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
saveOptions	ImageSaveOptions	The save options.
pattern	java.lang.String	A string to be replaced.
replacement	java.lang.String	A string to replace all occurrences of pattern.
options	FindReplaceOptions	FindReplaceOptions object to specify additional options.

Returns: java.io.OutputStream[]

replaceToImages(String inputFileName, ImageSaveOptions saveOptions, Pattern pattern, String replacement)

public static OutputStream[] replaceToImages(String inputFileName, ImageSaveOptions saveOptions, Pattern pattern, String replacement)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
saveOptions	ImageSaveOptions
pattern	java.util.regex.Pattern
replacement	java.lang.String

Returns: java.io.OutputStream[]

replaceToImages(String inputFileName, ImageSaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)

public static OutputStream[] replaceToImages(String inputFileName, ImageSaveOptions saveOptions, Pattern pattern, String replacement, FindReplaceOptions options)

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:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
saveOptions	ImageSaveOptions	The save options.
pattern	java.util.regex.Pattern	A regular expression pattern used to find matches.
replacement	java.lang.String	A string to replace all occurrences of pattern.
options	FindReplaceOptions	FindReplaceOptions object to specify additional options.

Returns: java.io.OutputStream[]

to(OutputStream output, SaveOptions saveOptions)

public Processor to(OutputStream output, SaveOptions saveOptions)

Parameters:

Parameter	Type	Description
output	java.io.OutputStream
saveOptions	SaveOptions

Returns: Processor

to(OutputStream output, int saveFormat)

public Processor to(OutputStream output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.io.OutputStream
saveFormat	int

Returns: Processor

to(String output)

public Processor to(String output)

Parameters:

Parameter	Type	Description
output	java.lang.String

Returns: Processor

to(String output, SaveOptions saveOptions)

public Processor to(String output, SaveOptions saveOptions)

Specifies output file for the processor.

Remarks:

If the output consists of multiple files, the specified output file name is used to generate the file name for each part following the rule: ‘outputFile_partIndex.extension’.

Examples:

Shows how to convert documents with a single line of code using context.

 String doc = getMyDir() + "Big document.docx";

 ConverterContext converterContext = new ConverterContext();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.1.pdf")
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.2.pdf", SaveFormat.RTF)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 LoadOptions loadOptions = new LoadOptions();
 {
     loadOptions.setIgnoreOleData(true);
 }
 Converter.create(converterContext)
         .from(doc, loadOptions)
         .to(getArtifactsDir() + "LowCode.ConvertContext.3.docx", saveOptions)
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.4.png", new ImageSaveOptions(SaveFormat.PNG))
         .execute();
 

Shows how to merge documents into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.1.docx")
         .execute();

 LoadOptions firstLoadOptions = new LoadOptions();
 {
     firstLoadOptions.setIgnoreOleData(true);
 }
 LoadOptions secondLoadOptions = new LoadOptions();
 {
     secondLoadOptions.setIgnoreOleData(false);
 }
 Merger.create(mergerContext)
         .from(inputDoc1, firstLoadOptions)
         .from(inputDoc2, secondLoadOptions)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.2.docx", SaveFormat.DOCX)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.3.docx", saveOptions)
         .execute();
 

Parameters:

Parameter	Type	Description
output	java.lang.String	Output file name.
saveOptions	SaveOptions	Optional save options. If not specified, save format is determined by the file extension.

Returns: Processor - Returns processor with specified output file.

to(String output, int saveFormat)

public Processor to(String output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.lang.String
saveFormat	int

Returns: Processor

to(ArrayList output, SaveOptions saveOptions)

public Processor to(ArrayList output, SaveOptions saveOptions)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveOptions	SaveOptions

Returns: Processor

to(ArrayList output, int saveFormat)

public Processor to(ArrayList output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveFormat	int

Returns: Processor

toOutput(ArrayList output, SaveOptions saveOptions)

public Processor toOutput(ArrayList output, SaveOptions saveOptions)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveOptions	SaveOptions

Returns: Processor

toOutput(ArrayList output, int saveFormat)

public Processor toOutput(ArrayList output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveFormat	int

Returns: Processor