ConnectionStringEditor Class

Definition

public ref class ConnectionStringEditor : System::Drawing::Design::UITypeEditor

public class ConnectionStringEditor : System.Drawing.Design.UITypeEditor

type ConnectionStringEditor = class
    inherit UITypeEditor

Public Class ConnectionStringEditor
Inherits UITypeEditor

Inheritance

Object

UITypeEditor

ConnectionStringEditor

Derived

System.Web.UI.Design.WebControls.SqlDataSourceConnectionStringEditor

Examples

The following code example demonstrates how to associate an instance of the ConnectionStringEditor class with a property that is contained within a custom control. When the control property is edited in the design surface, the ConnectionStringEditor class provides the user interface to select and edit a connection string for the property value.

// Define a custom class derived from the SqlDataSource Web control. 
public class SqlDataSourceWithBackup : SqlDataSource
{
    private string _alternateConnectionString;

    // Define an alternate connection string, which could be used
    // as a fallback value if the primary connection string fails.
    
    // The EditorAttribute indicates the property can
    // be edited at design-time with the ConnectionStringEditor class.
    [
      DefaultValue(""),
      EditorAttribute(typeof(System.Web.UI.Design.ConnectionStringEditor),
                     typeof(System.Drawing.Design.UITypeEditor)),
      Category("Data"),
      Description("The alternate connection string.")
    ]
    public string AlternateConnectionString
    {
        get
        {
            return _alternateConnectionString;
        }
        set
        {
            _alternateConnectionString = value;
        }
    }
}

' Define a custom class derived from the SqlDataSource Web control. 
Public Class SqlDataSourceWithBackup
    Inherits SqlDataSource

    Private _alternateConnectionString As String

    ' Define an alternate connection string, which could be used
    ' as a fallback value if the primary connection string fails.

    ' The EditorAttribute indicates the property can
    ' be edited at design-time with the ConnectionStringEditor class.
    <DefaultValue(""), _
     EditorAttribute(GetType(System.Web.UI.Design.ConnectionStringEditor), _
         GetType(System.Drawing.Design.UITypeEditor)), _
     Category("Data"), _
     Description("The alternate connection string.")> _
   Public Property AlternateConnectionString() As String

        Get
            Return _alternateConnectionString
        End Get
        Set(ByVal value As String)
            _alternateConnectionString = value
        End Set
    End Property

End Class

Remarks

An instance of the ConnectionStringEditor class is a UITypeEditor object that can be used at design time to select and edit a connection string expression and to assign the expression to a control property. For example, the SqlDataSource control uses the ConnectionStringEditor class at design time to set the value of the ConnectionString property.

Use the EditorAttribute attribute to associate the ConnectionStringEditor with a property. When the associated property is edited on the design surface, the designer host calls the EditValue method. The EditValue method displays a user interface for building the connection string expression and returns the connection string that is selected by the user. The GetEditStyle method indicates the display style of the user interface.

Constructors

Properties

Methods

Applies to

See also

• UITypeEditor
• ConnectionStringsExpressionEditor
• SqlDataSource
• SqlDataSourceDesigner
• EditorAttribute
• Connection Strings in ADO.NET