SqlConnectionStringBuilder.Item Property (String)

 

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 Overrides Property Item (
	keyword As String
) As Object

Parameters

keyword
Type: System.String

The key of the item to get or set.

Property Value

Type: System.Object

The value associated with the specified key.

Exception Condition
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.

Module Module1
    Sub Main()
        Dim builder As New SqlConnectionStringBuilder
        builder.Item("Data Source") = "(local)"
        ' Item is the default property, so 
        ' you needn't include it in the reference.
        builder("Integrated Security") = True
        builder.Item("Initial Catalog") = "AdventureWorks"

        ' Overwrite the existing value for the Data Source value.
        builder.Item("Data Source") = "."

        Console.WriteLine(builder.ConnectionString)
        Console.WriteLine()
        Console.WriteLine("Press Enter to continue.")
        Console.ReadLine()
    End Sub
End Module

.NET Framework
Available since 2.0
Return to top
Show: