ParameterCollectionEditor Class (System.Web.UI.Design.WebControls)

Switch View :
ScriptFree
.NET Framework Class Library
ParameterCollectionEditor Class

Provides a component editor for the ParameterCollection object that is specified by the Parameters properties of the associated data source control.

Inheritance Hierarchy

System.Object
  System.Drawing.Design.UITypeEditor
    System.Web.UI.Design.WebControls.ParameterCollectionEditor

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

Visual Basic
Public Class ParameterCollectionEditor _
	Inherits UITypeEditor
C#
public class ParameterCollectionEditor : UITypeEditor
Visual C++
public ref class ParameterCollectionEditor : public UITypeEditor
F#
type ParameterCollectionEditor =  
    class
        inherit UITypeEditor
    end

The ParameterCollectionEditor type exposes the following members.

Constructors

  Name Description
Public method ParameterCollectionEditor Infrastructure. Initializes a new instance of the ParameterCollectionEditor 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 elements of the ParameterCollection objects of the associated data source control. (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) Gets the editing style that is associated with this editor. (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.)
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.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

The ParameterCollectionEditor class provides a user interface for editing the Parameter elements of the ParameterCollection object at design time, as specified by one of the Parameters properties. The Parameters properties include the DeleteParameters, FilterParameters, InsertParameters, SelectParameters and UpdateParameters properties of the ObjectDataSource, SqlDataSource, and other data source controls.

The ParameterCollectionEditor is invoked by selecting the ellipsis () button on one of the Parameters properties in the Properties grid of the visual designer.

The EditValue method edits the Parameter elements of the ParameterCollection for the associated data source control. The GetEditStyle method gets the editing style that is associated with this editor.

Examples

The following code example shows how to use the EditorAttribute attribute to associate the ParameterCollectionEditor and UITypeEditor (the collection editor base class) classes with a SelectParameters property in a custom control.

Visual Basic

Private selectParams As ParameterCollection

' Associate the ParameterCollectionEditor with the SelectParameters. 
<EditorAttribute(GetType(System.Web.UI.Design.WebControls. _
    ParameterCollectionEditor), _
    GetType(UITypeEditor))> _
Public Property SelectParameters() As ParameterCollection
    Get
        If selectParams Is Nothing Then
            selectParams = New ParameterCollection()
        End If
        Return selectParams
    End Get
    Set(ByVal value As ParameterCollection)
        selectParams = value
    End Set
End Property ' SelectParameters


C#

private ParameterCollection selectParams;

// Associate the ParameterCollectionEditor with the SelectParameters. 
[Editor(typeof(System.Web.UI.Design.WebControls.
    ParameterCollectionEditor),
    typeof(UITypeEditor))]
public ParameterCollection SelectParameters
{
    get
    {
        // If there is no selectParams collection, create it.
        if (selectParams == null)
            selectParams = new ParameterCollection();

        return selectParams;
    }
    set { selectParams = value; }
} // SelectParameters


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