Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

String.Insert Method

Inserts a specified instance of String at a specified index position in this instance.

[Visual Basic]
Public Function Insert( _
   ByVal startIndex As Integer, _
   ByVal value As String _
) As String
[C#]
public string Insert(
 int startIndex,
 string value
);
[C++]
public: String* Insert(
 int startIndex,
 String* value
);
[JScript]
public function Insert(
   startIndex : int,
 value : String
) : String;

Parameters

startIndex
The index position of the insertion.
value
The String to insert.

Return Value

A new String equivalent to this instance but with value inserted at position startIndex.

Exceptions

Exception Type Condition
ArgumentNullException value is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeException startIndex is negative or greater than the length of this instance.

Remarks

If startIndex is equal to the length of this instance, value is appended to the end of this instance.

For example, the return value of "abc".Insert(2, "XYZ") is "abXYZc".

Example

The following console application provides a simple demonstration of the Insert method.

[Visual Basic] 
Imports System

Public Class InsertTest
    
    Public Shared Sub Main()
        Dim animal1 As String = "fox"
        Dim animal2 As String = "dog"
        Dim strTarget As String = [String].Format("The {0} jumped over the {1}.", animal1, animal2)
        
        Console.WriteLine("The original string is:{0}{1}{0}", Environment.NewLine, strTarget)
        
        Console.Write("Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal1)
        Dim adj1 As String = Console.ReadLine()
        
        Console.Write("Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal2)
        Dim adj2 As String = Console.ReadLine()
        
        adj1 = adj1.Trim() + " "
        adj2 = 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)
    End Sub 'Main
End Class 'InsertTest

[C#] 
using System;

public class InsertTest {
    public static void 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("Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal1);
        string adj1 = Console.ReadLine();

        Console.Write("Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal2);    
        string adj2 = Console.ReadLine();

        adj1 = adj1.Trim() + " ";
        adj2 = 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);
    }
}

[C++] 
#using <mscorlib.dll>

using namespace System;
int main()
{
   String* animal1 = S"fox";
   String* animal2 = S"dog";

   String* strTarget = String::Format(S"The {0} jumped over the {1}.", animal1, animal2);

   Console::WriteLine(S"The original string is:{0}{1}{0}", Environment::NewLine, strTarget);

   Console::Write(S"Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal1);
   String* adj1 = Console::ReadLine();

   Console::Write(S"Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal2);    
   String* adj2 = Console::ReadLine();

   adj1 = String::Concat( adj1->Trim(), S" ");
   adj2 = String::Concat( adj2->Trim(), S" ");

   strTarget = strTarget->Insert(strTarget->IndexOf(animal1), adj1);
   strTarget = strTarget->Insert(strTarget->IndexOf(animal2), adj2);

   Console::WriteLine(S" {0}The final string is: {0} {1}", Environment::NewLine, strTarget);
}

[JScript] 
import System;

public class InsertTest {
    public static function Main() : void {

        var animal1 : String = "fox";
        var animal2 : String = "dog";

        var strTarget : String = String.Format("The {0} jumped over the {1}.", animal1, animal2);

        Console.WriteLine("The original string is:{0}{1}{0}", Environment.NewLine, strTarget);

        Console.Write("Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal1);
        var adj1 : String = Console.ReadLine();

        Console.Write("Please enter an adjective (or a group of adjectives) to describe the {0}: ==> ", animal2);    
        var adj2 : String = Console.ReadLine();

        adj1 = adj1.Trim() + " ";
        adj2 = 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);
    }
}
InsertTest.Main();

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

String Class | String Members | System Namespace | Int32 | Concat | CopyTo | Insert | Join | Remove | Replace | Split | Substring | Trim

Show:
© 2014 Microsoft