DesignerActionPropertyItem Constructors

Reference

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.Design.dll

Assembly:: System.Windows.Forms.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.

Initializes a new instance of the DesignerActionPropertyItem class.

Overloads

DesignerActionPropertyItem(String, String)	Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and display names.
DesignerActionPropertyItem(String, String, String)	Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and category names, and display text.
DesignerActionPropertyItem(String, String, String, String)	Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and category names, and display and description text.

DesignerActionPropertyItem(String, String)

Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and display names.

public:
 DesignerActionPropertyItem(System::String ^ memberName, System::String ^ displayName);

public DesignerActionPropertyItem (string memberName, string displayName);

public DesignerActionPropertyItem (string memberName, string? displayName);

new System.ComponentModel.Design.DesignerActionPropertyItem : string * string -> System.ComponentModel.Design.DesignerActionPropertyItem

Public Sub New (memberName As String, displayName As String)

Parameters

memberName: String

The case-sensitive name of the property associated with this panel item.

displayName: String

The panel text for this item.

Remarks

The DesignerActionPropertyItem(String, String) constructor sets the Category and Description properties to null.

The memberName parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from the DesignerActionList class.

Applies to

DesignerActionPropertyItem(String, String, String)

Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and category names, and display text.

public:
 DesignerActionPropertyItem(System::String ^ memberName, System::String ^ displayName, System::String ^ category);

public DesignerActionPropertyItem (string memberName, string displayName, string category);

public DesignerActionPropertyItem (string memberName, string? displayName, string? category);

new System.ComponentModel.Design.DesignerActionPropertyItem : string * string * string -> System.ComponentModel.Design.DesignerActionPropertyItem

Public Sub New (memberName As String, displayName As String, category As String)

Parameters

memberName: String

The case-sensitive name of the property associated with this panel item.

displayName: String

The panel text for this item.

category: String

The case-sensitive String used to group similar items on the panel.

Remarks

The DesignerActionPropertyItem(String, String, String) constructor sets the Description property to null.

For more information about how the category parameter is used to group items on a panel, see the GetSortedActionItems method.

The memberName parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from DesignerActionList.

Applies to

DesignerActionPropertyItem(String, String, String, String)

Initializes a new instance of the DesignerActionPropertyItem class, with the specified property and category names, and display and description text.

public:
 DesignerActionPropertyItem(System::String ^ memberName, System::String ^ displayName, System::String ^ category, System::String ^ description);

public DesignerActionPropertyItem (string memberName, string displayName, string category, string description);

public DesignerActionPropertyItem (string memberName, string? displayName, string? category, string? description);

new System.ComponentModel.Design.DesignerActionPropertyItem : string * string * string * string -> System.ComponentModel.Design.DesignerActionPropertyItem

Public Sub New (memberName As String, displayName As String, category As String, description As String)

Parameters

memberName: String

The case-sensitive name of the property associated with this panel item.

displayName: String

The panel text for this item.

category: String

The case-sensitive String used to group similar items on the panel.

description: String

Supplemental text for this item, used in ToolTips or the status bar.

Examples

The following code example demonstrates how to create a collection of DesignerActionItem objects. For a full example of implementing smart tags, see How to: Attach Smart Tags to a Windows Forms Component.

public override DesignerActionItemCollection GetSortedActionItems()
{
    DesignerActionItemCollection items = new DesignerActionItemCollection();

    //Define static section header entries.
    items.Add(new DesignerActionHeaderItem("Appearance"));
    items.Add(new DesignerActionHeaderItem("Information"));

    //Boolean property for locking color selections.
    items.Add(new DesignerActionPropertyItem("LockColors",
                     "Lock Colors", "Appearance",
                     "Locks the color properties."));
    if (!LockColors)
    {
        items.Add(new DesignerActionPropertyItem("BackColor",
                         "Back Color", "Appearance",
                         "Selects the background color."));
        items.Add(new DesignerActionPropertyItem("ForeColor",
                         "Fore Color", "Appearance",
                         "Selects the foreground color."));

        //This next method item is also added to the context menu 
        // (as a designer verb).
        items.Add(new DesignerActionMethodItem(this,
                         "InvertColors", "Invert Colors",
                         "Appearance",
                         "Inverts the fore and background colors.",
                          true));
    }
    items.Add(new DesignerActionPropertyItem("Text",
                     "Text String", "Appearance",
                     "Sets the display text."));

    //Create entries for static Information section.
    StringBuilder location = new StringBuilder("Location: ");
    location.Append(colLabel.Location);
    StringBuilder size = new StringBuilder("Size: ");
    size.Append(colLabel.Size);
    items.Add(new DesignerActionTextItem(location.ToString(),
                     "Information"));
    items.Add(new DesignerActionTextItem(size.ToString(),
                     "Information"));

    return items;
}

Public Overrides Function GetSortedActionItems() _
As DesignerActionItemCollection
    Dim items As New DesignerActionItemCollection()

    'Define static section header entries.
    items.Add(New DesignerActionHeaderItem("Appearance"))
    items.Add(New DesignerActionHeaderItem("Information"))

    'Boolean property for locking color selections.
    items.Add(New DesignerActionPropertyItem( _
    "LockColors", _
    "Lock Colors", _
    "Appearance", _
    "Locks the color properties."))

    If Not LockColors Then
        items.Add( _
        New DesignerActionPropertyItem( _
        "BackColor", _
        "Back Color", _
        "Appearance", _
        "Selects the background color."))

        items.Add( _
        New DesignerActionPropertyItem( _
        "ForeColor", _
        "Fore Color", _
        "Appearance", _
        "Selects the foreground color."))

        'This next method item is also added to the context menu 
        ' (as a designer verb).
        items.Add( _
        New DesignerActionMethodItem( _
        Me, _
        "InvertColors", _
        "Invert Colors", _
        "Appearance", _
        "Inverts the fore and background colors.", _
        True))
    End If
    items.Add( _
    New DesignerActionPropertyItem( _
    "Text", _
    "Text String", _
    "Appearance", _
    "Sets the display text."))

    'Create entries for static Information section.
    Dim location As New StringBuilder("Location: ")
    location.Append(colLabel.Location)
    Dim size As New StringBuilder("Size: ")
    size.Append(colLabel.Size)

    items.Add( _
    New DesignerActionTextItem( _
    location.ToString(), _
    "Information"))

    items.Add( _
    New DesignerActionTextItem( _
    size.ToString(), _
    "Information"))

    Return items
End Function

Remarks

For more information about how the category parameter is used to group items on a panel, see the GetSortedActionItems method.

The memberName parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from the DesignerActionList class.

Applies to

Share via

DesignerActionPropertyItem Constructors

Definition

Overloads

DesignerActionPropertyItem(String, String)

Parameters

Remarks

See also

Applies to

DesignerActionPropertyItem(String, String, String)

Parameters

Remarks

See also

Applies to

DesignerActionPropertyItem(String, String, String, String)

Parameters

Examples

Remarks

See also

Applies to

Additional resources