DesignerActionTextItem Class

 

Represents a static text item on a smart tag panel.

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


Public Class DesignerActionTextItem
	Inherits DesignerActionItem

NameDescription
System_CAPS_pubmethodDesignerActionTextItem(String, String)

Initializes a new instance of the DesignerActionTextItem class.

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_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_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 DesignerActionTextItem class represents individual static text items in a smart tag panel. Individual items are associated together to form a panel by returning the group from a call to the GetSortedActionItems method.

Most commonly, a static text item is used to create an informative label in a panel. Clicking on a static text item causes no action. The derived type DesignerActionHeaderItem is typically used to create labels to separate categories.

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: