Export (0) Print
Expand All

DesignerActionHeaderItem Class

Represents a static header item on a smart tag panel. This class cannot be inherited.

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

public sealed class DesignerActionHeaderItem : DesignerActionTextItem

The DesignerActionHeaderItem type exposes the following members.

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

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 propertyPropertiesGets a reference to a collection that can be used to store programmer-defined key/value pairs. (Inherited from DesignerActionItem.)
Public propertyShowInSourceViewGets or sets a value that indicates whether this item appears in source code view. (Inherited from DesignerActionItem.)

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Like the DesignerActionTextItem base class, DesignerActionHeaderItem represents individual static text items in a smart tag panel. However, DesignerActionHeaderItem entries are displayed using bold text. Typically, a header item is used to create a heading for a group of items in a panel. Clicking on a header item causes no action.

Individual panel items are associated together to form a panel by calling 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",
                         "Inverts the fore and background colors.",
    items.Add(new DesignerActionPropertyItem("Text",
                     "Text String", "Appearance",
                     "Sets the display text."));

    //Create entries for static Information section.
    StringBuilder location = new StringBuilder("Location: ");
    StringBuilder size = new StringBuilder("Size: ");
    items.Add(new DesignerActionTextItem(location.ToString(),
    items.Add(new DesignerActionTextItem(size.ToString(),

    return items;

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
© 2014 Microsoft