DbConnectionStringBuilder.Item[String] Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the value associated with the specified key.
public:
virtual property System::Object ^ default[System::String ^] { System::Object ^ get(System::String ^ keyword); void set(System::String ^ keyword, System::Object ^ value); };
public virtual object this[string keyword] { get; set; }
[System.ComponentModel.Browsable(false)]
public virtual object this[string keyword] { get; set; }
member this.Item(string) : obj with get, set
[<System.ComponentModel.Browsable(false)>]
member this.Item(string) : obj with get, set
Default Public Overridable Property Item(keyword As String) As Object
Parameters
- keyword
- String
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 throws an ArgumentException, 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.
- Attributes
Exceptions
The value for keyword
has not been set in the collection.
keyword
is a null reference (Nothing
in Visual Basic).
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.
Examples
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();
}
Module Module1
Sub Main()
Dim builder As New DbConnectionStringBuilder
builder.Item("Data Source") = "(local)"
' Item is the default property, so
' you need not include it in the reference.
builder("integrated security") = True
builder.Item("Initial Catalog") = "AdventureWorks"
' Overwrite the existing value for the data source value,
' because it already exists within the collection.
builder.Item("Data Source") = "."
Console.WriteLine(builder.ConnectionString)
Console.WriteLine()
Console.WriteLine("Press Enter to continue.")
Console.ReadLine()
End Sub
Remarks
When you set this property, if the specified key already exists in the dictionary, the value is replaced; otherwise, a new element is created.