Export (0) Print
Expand All

SqlConnectionStringBuilder.Item Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the value associated with the specified key. In C#, this property is the indexer.

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

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

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

JScript supports the use of indexed properties, but not the declaration of new ones.

Parameters

keyword

The key of the item to get or set.

Property Value

The value associated with the specified key.

Exception typeCondition

ArgumentNullException

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

KeyNotFoundException

Tried to add a key that does not exist within the available keys.

FormatException

Invalid value within the connection string (specifically, a Boolean or numeric value was expected but not supplied).

Because the SqlConnectionStringBuilder contains a fixed-size dictionary, trying to add a key that does not exist within the dictionary throws a KeyNotFoundException.

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

class Program
{
    static void Main()
    {
        SqlConnectionStringBuilder builder = 
            new SqlConnectionStringBuilder();
        builder["Data Source"] = "(local)";
        builder["Integrated Security"] = true;
        builder["Initial Catalog"] = "AdventureWorks";

        // Overwrite the existing value for the Data Source value.
        builder["Data Source"] = ".";

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


Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft