Export (0) Print
Expand All
Expand Minimize

String.Insert Method

Updated: October 2008

Returns a new string in which a specified string is inserted at a specified index position in this instance.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public string Insert(
	int startIndex,
	string value
)

Parameters

startIndex
Type: System.Int32

The index position of the insertion.

value
Type: System.String

The String to insert.

Return Value

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

ExceptionCondition
ArgumentNullException

value is null.

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.

NoteNote:

   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 example provides a simple demonstration of the Insert method.

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("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 = 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);
    }
}
// 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, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

October 2008

Added a note that the method returns a new String object.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft