ConnectionStringEditor Class

Reference

Definition

Namespace:: System.Web.UI.Design

Assembly:: System.Design.dll

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.

Provides a base class for a user interface to select and edit a connection string property at design time.

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

ConnectionStringEditor()

Initializes a new instance of the ConnectionStringEditor class.

Properties

IsDropDownResizable

Gets a value indicating whether drop-down editors should be resizable by the user.

(Inherited from UITypeEditor)

Methods

EditValue(IServiceProvider, Object)	Edits the value of the specified object using the editor style indicated by the GetEditStyle() method. (Inherited from UITypeEditor)
EditValue(ITypeDescriptorContext, IServiceProvider, Object)	Edits the value of the specified object by using the specified service provider and context.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEditStyle()	Gets the editor style used by the EditValue(IServiceProvider, Object) method. (Inherited from UITypeEditor)
GetEditStyle(ITypeDescriptorContext)	Returns the editing style that is associated with the connection string editor for the specified context.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPaintValueSupported()	Indicates whether this editor supports painting a representation of an object's value. (Inherited from UITypeEditor)
GetPaintValueSupported(ITypeDescriptorContext)	Indicates whether the specified context supports painting a representation of an object's value within the specified context. (Inherited from UITypeEditor)
GetProviderName(Object)	Returns the provider name for the provided instance of the ConnectionStringEditor class.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
PaintValue(Object, Graphics, Rectangle)	Paints a representation of the value of the specified object to the specified canvas. (Inherited from UITypeEditor)
PaintValue(PaintValueEventArgs)	Paints a representation of the value of an object using the specified PaintValueEventArgs. (Inherited from UITypeEditor)
SetProviderName(Object, DesignerDataConnection)	Puts the provider name on the specified instance of the ConnectionStringEditor class.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via