ConnectionStringEditor Class (System.Web.UI.Design)

Switch View :
ScriptFree
.NET Framework Class Library
ConnectionStringEditor Class

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

Inheritance Hierarchy

System.Object
  System.Drawing.Design.UITypeEditor
    System.Web.UI.Design.ConnectionStringEditor
      System.Web.UI.Design.WebControls.SqlDataSourceConnectionStringEditor

Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)
Syntax

Visual Basic
<SecurityPermissionAttribute(SecurityAction.Demand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Class ConnectionStringEditor _
	Inherits UITypeEditor
C#
[SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public class ConnectionStringEditor : UITypeEditor
Visual C++
[SecurityPermissionAttribute(SecurityAction::Demand, Flags = SecurityPermissionFlag::UnmanagedCode)]
public ref class ConnectionStringEditor : public UITypeEditor
F#
[<SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
type ConnectionStringEditor =  
    class
        inherit UITypeEditor
    end

The ConnectionStringEditor type exposes the following members.

Constructors

  Name Description
Public method ConnectionStringEditor Initializes a new instance of the ConnectionStringEditor class.
Top
Properties

  Name Description
Public property IsDropDownResizable Gets a value indicating whether drop-down editors should be resizable by the user. (Inherited from UITypeEditor.)
Top
Methods

  Name Description
Public method EditValue(IServiceProvider, Object) Edits the value of the specified object using the editor style indicated by the GetEditStyle method. (Inherited from UITypeEditor.)
Public method EditValue(ITypeDescriptorContext, IServiceProvider, Object) Edits the value of the specified object by using the specified service provider and context. (Overrides UITypeEditor.EditValue(ITypeDescriptorContext, IServiceProvider, Object).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEditStyle() Gets the editor style used by the EditValue method. (Inherited from UITypeEditor.)
Public method GetEditStyle(ITypeDescriptorContext) Returns the editing style that is associated with the connection string editor for the specified context. (Overrides UITypeEditor.GetEditStyle(ITypeDescriptorContext).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPaintValueSupported() Indicates whether this editor supports painting a representation of an object's value. (Inherited from UITypeEditor.)
Public method GetPaintValueSupported(ITypeDescriptorContext) Indicates whether the specified context supports painting a representation of an object's value within the specified context. (Inherited from UITypeEditor.)
Protected method GetProviderName Returns the provider name for the provided instance of the ConnectionStringEditor class.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method PaintValue(PaintValueEventArgs) Paints a representation of the value of an object using the specified PaintValueEventArgs. (Inherited from UITypeEditor.)
Public method PaintValue(Object, Graphics, Rectangle) Paints a representation of the value of the specified object to the specified canvas. (Inherited from UITypeEditor.)
Protected method SetProviderName Puts the provider name on the specified instance of the ConnectionStringEditor class.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
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.

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.

Visual Basic

' 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


C#

// 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;
        }

    }

}


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

Other Resources