DesignerActionMethodItem Class

 

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

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

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

Public Class DesignerActionMethodItem
	Inherits DesignerActionItem

NameDescription
System_CAPS_pubmethodDesignerActionMethodItem(DesignerActionList, String, String)

Initializes a new instance of the DesignerActionMethodItem class, with the specified method and display names.

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

System_CAPS_pubmethodDesignerActionMethodItem(DesignerActionList, String, String, String)

Initializes a new instance of the DesignerActionMethodItem class, with the specified method, display, and category names.

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

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

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

NameDescription
System_CAPS_pubpropertyAllowAssociate

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

System_CAPS_pubpropertyCategory

Gets the group name for an item.(Inherited from DesignerActionItem.)

System_CAPS_pubpropertyDescription

Gets the supplemental text for the item.(Inherited from DesignerActionItem.)

System_CAPS_pubpropertyDisplayName

Gets the text for this item.(Inherited from DesignerActionItem.)

System_CAPS_pubpropertyIncludeAsDesignerVerb

Gets a value that indicates the DesignerActionMethodItem should appear in other user interface contexts.

System_CAPS_pubpropertyMemberName

Gets the name of the method that this DesignerActionMethodItem is associated with.

System_CAPS_pubpropertyProperties

Gets a reference to a collection that can be used to store programmer-defined key/value pairs.(Inherited from DesignerActionItem.)

System_CAPS_pubpropertyRelatedComponent

Gets or sets a component that contributes its DesignerActionMethodItem objects to the current panel.

System_CAPS_pubpropertyShowInSourceView

Gets or sets a value that indicates whether this item appears in source code view.(Inherited from DesignerActionItem.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInvoke()

Programmatically executes the method associated with the DesignerActionMethodItem.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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

.NET Framework
Available since 2.0

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

Return to top
Show: