Replace
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)
| Parameter | Type | Description |
|---|---|---|
| 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. |
Return Value
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.
Examples
Shows how to replace string in the document.
// There is a several ways to replace string in the document:
string doc = MyDir + "Footer.docx";
string pattern = "(C)2006 Aspose Pty Ltd.";
string replacement = "Copyright (C) 2024 by Aspose Pty Ltd.";
FindReplaceOptions options = new FindReplaceOptions();
options.FindWholeWordsOnly = false;
Replacer.Replace(doc, ArtifactsDir + "LowCode.Replace.1.docx", pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.Replace.2.docx", SaveFormat.Docx, pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.Replace.3.docx", SaveFormat.Docx, pattern, replacement, options);
See Also
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
Examples
Shows how to replace string in the document.
// There is a several ways to replace string in the document:
string doc = MyDir + "Footer.docx";
string pattern = "(C)2006 Aspose Pty Ltd.";
string replacement = "Copyright (C) 2024 by Aspose Pty Ltd.";
FindReplaceOptions options = new FindReplaceOptions();
options.FindWholeWordsOnly = false;
Replacer.Replace(doc, ArtifactsDir + "LowCode.Replace.1.docx", pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.Replace.2.docx", SaveFormat.Docx, pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.Replace.3.docx", SaveFormat.Docx, pattern, replacement, options);
See Also
- enum SaveFormat
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
See Also
- class SaveOptions
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
Examples
Shows how to replace string in the document using documents from the stream.
// 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.";
using (FileStream streamIn = new FileStream(MyDir + "Footer.docx", FileMode.Open, FileAccess.Read))
{
using (FileStream streamOut = new FileStream(ArtifactsDir + "LowCode.ReplaceStream.1.docx", FileMode.Create, FileAccess.ReadWrite))
Replacer.Replace(streamIn, streamOut, SaveFormat.Docx, pattern, replacement);
using (FileStream streamOut = new FileStream(ArtifactsDir + "LowCode.ReplaceStream.2.docx", FileMode.Create, FileAccess.ReadWrite))
{
FindReplaceOptions options = new FindReplaceOptions();
options.FindWholeWordsOnly = false;
Replacer.Replace(streamIn, streamOut, SaveFormat.Docx, pattern, replacement, options);
}
}
See Also
- enum SaveFormat
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
See Also
- class SaveOptions
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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. |
Return Value
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.
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 = MyDir + "Footer.docx";
Regex pattern = new Regex("gr(a|e)y");
string replacement = "lavender";
Replacer.Replace(doc, ArtifactsDir + "LowCode.ReplaceRegex.1.docx", pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.ReplaceRegex.2.docx", SaveFormat.Docx, pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.ReplaceRegex.3.docx", SaveFormat.Docx, pattern, replacement, new FindReplaceOptions() { FindWholeWordsOnly = false });
See Also
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
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 = MyDir + "Footer.docx";
Regex pattern = new Regex("gr(a|e)y");
string replacement = "lavender";
Replacer.Replace(doc, ArtifactsDir + "LowCode.ReplaceRegex.1.docx", pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.ReplaceRegex.2.docx", SaveFormat.Docx, pattern, replacement);
Replacer.Replace(doc, ArtifactsDir + "LowCode.ReplaceRegex.3.docx", SaveFormat.Docx, pattern, replacement, new FindReplaceOptions() { FindWholeWordsOnly = false });
See Also
- enum SaveFormat
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
See Also
- class SaveOptions
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
Examples
Shows how to replace string with regex in the document using documents from the stream.
// There is a several ways to replace string with regex in the document using documents from the stream:
Regex pattern = new Regex("gr(a|e)y");
string replacement = "lavender";
using (FileStream streamIn = new FileStream(MyDir + "Replace regex.docx", FileMode.Open, FileAccess.Read))
{
using (FileStream streamOut = new FileStream(ArtifactsDir + "LowCode.ReplaceStreamRegex.1.docx", FileMode.Create, FileAccess.ReadWrite))
Replacer.Replace(streamIn, streamOut, SaveFormat.Docx, pattern, replacement);
using (FileStream streamOut = new FileStream(ArtifactsDir + "LowCode.ReplaceStreamRegex.2.docx", FileMode.Create, FileAccess.ReadWrite))
Replacer.Replace(streamIn, streamOut, SaveFormat.Docx, pattern, replacement, new FindReplaceOptions() { FindWholeWordsOnly = false });
}
See Also
- enum SaveFormat
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
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)
| Parameter | Type | Description |
|---|---|---|
| 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 | FindReplaceOptions object to specify additional options. |
Return Value
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.
See Also
- class SaveOptions
- class FindReplaceOptions
- class Replacer
- namespace Aspose.Words.LowCode
- assembly Aspose.Words
