String.Insert Method Home
This page is specific to:.NET Framework Version:1.12.03.03.5Silverlight 34.0
.NET Framework Class Library
String.Insert Method

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

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

Syntax

'Usage

Dim instance As String
Dim startIndex As Integer
Dim value As String
Dim returnValue As String

returnValue = instance.Insert(startIndex, value)

'Declaration

Public Function Insert ( _
    startIndex As Integer, _
    value As String _
) As String
public String Insert (
    int startIndex, 
    String value
)

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 typeCondition

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.

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

import System.*;

public class InsertTest
{
    public static void main(String[] args)
    {
        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.get_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.get_NewLine(), strTarget);
    } //main
} //InsertTest

Platforms

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
See Also

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View