DesignerActionMethodItem Class
TOC
Collapse the table of content
Expand the table of content

DesignerActionMethodItem Class

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

System.Object
  System.ComponentModel.Design.DesignerActionItem
    System.ComponentModel.Design.DesignerActionMethodItem

Namespace:  System.ComponentModel.Design
Assembly:  System.Design (in System.Design.dll)

public class DesignerActionMethodItem : DesignerActionItem

The DesignerActionMethodItem type exposes the following members.

  NameDescription
Public methodDesignerActionMethodItem(DesignerActionList, String, String)Initializes a new instance of the DesignerActionMethodItem class, with the specified method and display names.
Public methodDesignerActionMethodItem(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.
Public methodDesignerActionMethodItem(DesignerActionList, String, String, String)Initializes a new instance of the DesignerActionMethodItem class, with the specified method, display, and category names.
Public methodDesignerActionMethodItem(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.
Public methodDesignerActionMethodItem(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.
Public methodDesignerActionMethodItem(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.
Top

  NameDescription
Public propertyAllowAssociateGets 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.)
Public propertyCategoryGets the group name for an item. (Inherited from DesignerActionItem.)
Public propertyDescriptionGets the supplemental text for the item. (Inherited from DesignerActionItem.)
Public propertyDisplayNameGets the text for this item. (Inherited from DesignerActionItem.)
Public propertyIncludeAsDesignerVerbGets a value that indicates the DesignerActionMethodItem should appear in other user interface contexts.
Public propertyMemberNameGets the name of the method that this DesignerActionMethodItem is associated with.
Public propertyPropertiesGets a reference to a collection that can be used to store programmer-defined key/value pairs. (Inherited from DesignerActionItem.)
Public propertyRelatedComponentGets or sets a component that contributes its DesignerActionMethodItem objects to the current panel.
Top

  NameDescription
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 methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInvokeProgrammatically executes the method associated with the DesignerActionMethodItem.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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;
}


.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.

Community Additions

ADD
Show:
© 2016 Microsoft