Export (0) Print
Expand All

CommaDelimitedStringCollection Class

Represents a collection of string elements separated by commas. This class cannot be inherited.

System.Object
  System.Collections.Specialized.StringCollection
    System.Configuration.CommaDelimitedStringCollection

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

'Declaration
Public NotInheritable Class CommaDelimitedStringCollection _
	Inherits StringCollection

The CommaDelimitedStringCollection type exposes the following members.

  NameDescription
Public methodCommaDelimitedStringCollectionCreates a new instance of the CommaDelimitedStringCollection class.
Top

  NameDescription
Public propertyCountGets the number of strings contained in the StringCollection. (Inherited from StringCollection.)
Public propertyIsModifiedGets a value that specifies whether the collection has been modified.
Public propertyIsReadOnlyGets a value indicating whether the collection object is read-only.
Public propertyIsSynchronizedGets a value indicating whether access to the StringCollection is synchronized (thread safe). (Inherited from StringCollection.)
Public propertyItemGets or sets a string element in the collection based on the index.
Public propertySyncRootGets an object that can be used to synchronize access to the StringCollection. (Inherited from StringCollection.)
Top

  NameDescription
Public methodAddAdds a string to the comma-delimited collection.
Public methodAddRangeAdds all the strings in a string array to the collection.
Public methodClearClears the collection.
Public methodCloneCreates a copy of the collection.
Public methodContainsDetermines whether the specified string is in the StringCollection. (Inherited from StringCollection.)
Public methodCopyToCopies the entire StringCollection values to a one-dimensional array of strings, starting at the specified index of the target array. (Inherited from StringCollection.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumeratorReturns a StringEnumerator that iterates through the StringCollection. (Inherited from StringCollection.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfSearches for the specified string and returns the zero-based index of the first occurrence within the StringCollection. (Inherited from StringCollection.)
Public methodInsertAdds a string element to the collection at the specified index.
Public methodRemoveRemoves a string element from the collection.
Public methodRemoveAtRemoves the string at the specified index of the StringCollection. (Inherited from StringCollection.)
Public methodSetReadOnlySets the collection object to read-only.
Public methodToStringReturns a string representation of the object. (Overrides Object.ToString.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the entire StringCollection to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from StringCollection.)
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorReturns a IEnumerator that iterates through the StringCollection. (Inherited from StringCollection.)
Explicit interface implemetationPrivate methodIList.AddAdds an object to the end of the StringCollection. (Inherited from StringCollection.)
Explicit interface implemetationPrivate methodIList.ContainsDetermines whether an element is in the StringCollection. (Inherited from StringCollection.)
Explicit interface implemetationPrivate methodIList.IndexOfSearches for the specified Object and returns the zero-based index of the first occurrence within the entire StringCollection. (Inherited from StringCollection.)
Explicit interface implemetationPrivate methodIList.InsertInserts an element into the StringCollection at the specified index. (Inherited from StringCollection.)
Explicit interface implemetationPrivate propertyIList.IsFixedSizeGets a value indicating whether the StringCollection object has a fixed size. (Inherited from StringCollection.)
Explicit interface implemetationPrivate propertyIList.IsReadOnlyGets a value indicating whether the StringCollection object is read-only. (Inherited from StringCollection.)
Explicit interface implemetationPrivate propertyIList.ItemGets or sets the element at the specified index. (Inherited from StringCollection.)
Explicit interface implemetationPrivate methodIList.RemoveRemoves the first occurrence of a specific object from the StringCollection. (Inherited from StringCollection.)
Top

This class represents a string collection that is serialized as a comma-delimited list of string elements.

The following code example demonstrates how to use the CommaDelimitedStringCollection type.

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Collections
Imports System.Web
Imports System.Web.Configuration
Imports System.Collections.Specialized

Namespace Samples.AspNet.Config
  Class CommaDelimitedStrCollection
    Shared Sub Main(ByVal args() As String)
      ' Display title and info.
      Console.WriteLine("ASP.NET Configuration Info")
      Console.WriteLine("Type: CommaDelimitedStringCollection")
      Console.WriteLine()

      ' Set the path of the config file. 
      Dim configPath As String = "/aspnet" 

      ' Get the Web application configuration object. 
      Dim config As Configuration = _
      WebConfigurationManager.OpenWebConfiguration(configPath)

      ' Get the section related object. 
      Dim configSection As AuthorizationSection = _
      CType(config.GetSection("system.web/authorization"), AuthorizationSection)

      ' Get the authorization rule collection. 
      Dim authorizationRuleCollection As AuthorizationRuleCollection = _
      configSection.Rules()

      ' Create a CommaDelimitedStringCollection object. 
      Dim myStrCollection As CommaDelimitedStringCollection = _
        New CommaDelimitedStringCollection()

      Dim i As Integer 
      For i = 0 To authorizationRuleCollection.Count - 1 Step i + 1
        If authorizationRuleCollection.Get(i).Action.ToString().ToLower() _
          = "allow" Then 
          ' Add values to the CommaDelimitedStringCollection object.
          myStrCollection.AddRange( _
            authorizationRuleCollection.Get(i).Users.ToString().Split( _
            ",".ToCharArray()))
        End If 
      Next

      Console.WriteLine("Allowed Users: {0}", _
        myStrCollection.ToString())

      ' Count the elements in the collection.
      Console.WriteLine("Allowed User Count: {0}", _
        myStrCollection.Count)

      ' Call the Contains method.
      Console.WriteLine("Contains 'userName1': {0}", _
        myStrCollection.Contains("userName1"))

      ' Determine the index of an element 
      ' in the collection.
      Console.WriteLine("IndexOf 'userName0': {0}", _
        myStrCollection.IndexOf("userName0"))

      ' Call IsModified.
      Console.WriteLine("IsModified: {0}", _
        myStrCollection.IsModified)

      ' Call IsReadyOnly.
      Console.WriteLine("IsReadOnly: {0}", _
        myStrCollection.IsReadOnly)

      Console.WriteLine()
      Console.WriteLine("Add a user name to the collection.")
      ' Insert a new element in the collection.
      myStrCollection.Insert(myStrCollection.Count, "userNameX")

      Console.WriteLine("Collection Value: {0}", _
        myStrCollection.ToString())

      Console.WriteLine()
      Console.WriteLine("Remove a user name from the collection.")
      ' Remove an element of the collection.
      myStrCollection.Remove("userNameX")

      Console.WriteLine("Collection Value: {0}", _
        myStrCollection.ToString())

      ' Display and wait
      Console.ReadLine()
    End Sub 
  End Class 
End Namespace

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft