Export (0) Print
Expand All

DbConnectionStringBuilder.Item Property

Gets or sets the value associated with the specified key.

Namespace: System.Data.Common
Assembly: System.Data (in system.data.dll)

public virtual Object this [
	string keyword
] { get; set; }
/** @property */
public Object get_Item (String keyword)

/** @property */
public void set_Item (String keyword, Object value)

Not applicable.

Parameters

keyword

The key of the item to get or set.

Property Value

The value associated with the specified key. If the specified key is not found, trying to get it returns a null reference (Nothing in Visual Basic), and trying to set it creates a new element using the specified key. Passing a null (Nothing in Visual Basic) key throws an ArgumentNullException. Assigning a null value removes the key/value pair.

Exception typeCondition

ArgumentNullException

keyword is a null reference (Nothing in Visual Basic).

NotSupportedException

The property is set, and the DbConnectionStringBuilder is read-only.

-or-

The property is set, keyword does not exist in the collection, and the DbConnectionStringBuilder has a fixed size.

When you set this property, if the specified key already exists in the dictionary, the value is replaced; otherwise, a new element is created.

The following console application creates a new DbConnectionStringBuilder and adds key/value pairs to its connection string, using the Item property.

static void Main()
{
    DbConnectionStringBuilder builder = new
        DbConnectionStringBuilder();
    builder["Data Source"] = "(local)";

    // Note that Item is the indexer, so 
    // you do not include it in the reference.
    builder["integrated security"] = true;
    builder["Initial Catalog"] = "AdventureWorks";

    // Overwrite the existing value for the Data Source key, 
    // because it already exists within the collection.
    builder["Data Source"] = ".";

    Console.WriteLine(builder.ConnectionString);
    Console.WriteLine();
    Console.WriteLine("Press Enter to continue.");
    Console.ReadLine();
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft