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)

System.Object
  System.ComponentModel.Design.DesignerActionItem
    System.ComponentModel.Design.DesignerActionTextItem
      System.ComponentModel.Design.DesignerActionHeaderItem

public sealed class DesignerActionHeaderItem : DesignerActionTextItem

NameDescription
System_CAPS_pubmethodDesignerActionHeaderItem(String)

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

System_CAPS_pubmethodDesignerActionHeaderItem(String, String)

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

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_pubpropertyProperties

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

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_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_pubmethodToString()

Returns 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",
                         "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
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: