DesignerActionMethodItem Class

Definition

Namespace:

System.ComponentModel.Design

Assembly:

System.Windows.Forms.Design.dll

Source:

DesignerActionMethodItem.cs

Represents a smart tag panel item that is associated with a method in a class derived from DesignerActionList.

public ref class DesignerActionMethodItem : System::ComponentModel::Design::DesignerActionItem

public class DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionItem

type DesignerActionMethodItem = class
    inherit DesignerActionItem

Public Class DesignerActionMethodItem
Inherits DesignerActionItem

Inheritance

Object

DesignerActionItem

DesignerActionMethodItem

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

The DesignerActionMethodItem class represents individual items in a smart tag panel. An item of this type is displayed as an active user interface element, such as a hyperlink, that invokes a programmer-supplied method in a class derived from DesignerActionList. The association between the item and the method is maintained through the value of the MemberName property. The method that this item invokes must neither take parameters nor return a value.

Individual panel items are associated together to form a panel by a call to the GetSortedActionItems method of the DesignerActionList class.

Constructors

DesignerActionMethodItem(DesignerActionList, String, String, Boolean)	Initializes a new instance of the DesignerActionMethodItem class, with the specified method and display names, and a flag that indicates whether the item should appear in other user interface contexts.
DesignerActionMethodItem(DesignerActionList, String, String, String, Boolean)	Initializes a new instance of the DesignerActionMethodItem class, with the specified method, display, and category names, and a flag that indicates whether the item should appear in other user interface contexts.
DesignerActionMethodItem(DesignerActionList, String, String, String, String, Boolean)	Initializes a new instance of the DesignerActionMethodItem class, with the specified method and category names, display and description text, and a flag that indicates whether the item should appear in other user interface contexts.
DesignerActionMethodItem(DesignerActionList, String, String, String, String)	Initializes a new instance of the DesignerActionMethodItem class, with the specified method and category names, and display and description text.
DesignerActionMethodItem(DesignerActionList, String, String, String)	Initializes a new instance of the DesignerActionMethodItem class, with the specified method, display, and category names.
DesignerActionMethodItem(DesignerActionList, String, String)	Initializes a new instance of the DesignerActionMethodItem class, with the specified method and display names.

Properties

AllowAssociate	Gets or sets a value indicating whether to allow this item to be placed into a group of items that have the same Category property value. (Inherited from DesignerActionItem)
Category	Gets the group name for an item. (Inherited from DesignerActionItem)
Description	Gets the supplemental text for the item. (Inherited from DesignerActionItem)
DisplayName	Gets the text for this item. (Inherited from DesignerActionItem)
IncludeAsDesignerVerb	Gets a value that indicates the DesignerActionMethodItem should appear in other user interface contexts.
MemberName	Gets the name of the method that this DesignerActionMethodItem is associated with.
Properties	Gets a reference to a collection that can be used to store programmer-defined key/value pairs. (Inherited from DesignerActionItem)
RelatedComponent	Gets or sets a component that contributes its DesignerActionMethodItem objects to the current panel.
ShowInSourceView	Gets or sets a value that indicates whether this item appears in source code view. (Inherited from DesignerActionItem)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Invoke()	Programmatically executes the method associated with the DesignerActionMethodItem.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• DesignerActionList
• GetSortedActionItems()
• MemberName
• Designer Commands and the DesignerAction Object Model for Windows Forms