ConnectionStringsSection Class
Provides programmatic access to the connection strings configuration-file section.
System.Configuration.ConfigurationElement
System.Configuration.ConfigurationSection
System.Configuration.ConnectionStringsSection
Namespace: System.Configuration
Assembly: System.Configuration (in System.Configuration.dll)
The ConnectionStringsSection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ConnectionStringsSection | Infrastructure. Initializes a new instance of the ConnectionStringsSection class. |
| Name | Description | |
|---|---|---|
![]() | ConnectionStrings | Gets a ConnectionStringSettingsCollection collection of ConnectionStringSettings objects. |
![]() | CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.) |
![]() | ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.) |
![]() | Item[ConfigurationProperty] | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
![]() | Item[String] | Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.) |
![]() | LockAllAttributesExcept | Gets the collection of locked attributes. (Inherited from ConfigurationElement.) |
![]() | LockAllElementsExcept | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockAttributes | Gets the collection of locked attributes (Inherited from ConfigurationElement.) |
![]() | LockElements | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockItem | Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.) |
![]() | Properties | Gets the collection of properties. (Inherited from ConfigurationElement.) |
![]() | SectionInformation | Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection.) |
| Name | Description | |
|---|---|---|
![]() | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
![]() | DeserializeSection | Infrastructure. Reads XML from the configuration file. (Inherited from ConfigurationSection.) |
![]() | Equals | Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.) |
![]() | GetHashCode | Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.) |
![]() | GetRuntimeObject | Returns a custom object when overridden in a derived class. (Inherited from ConfigurationSection.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Init | Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.) |
![]() | InitializeDefault | Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | IsModified | Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class. (Inherited from ConfigurationSection.) |
![]() | IsReadOnly | Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.) |
![]() | Reset | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.) |
![]() | ResetModified | Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationSection.) |
![]() | SerializeElement | Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SerializeSection | Infrastructure. Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file. (Inherited from ConfigurationSection.) |
![]() | SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SetReadOnly | Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.) |
![]() | ShouldSerializeElementInTargetVersion | Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.) |
![]() | ShouldSerializePropertyInTargetVersion | Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.) |
![]() | ShouldSerializeSectionInTargetVersion | Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Unmerge | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.) |
The ConnectionStringsSection class allows you to programmatically modify the connectionStrings section of the configuration file. The connection strings are provided as a ConnectionStringSettingsCollection of ConnectionStringSettings add configuration elements.
| Topic | Location |
|---|---|
| How to: Access SQL Server Using Predetermined Credentials | Building ASP .NET Web Applications |
| How to: Read Connection Strings from the Web.config File | Configuring ASP .NET Web Applications |
| How to: Secure Connection Strings When Using Data Source Controls | Building ASP .NET Web Applications |
| How to: Read Connection Strings from the Web.config File | Configuring ASP .NET Web Applications |
| How to: Access SQL Server Using Predetermined Credentials | Building ASP .NET Web Applications |
| How to: Secure Connection Strings When Using Data Source Controls | Building ASP .NET Web Applications |
| How To: Secure Connection Strings when Using Data Source Controls (Visual Studio) | Building ASP .NET Web Applications in Visual Studio |
The following example shows how to use the ConnectionStringsSection.
// Create a connectionn string element and add it to // the connection strings section. static ConnectionStrings() { // Get the application configuration file. System.Configuration.Configuration config = ConfigurationManager.OpenExeConfiguration( ConfigurationUserLevel.None); // Get the current connection strings count. int connStrCnt = ConfigurationManager.ConnectionStrings.Count; // Create the connection string name. string csName = "ConnStr" + connStrCnt.ToString(); // Create a connection string element and // save it to the configuration file. // Create a connection string element. ConnectionStringSettings csSettings = new ConnectionStringSettings(csName, "LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;" + "Initial Catalog=aspnetdb", "System.Data.SqlClient"); // Get the connection strings section. ConnectionStringsSection csSection = config.ConnectionStrings; // Add the new element. csSection.ConnectionStrings.Add(csSettings); // Save the configuration file. config.Save(ConfigurationSaveMode.Modified); }
The following excerpt shows the configuration used by the previous example.
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<connectionStrings>
<add name="ConnStr1" connectionString="LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;Initial Catalog=aspnetdb"
providerName="System.Data.SqlClient" />
</connectionStrings>
</configuration>
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
