ConnectionStringsSection Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

ConnectionStringsSection.cs

Provides programmatic access to the connection strings configuration-file section.

public ref class ConnectionStringsSection sealed : System::Configuration::ConfigurationSection

public sealed class ConnectionStringsSection : System.Configuration.ConfigurationSection

type ConnectionStringsSection = class
    inherit ConfigurationSection

Public NotInheritable Class ConnectionStringsSection
Inherits ConfigurationSection

Inheritance

Object

ConfigurationElement

ConfigurationSection

ConnectionStringsSection

Examples

The following example shows how to use the ConnectionStringsSection.

// Create a connection 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=True;" +
            "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);
}

' Create a connectionn string element and add it to
' the connection strings section.
Shared Sub New() 

    ' Get the application configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)
    
    ' Get the current connection strings count.
    Dim connStrCnt As Integer = _
    ConfigurationManager.ConnectionStrings.Count
    
    ' Create the connection string name. 
    Dim csName As String = "ConnStr" + connStrCnt.ToString()
    
    ' Create a connection string element and
    ' save it to the configuration file.
    ' Create a connection string element.
    Dim csSettings _
    As New ConnectionStringSettings( _
    csName, _
    "LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;" + _
    "Initial Catalog=aspnetdb", "System.Data.SqlClient")
    
    ' Get the connection strings section.
    Dim csSection _
    As ConnectionStringsSection = _
    config.ConnectionStrings
    
    ' Add the new element.
    csSection.ConnectionStrings.Add(csSettings)
    
    ' Save the configuration file.
    config.Save(ConfigurationSaveMode.Modified)

End Sub

Remarks

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.

Constructors

ConnectionStringsSection()

Initializes a new instance of the ConnectionStringsSection class.

Properties

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)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is null. (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)

Methods

DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
DeserializeSection(XmlReader)	Reads XML from the configuration file. (Inherited from ConfigurationSection)
Equals(Object)	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)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
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)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Reset(ConfigurationElement)	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(XmlWriter, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	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(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	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(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	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(FrameworkName)	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(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement)

See also

• ConnectionStringSettingsCollection
• ConnectionStringSettings