DesignerActionHeaderItem Constructors

Definition

Namespace:

System.ComponentModel.Design

Assembly:

System.Windows.Forms.Design.dll

Initializes a new instance of the DesignerActionHeaderItem class.

Overloads

DesignerActionHeaderItem(String)	Initializes a new instance of the DesignerActionHeaderItem class using the provided name string.
DesignerActionHeaderItem(String, String)	Initializes a new instance of the DesignerActionHeaderItem class using the provided name and category strings.

DesignerActionHeaderItem(String)

Source:

DesignerActionHeaderItem.cs

Initializes a new instance of the DesignerActionHeaderItem class using the provided name string.

public:
 DesignerActionHeaderItem(System::String ^ displayName);

public DesignerActionHeaderItem (string displayName);

new System.ComponentModel.Design.DesignerActionHeaderItem : string -> System.ComponentModel.Design.DesignerActionHeaderItem

Public Sub New (displayName As String)

Parameters

displayName

String

The text to be displayed in the header.

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

This constructor sets both the DisplayName and the Category properties to the value of the displayName parameter and sets the Description property to null.

See also

• DisplayName
• Category
• Description
• GetSortedActionItems()
• Designer Commands and the DesignerAction Object Model for Windows Forms

DesignerActionHeaderItem(String, String)

Source:

DesignerActionHeaderItem.cs

Initializes a new instance of the DesignerActionHeaderItem class using the provided name and category strings.

public:
 DesignerActionHeaderItem(System::String ^ displayName, System::String ^ category);

public DesignerActionHeaderItem (string displayName, string category);

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

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

Parameters

displayName

String

The text to be displayed in the header.

category

String

The case-sensitive String that defines the groupings of panel entries.

Remarks

This constructor sets the Description property to null. The Category property is case-sensitive.

See also

• Category
• Description
• GetSortedActionItems()
• Designer Commands and the DesignerAction Object Model for Windows Forms