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

Overloads

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

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

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

public:
 DesignerActionMethodItem(System::ComponentModel::Design::DesignerActionList ^ actionList, System::String ^ memberName, System::String ^ displayName);

public DesignerActionMethodItem (System.ComponentModel.Design.DesignerActionList actionList, string memberName, string displayName);

new System.ComponentModel.Design.DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionList * string * string -> System.ComponentModel.Design.DesignerActionMethodItem

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

Parameters

actionList: DesignerActionList

The DesignerActionList that contains the method this item is associated with.

memberName: String

The case-sensitive name of the method in the class derived from DesignerActionList to invoke through the panel item.

displayName: String

The panel text for this item.

Remarks

The DesignerActionMethodItem constructor sets the Category and Description properties to null, and the IncludeAsDesignerVerb property to false.

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, Boolean)

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

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:
 DesignerActionMethodItem(System::ComponentModel::Design::DesignerActionList ^ actionList, System::String ^ memberName, System::String ^ displayName, bool includeAsDesignerVerb);

public DesignerActionMethodItem (System.ComponentModel.Design.DesignerActionList actionList, string memberName, string displayName, bool includeAsDesignerVerb);

new System.ComponentModel.Design.DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionList * string * string * bool -> System.ComponentModel.Design.DesignerActionMethodItem

Public Sub New (actionList As DesignerActionList, memberName As String, displayName As String, includeAsDesignerVerb As Boolean)

Parameters

actionList: DesignerActionList

The DesignerActionList that contains the method this item is associated with.

memberName: String

The case-sensitive name of the method in the class derived from DesignerActionList to invoke through the panel item.

displayName: String

The panel text for this item.

includeAsDesignerVerb: Boolean

A flag that specifies whether to also treat the associated method as a designer verb.

Remarks

If the includeAsDesignerVerb parameter is set to true, then this item is also considered a DesignerVerb; therefore, it will be added to the component's design-time shortcut menu. In Visual Studio, a command will also be added to the Attributes pane of the Properties window. A list of designer verbs can be accessed through the designer's Verbs collection property.

The DesignerActionMethodItem constructor sets the Category and Description properties to null.

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String)

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

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

public:
 DesignerActionMethodItem(System::ComponentModel::Design::DesignerActionList ^ actionList, System::String ^ memberName, System::String ^ displayName, System::String ^ category);

public DesignerActionMethodItem (System.ComponentModel.Design.DesignerActionList actionList, string memberName, string displayName, string category);

new System.ComponentModel.Design.DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionList * string * string * string -> System.ComponentModel.Design.DesignerActionMethodItem

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

Parameters

actionList: DesignerActionList

The DesignerActionList that contains the method this item is associated with.

memberName: String

The case-sensitive name of the method in the class derived from DesignerActionList to invoke through the 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 DesignerActionMethodItem constructor sets the Description property to null and the IncludeAsDesignerVerb property to false.

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

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String, Boolean)

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

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:
 DesignerActionMethodItem(System::ComponentModel::Design::DesignerActionList ^ actionList, System::String ^ memberName, System::String ^ displayName, System::String ^ category, bool includeAsDesignerVerb);

public DesignerActionMethodItem (System.ComponentModel.Design.DesignerActionList actionList, string memberName, string displayName, string category, bool includeAsDesignerVerb);

new System.ComponentModel.Design.DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionList * string * string * string * bool -> System.ComponentModel.Design.DesignerActionMethodItem

Public Sub New (actionList As DesignerActionList, memberName As String, displayName As String, category As String, includeAsDesignerVerb As Boolean)

Parameters

actionList: DesignerActionList

The DesignerActionList that contains the method this item is associated with.

memberName: String

The case-sensitive name of the method in the class derived from DesignerActionList to invoke through the panel item.

displayName: String

The panel text for this item.

category: String

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

includeAsDesignerVerb: Boolean

A flag that specifies whether to also treat the associated method as a designer verb for the associated component.

Remarks

If the includeAsDesignerVerb parameter is set to true, then the item is also considered a DesignerVerb; therefore, it will be added to the component's design-time shortcut menu. A list of designer verbs can be accessed through the designer's Verbs collection property.

The DesignerActionMethodItem constructor sets the Description property to null.

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

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String, String)

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

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

public:
 DesignerActionMethodItem(System::ComponentModel::Design::DesignerActionList ^ actionList, System::String ^ memberName, System::String ^ displayName, System::String ^ category, System::String ^ description);

public DesignerActionMethodItem (System.ComponentModel.Design.DesignerActionList actionList, string memberName, string displayName, string category, string description);

new System.ComponentModel.Design.DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionList * string * string * string * string -> System.ComponentModel.Design.DesignerActionMethodItem

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

Parameters

actionList: DesignerActionList

The DesignerActionList that contains the method this item is associated with.

memberName: String

The case-sensitive name of the method in the class derived from DesignerActionList to invoke through the 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.

Remarks

The DesignerActionMethodItem constructor sets the IncludeAsDesignerVerb property to false.

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

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String, String, Boolean)

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

Source:: DesignerActionMethodItem.cs

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.

public:
 DesignerActionMethodItem(System::ComponentModel::Design::DesignerActionList ^ actionList, System::String ^ memberName, System::String ^ displayName, System::String ^ category, System::String ^ description, bool includeAsDesignerVerb);

public DesignerActionMethodItem (System.ComponentModel.Design.DesignerActionList actionList, string memberName, string displayName, string category, string description, bool includeAsDesignerVerb);

new System.ComponentModel.Design.DesignerActionMethodItem : System.ComponentModel.Design.DesignerActionList * string * string * string * string * bool -> System.ComponentModel.Design.DesignerActionMethodItem

Public Sub New (actionList As DesignerActionList, memberName As String, displayName As String, category As String, description As String, includeAsDesignerVerb As Boolean)

Parameters

actionList: DesignerActionList

The DesignerActionList that contains the method this item is associated with.

memberName: String

The case-sensitive name of the method in the class derived from DesignerActionList to invoke through the 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.

includeAsDesignerVerb: Boolean

A flag that specifies whether to also treat the associated method as a designer verb for the associated component.

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

If the includeAsDesignerVerb parameter is set to true, then this item is also considered a DesignerVerb; therefore, it will be added to the component's design-time shortcut menu. A list of designer verbs can be accessed through the designer's Verbs collection property.

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

Applies to

Share via

DesignerActionMethodItem Constructors

Definition

Overloads

DesignerActionMethodItem(DesignerActionList, String, String)

Parameters

Remarks

See also

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, Boolean)

Parameters

Remarks

See also

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String)

Parameters

Remarks

See also

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String, Boolean)

Parameters

Remarks

See also

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String, String)

Parameters

Remarks

See also

Applies to

DesignerActionMethodItem(DesignerActionList, String, String, String, String, Boolean)

Parameters

Examples

Remarks

See also

Applies to

Additional resources