CommaDelimitedStringCollection Class

 

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

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

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

public sealed class CommaDelimitedStringCollection : StringCollection

NameDescription
System_CAPS_pubmethodCommaDelimitedStringCollection()

Creates a new instance of the CommaDelimitedStringCollection class.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of strings contained in the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubpropertyIsModified

Gets a value that specifies whether the collection has been modified.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the collection object is read-only.

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether access to the StringCollection is synchronized (thread safe).(Inherited from StringCollection.)

System_CAPS_pubpropertyItem[Int32]

Gets or sets a string element in the collection based on the index.

System_CAPS_pubpropertySyncRoot

Gets an object that can be used to synchronize access to the StringCollection.(Inherited from StringCollection.)

NameDescription
System_CAPS_pubmethodAdd(String)

Adds a string to the comma-delimited collection.

System_CAPS_pubmethodAddRange(String[])

Adds all the strings in a string array to the collection.

System_CAPS_pubmethodClear()

Clears the collection.

System_CAPS_pubmethodClone()

Creates a copy of the collection.

System_CAPS_pubmethodContains(String)

Determines whether the specified string is in the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubmethodCopyTo(String[], Int32)

Copies the entire StringCollection values to a one-dimensional array of strings, starting at the specified index of the target array.(Inherited from StringCollection.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns a StringEnumerator that iterates through the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(String)

Searches for the specified string and returns the zero-based index of the first occurrence within the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubmethodInsert(Int32, String)

Adds a string element to the collection at the specified index.

System_CAPS_pubmethodRemove(String)

Removes a string element from the collection.

System_CAPS_pubmethodRemoveAt(Int32)

Removes the string at the specified index of the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubmethodSetReadOnly()

Sets the collection object to read-only.

System_CAPS_pubmethodToString()

Returns a string representation of the object.(Overrides Object.ToString().)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the entire StringCollection to a compatible one-dimensional Array, starting at the specified index of the target array.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Returns a IEnumerator that iterates through the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)

Adds an object to the end of the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

Determines whether an element is in the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

Searches for the specified Object and returns the zero-based index of the first occurrence within the entire StringCollection.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

Inserts an element into the StringCollection at the specified index.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

Removes the first occurrence of a specific object from the StringCollection.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

Gets a value indicating whether the StringCollection object has a fixed size.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsReadOnly

Gets a value indicating whether the StringCollection object is read-only.(Inherited from StringCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item[Int32]

Gets or sets the element at the specified index.(Inherited from StringCollection.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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.

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Collections;
using System.Web;
using System.Web.Configuration;
using System.Collections.Specialized;

namespace Samples.AspNet.Config
{
  class CommaDelimitedStrCollection
  {
    static void Main(string[] args)
    {
      // Display title and info.
      Console.WriteLine("ASP.NET Configuration Info");
      Console.WriteLine("Type: CommaDelimitedStringCollection");
      Console.WriteLine();

      // Set the path of the config file.
      string configPath = "/aspnet";

      // Get the Web application configuration object.
      Configuration config = 
        WebConfigurationManager.OpenWebConfiguration(configPath);

      // Get the section related object.
      AuthorizationSection configSection =
        (AuthorizationSection)config.GetSection("system.web/authorization");

      // Get the authorization rule collection.
      AuthorizationRuleCollection authorizationRuleCollection = 
        configSection.Rules;

      // Create a CommaDelimitedStringCollection object.
      CommaDelimitedStringCollection myStrCollection =
        new CommaDelimitedStringCollection();

      for (int i = 0; i < authorizationRuleCollection.Count; i++)
      {
        if (authorizationRuleCollection.Get(i).Action.ToString().ToLower() 
          == "allow")
        {
          // Add values to the CommaDelimitedStringCollection object.
          myStrCollection.AddRange(
            authorizationRuleCollection.Get(i).Users.ToString().Split(
            ",".ToCharArray()));
        }
      }

      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();
    }
  }
}

.NET Framework
Available since 2.0

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

Return to top
Show: