This documentation is archived and is not being maintained.

ParameterCollectionEditor Class

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


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

public class ParameterCollectionEditor : UITypeEditor

The ParameterCollectionEditor type exposes the following members.

Public methodParameterCollectionEditorInfrastructure. Initializes a new instance of the ParameterCollectionEditor class.

Public propertyIsDropDownResizableGets a value indicating whether drop-down editors should be resizable by the user. (Inherited from UITypeEditor.)

Public methodEditValue(IServiceProvider, Object)Edits the value of the specified object using the editor style indicated by the GetEditStyle method. (Inherited from UITypeEditor.)
Public methodEditValue(ITypeDescriptorContext, IServiceProvider, Object)Edits the elements of the ParameterCollection objects of the associated data source control. (Overrides UITypeEditor.EditValue(ITypeDescriptorContext, IServiceProvider, Object).)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEditStyle()Gets the editor style used by the EditValue method. (Inherited from UITypeEditor.)
Public methodGetEditStyle(ITypeDescriptorContext)Gets the editing style that is associated with this editor. (Overrides UITypeEditor.GetEditStyle(ITypeDescriptorContext).)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetPaintValueSupported()Indicates whether this editor supports painting a representation of an object's value. (Inherited from UITypeEditor.)
Public methodGetPaintValueSupported(ITypeDescriptorContext)Indicates whether the specified context supports painting a representation of an object's value within the specified context. (Inherited from UITypeEditor.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPaintValue(PaintValueEventArgs)Paints a representation of the value of an object using the specified PaintValueEventArgs. (Inherited from UITypeEditor.)
Public methodPaintValue(Object, Graphics, Rectangle)Paints a representation of the value of the specified object to the specified canvas. (Inherited from UITypeEditor.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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.

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.

private ParameterCollection selectParams;

// Associate the ParameterCollectionEditor with the SelectParameters. 
public ParameterCollection SelectParameters
        // If there is no selectParams collection, create it.
        if (selectParams == null)
            selectParams = new ParameterCollection();

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

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.

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