DesignerActionPropertyItem Class
Assembly: System.Design (in system.design.dll)
'Declaration Public NotInheritable Class DesignerActionPropertyItem Inherits DesignerActionItem 'Usage Dim instance As DesignerActionPropertyItem
public final class DesignerActionPropertyItem extends DesignerActionItem
public final class DesignerActionPropertyItem extends DesignerActionItem
Not applicable.
The DesignerActionPropertyItem class represents individual items in a smart tag panel. Each item is typically associated with a property in a class that is derived from the DesignerActionList class and supplied by the component author. The association is maintained through the name of the property, as stored in the MemberName property.
Individual panel items are associated together to form a panel by a call to the GetSortedActionItems method of the DesignerActionList class.
To display the value of the associated property, that property must have a get accessor method; to allow editing, the property must have a set accessor method. The way in which the panel allows direct editing of a property item by the user depends on the supporting type information present for the data type of the associated property. The following table shows the likely scheme.
| Property type information | Property item editing user interface (UI) |
|---|---|
| Has an associated type editor (UITypeEditor) | The type editor associated with the underlying property is displayed for editing the property's value. |
| Has an associated type converter to a known type (TypeConverter) | The type editor for the known type is displayed for editing the property's value. For example, a type converter to String will likely display a TextBox. |
| Boolean value | The item is displayed using a binary UI, such as a check mark. |
| None of the above. | The item is displayed as a non-editable text string using the data type's ToString method. |
All fundamental types, such as System.Boolean, and common .NET Framework data types, such as System.String, supply standard type converters and editors. For more information about type converters, see How to: Implement a Type Converter or Generalized Type Conversion. For more information about type editors, see How to: Implement a UI Type Editor.
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
System.ComponentModel.Design.DesignerActionItem
System.ComponentModel.Design.DesignerActionPropertyItem
Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.