| ActionPaletteItem Class |
Inheritance HierarchyNamespace: Kjs.AppLife.Update.Engine.Core.Design
Assembly: Kjs.AppLife.Update.Engine.Core.Design (in Kjs.AppLife.Update.Engine.Core.Design.dll) Version: 1.0.0.12 (4.0.0.0)
SyntaxThe ActionPaletteItem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ActionPaletteItem |
Initializes a new instance of the ActionPaletteItem class.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize |
Initializes the ActionPaletteItem with the specified action
type's information.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | ActionType |
Gets the type of action associated with the ActionPaletteItem.
|
| Category |
Gets the palette category of the action.
|
| Description |
Gets the palette description of the action.
|
| DisplayName |
Gets the name for the action displayed in the action palette.
|
| Image |
Gets the image displayed in the action palette for the action.
|
RemarksTo create a custom ActionPaletteItem, inherit from this class and provide a public parameterless constructor.
Each ActionPaletteItem describes the appearance of an UpdateAction in the action palette. The DisplayName property contains the name of the action in the palette. The Description property contains the tooltip for the action. The Image property contains the image shown next to the action's name, and the Category property contains the category under which the action appears.
The values of these properties are taken from the following attributes, which can be placed on an UpdateAction:
| Attribute | Effect |
|---|---|
| DisplayNameAttribute | Specifies DisplayName. Unless a different name is specified by an ActionBuilder, this name will also be used in the action list |
| CategoryAttribute | Specifies Category. |
| DescriptionAttribute | Specifies Description. |
| ToolboxBitmapAttribute | Specifies Image. Unless a different image is specified by an ActionBuilder, this image will also be used in the action list. |
A custom ActionPaletteItem can override the default behavior of these properties.
To link an ActionPaletteItem to an UpdateAction, provide an ActionPaletteItemAttribute on the UpdateAction, specifying the type of the ActionPaletteItem. If the type specified in the ActionPaletteItemAttribute cannot be found, does not inherit from ActionPaletteItem, or does not have a public, parameterless constructor, the default ActionPaletteItem will be used instead.
To specify that an action should not appear in the palette, provide an ActionPaletteItemAttribute on the UpdateAction, specifying for the defaultType parameter in the constructor:
To explicitly specify that an action should use the default palette item, provide an ActionPaletteItemAttribute on the UpdateAction, specifying for the defaultType parameter in the constructor:
See Also