String::Insert Method
Returns a new string in which a specified string is inserted at a specified index position in this instance.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- startIndex
- Type: System::Int32
The zero-based index position of the insertion.
- value
- Type: System::String
The string to insert.
Return Value
Type: System::StringA new string that is equivalent to this instance, but with value inserted at position startIndex.
| Exception | Condition |
|---|---|
| ArgumentNullException | value is nullptr. |
| ArgumentOutOfRangeException | startIndex is negative or greater than the length of this instance. |
If startIndex is equal to the length of this instance, value is appended to the end of this instance.
Note |
|---|
This method does not modify the value of the current instance. Instead, it returns a new string in which value is inserted into the current instance. |
For example, the return value of "abc".Insert(2, "XYZ") is "abXYZc".
The following console application provides a simple demonstration of the Insert method.
using namespace System; int main() { String^ animal1 = "fox"; String^ animal2 = "dog"; String^ strTarget = String::Format( "The {0} jumped over the {1}.", animal1, animal2 ); Console::WriteLine( "The original string is:{0}{1}{0}", Environment::NewLine, strTarget ); Console::Write( "Enter an adjective (or group of adjectives) to describe the {0}: ==> ", animal1 ); String^ adj1 = Console::ReadLine(); Console::Write( "Enter an adjective (or group of adjectives) to describe the {0}: ==> ", animal2 ); String^ adj2 = Console::ReadLine(); adj1 = String::Concat( adj1->Trim(), " " ); adj2 = String::Concat( adj2->Trim(), " " ); strTarget = strTarget->Insert( strTarget->IndexOf( animal1 ), adj1 ); strTarget = strTarget->Insert( strTarget->IndexOf( animal2 ), adj2 ); Console::WriteLine( " {0}The final string is: {0} {1}", Environment::NewLine, strTarget ); } // Output from the example might appear as follows: // The original string is: // The fox jumped over the dog. // // Enter an adjective (or group of adjectives) to describe the fox: ==> bold // Enter an adjective (or group of adjectives) to describe the dog: ==> lazy // // The final string is: // The bold fox jumped over the lazy dog.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note