## Range::Replace(const System::SharedPtr\\&, const System::String\&) method Replaces all occurrences of a character pattern specified by a regular expression with another string. ```cpp int32_t Aspose::Words::Range::Replace(const System::SharedPtr &pattern, const System::String &replacement) ``` | Parameter | Type | Description | | --- | --- | --- | | pattern | const System::SharedPtr\\& | A regular expression pattern used to find matches. | | replacement | const System::String\& | A string to replace all occurrences of pattern. | ### ReturnValue The number of replacements made. ## Remarks Replaces the whole match captured by the regular expression. Method is able to process breaks in both pattern and replacement strings. You should use special meta-characters if you need to work with breaks: * **%&p** - paragraph break * **%&b** - section break * **%&m** - page break * **%&l** - manual line break ## Examples Shows how to replace all occurrences of a regular expression pattern with other text. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); builder->Writeln(u"I decided to get the curtains in gray, ideal for the grey-accented room."); doc->get_Range()->Replace(System::MakeObject(u"gr(a|e)y"), u"lavender"); ASSERT_EQ((u"I decided to get the curtains in lavender, ideal for the lavender-accented room."), doc->GetText().Trim()); ``` ## See Also * Class [Range](../) * Namespace [Aspose::Words](../../) * Library [Aspose.Words for C++](../../../) ## Range::Replace(const System::SharedPtr\\&, const System::String\&, const System::SharedPtr\\&) method Replaces all occurrences of a character pattern specified by a regular expression with another string. ```cpp int32_t Aspose::Words::Range::Replace(const System::SharedPtr &pattern, const System::String &replacement, const System::SharedPtr &options) ``` | Parameter | Type | Description | | --- | --- | --- | | pattern | const System::SharedPtr\\& | A regular expression pattern used to find matches. | | replacement | const System::String\& | A string to replace all occurrences of pattern. | | options | const System::SharedPtr\\& | [FindReplaceOptions](../../../aspose.words.replacing/findreplaceoptions/) object to specify additional options. | ### ReturnValue The number of replacements made. ## Remarks Replaces the whole match captured by the regular expression. Method is able to process breaks in both pattern and replacement strings. You should use special meta-characters if you need to work with breaks: * **%&p** - paragraph break * **%&b** - section break * **%&m** - page break * **%&l** - manual line break * **%&&** - & character ## See Also * Class [FindReplaceOptions](../../../aspose.words.replacing/findreplaceoptions/) * Class [Range](../) * Namespace [Aspose::Words](../../) * Library [Aspose.Words for C++](../../../) ## Range::Replace(const System::String\&, const System::String\&) method Replaces all occurrences of a specified character string pattern with a replacement string. ```cpp int32_t Aspose::Words::Range::Replace(const System::String &pattern, const System::String &replacement) ``` | Parameter | Type | Description | | --- | --- | --- | | pattern | const System::String\& | A string to be replaced. | | replacement | const System::String\& | A string to replace all occurrences of pattern. | ### ReturnValue The number of replacements made. ## Remarks The pattern will not be used as regular expression. Please use [Replace()](../) if you need regular expressions. Used case-insensitive comparison. Method is able to process breaks in both pattern and replacement strings. You should use special meta-characters if you need to work with breaks: * **%&p** - paragraph break * **%&b** - section break * **%&m** - page break * **%&l** - manual line break ## Examples Shows how to perform a find-and-replace text operation on the contents of a document. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); builder->Writeln(u"Greetings, _FullName_!"); // Perform a find-and-replace operation on our document's contents and verify the number of replacements that took place. int32_t replacementCount = doc->get_Range()->Replace(u"_FullName_", u"John Doe"); ASSERT_EQ(1, replacementCount); ASSERT_EQ((u"Greetings, John Doe!"), doc->GetText().Trim()); ``` Shows how to add formatting to paragraphs in which a find-and-replace operation has found matches. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); builder->Writeln(u"Every paragraph that ends with a full stop like this one will be right aligned."); builder->Writeln(u"This one will not!"); builder->Write(u"This one also will."); System::SharedPtr paragraphs = doc->get_FirstSection()->get_Body()->get_Paragraphs(); ASSERT_EQ(ParagraphAlignment::Left, paragraphs->idx_get(0)->get_ParagraphFormat()->get_Alignment()); ASSERT_EQ(ParagraphAlignment::Left, paragraphs->idx_get(1)->get_ParagraphFormat()->get_Alignment()); ASSERT_EQ(ParagraphAlignment::Left, paragraphs->idx_get(2)->get_ParagraphFormat()->get_Alignment()); // We can use a "FindReplaceOptions" object to modify the find-and-replace process. auto options = System::MakeObject(); // Set the "Alignment" property to "ParagraphAlignment.Right" to right-align every paragraph // that contains a match that the find-and-replace operation finds. options->get_ApplyParagraphFormat()->set_Alignment(ParagraphAlignment::Right); // Replace every full stop that is right before a paragraph break with an exclamation point. int32_t count = doc->get_Range()->Replace(u".&p", u"!&p", options); ASSERT_EQ(2, count); ASSERT_EQ(ParagraphAlignment::Right, paragraphs->idx_get(0)->get_ParagraphFormat()->get_Alignment()); ASSERT_EQ(ParagraphAlignment::Left, paragraphs->idx_get(1)->get_ParagraphFormat()->get_Alignment()); ASSERT_EQ(ParagraphAlignment::Right, paragraphs->idx_get(2)->get_ParagraphFormat()->get_Alignment()); ASSERT_EQ(System::String(u"Every paragraph that ends with a full stop like this one will be right aligned!\r") + u"This one will not!\r" + u"This one also will!", doc->GetText().Trim()); ``` ## See Also * Class [Range](../) * Namespace [Aspose::Words](../../) * Library [Aspose.Words for C++](../../../) ## Range::Replace(const System::String\&, const System::String\&, const System::SharedPtr\\&) method Replaces all occurrences of a specified character string pattern with a replacement string. ```cpp int32_t Aspose::Words::Range::Replace(const System::String &pattern, const System::String &replacement, const System::SharedPtr &options) ``` | Parameter | Type | Description | | --- | --- | --- | | pattern | const System::String\& | A string to be replaced. | | replacement | const System::String\& | A string to replace all occurrences of pattern. | | options | const System::SharedPtr\\& | [FindReplaceOptions](../../../aspose.words.replacing/findreplaceoptions/) object to specify additional options. | ### ReturnValue The number of replacements made. ## Remarks The pattern will not be used as regular expression. Please use [Replace()](../) if you need regular expressions. Method is able to process breaks in both pattern and replacement strings. You should use special meta-characters if you need to work with breaks: * **%&p** - paragraph break * **%&b** - section break * **%&m** - page break * **%&l** - manual line break * **%&&** - & character ## Examples Shows how to replace text in a document's footer. ```cpp auto doc = System::MakeObject(System::String(get_MyDir() + u"Footer.docx")); System::SharedPtr headersFooters = doc->get_FirstSection()->get_HeadersFooters(); System::SharedPtr footer = headersFooters->idx_get(HeaderFooterType::FooterPrimary); auto options = System::MakeObject(); options->set_MatchCase(false); options->set_FindWholeWordsOnly(false); int32_t currentYear = System::DateTime::get_Now().get_Year(); footer->get_Range()->Replace(u"(C) 2006 Aspose Pty Ltd.", System::String::Format(u"Copyright (C) {0} by Aspose Pty Ltd.", currentYear), options); doc->Save(get_ArtifactsDir() + u"HeaderFooter.ReplaceText.docx"); ``` Shows how to toggle case sensitivity when performing a find-and-replace operation. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); builder->Writeln(u"Ruby bought a ruby necklace."); // We can use a "FindReplaceOptions" object to modify the find-and-replace process. auto options = System::MakeObject(); // Set the "MatchCase" flag to "true" to apply case sensitivity while finding strings to replace. // Set the "MatchCase" flag to "false" to ignore character case while searching for text to replace. options->set_MatchCase(matchCase); doc->get_Range()->Replace(u"Ruby", u"Jade", options); ASSERT_EQ(matchCase ? System::String(u"Jade bought a ruby necklace.") : System::String(u"Jade bought a Jade necklace."), doc->GetText().Trim()); ``` Shows how to toggle standalone word-only find-and-replace operations. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); builder->Writeln(u"Jackson will meet you in Jacksonville."); // We can use a "FindReplaceOptions" object to modify the find-and-replace process. auto options = System::MakeObject(); // Set the "FindWholeWordsOnly" flag to "true" to replace the found text if it is not a part of another word. // Set the "FindWholeWordsOnly" flag to "false" to replace all text regardless of its surroundings. options->set_FindWholeWordsOnly(findWholeWordsOnly); doc->get_Range()->Replace(u"Jackson", u"Louis", options); ASSERT_EQ(findWholeWordsOnly ? System::String(u"Louis will meet you in Jacksonville.") : System::String(u"Louis will meet you in Louisville."), doc->GetText().Trim()); ``` Shows how to replace all instances of String of text in a table and cell. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); System::SharedPtr table = builder->StartTable(); builder->InsertCell(); builder->Write(u"Carrots"); builder->InsertCell(); builder->Write(u"50"); builder->EndRow(); builder->InsertCell(); builder->Write(u"Potatoes"); builder->InsertCell(); builder->Write(u"50"); builder->EndTable(); auto options = System::MakeObject(); options->set_MatchCase(true); options->set_FindWholeWordsOnly(true); // Perform a find-and-replace operation on an entire table. table->get_Range()->Replace(u"Carrots", u"Eggs", options); // Perform a find-and-replace operation on the last cell of the last row of the table. table->get_LastRow()->get_LastCell()->get_Range()->Replace(u"50", u"20", options); ASSERT_EQ(System::String(u"Eggs\a50\a\a") + u"Potatoes\a20\a\a", table->GetText().Trim()); ``` ## See Also * Class [FindReplaceOptions](../../../aspose.words.replacing/findreplaceoptions/) * Class [Range](../) * Namespace [Aspose::Words](../../) * Library [Aspose.Words for C++](../../../)