Export (0) Print
Expand All

StringCollection.Insert Method

Inserts a string into the StringCollection at the specified index.

Namespace:  System.Collections.Specialized
Assembly:  System (in System.dll)

'Declaration
Public Sub Insert ( _
	index As Integer, _
	value As String _
)

Parameters

index
Type: System.Int32

The zero-based index at which value is inserted.

value
Type: System.String

The string to insert. The value can be Nothing.

ExceptionCondition
ArgumentOutOfRangeException

index is less than zero.

-or-

index greater than Count.

Duplicate strings are allowed in StringCollection.

If index is equal to Count, value is added to the end of StringCollection.

In collections of contiguous elements, such as lists, the elements that follow the insertion point move down to accommodate the new element. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped into buckets, such as a hash table.

This method is an O(n) operation, where n is Count.

The following code example adds new elements to the StringCollection.

Imports System
Imports System.Collections
Imports System.Collections.Specialized

Public Class SamplesStringCollection   

   Public Shared Sub Main()

      ' Creates and initializes a new StringCollection. 
      Dim myCol As New StringCollection()

      Console.WriteLine("Initial contents of the StringCollection:")
      PrintValues(myCol)

      ' Adds a range of elements from an array to the end of the StringCollection. 
      Dim myArr() As [String] = {"RED", "orange", "yellow", "RED", "green", "blue", "RED", "indigo", "violet", "RED"}
      myCol.AddRange(myArr)

      Console.WriteLine("After adding a range of elements:")
      PrintValues(myCol)

      ' Adds one element to the end of the StringCollection and inserts another at index 3.
      myCol.Add("* white")
      myCol.Insert(3, "* gray")

      Console.WriteLine("After adding ""* white"" to the end and inserting ""* gray"" at index 3:")
      PrintValues(myCol)

   End Sub 'Main

   Public Shared Sub PrintValues(myCol As IEnumerable)
      Dim obj As [Object]
      For Each obj In  myCol
         Console.WriteLine("   {0}", obj)
      Next obj
      Console.WriteLine()
   End Sub 'PrintValues

End Class 'SamplesStringCollection 


'This code produces the following output. 

'Initial contents of the StringCollection: 

'After adding a range of elements: 
'   RED 
'   orange 
'   yellow 
'   RED 
'   green 
'   blue 
'   RED 
'   indigo 
'   violet 
'   RED 

'After adding "* white" to the end and inserting "* gray" at index 3: 
'   RED 
'   orange 
'   yellow 
'   * gray 
'   RED 
'   green 
'   blue 
'   RED 
'   indigo 
'   violet 
'   RED 
'   * white 
'

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft