ParameterCollectionEditor Class

Reference

Definition

Namespace:: System.Web.UI.Design.WebControls

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 component editor for the ParameterCollection object that is specified by the Parameters properties of the associated data source control.

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

public class ParameterCollectionEditor : System.Drawing.Design.UITypeEditor

type ParameterCollectionEditor = class
    inherit UITypeEditor

Public Class ParameterCollectionEditor
Inherits UITypeEditor

Inheritance: Object

UITypeEditor
ParameterCollectionEditor

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.

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

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

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.

Constructors

ParameterCollectionEditor()

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

Applies to

Compartir a través de