Provides access to members that control palette items.
Product Availability
Available with ArcGIS Engine.
Description
A ToolbarPalette supplies the implementation of a palette item that can host commands and tools. A ToolbarPalette cannot host ToolControl ToolbarMenu or MultiItem objects. A ToolbarPalette can either be hosted on the ToolbarControl or can appear as a popup palette.
A ToolbarPalette can be built in two ways. Firstly, an object implementing IPaletteDef can be passed to the IToolbarControl::AddItem method which creates a ToolbarPalette object and populates it from the palette definition. Secondly, the properties and methods on the IToolbarPalette interface can be used to build a palette.
Members
| Description | ||
|---|---|---|
 |
ActiveItem | The palette item currently displayed on the ToolbarControl. |
 |
AddItem | Adds an item to the ToolbarPalette. |
 |
AlignLeft | Indicates if the ToolbarPalette displays aligned to the left or right. |
|
Caption | The caption used by the ToolbarPalette. |
 |
CommandPool | The CommandPool used by the ToolbarPalette. |
|
Count | The number of items on the ToolbarPalette. |
|
Customize | Indicates if the ToolbarPalette is in customize mode. |
|
Find | Returns the index of the first item containing the given command. Returns -1 if it is not found. |
|
GetItem | Returns the item at the specified index from the ToolbarPalette. |
|
Hook | The object that is passed as a hook to the OnCreate event of each item's command. |
|
IconSize | Indicates the size in pixels of icons displayed on the ToolbarPalette. |
|
MouseIcon | Custom mouse icon used if MousePointer is 99. |
|
MousePointer | The mouse pointer displayed over the ToolbarPalette. |
|
MoveItem | Moves an item from one index to another. |
|
PopupPalette | Pops up the ToolbarPalette at the position specified. |
|
Remove | Removes the item at the specified index from the ToolbarPalette. |
|
RemoveAll | Removes all items from the ToolbarPalette. |
|
SetHook | Sets the object that is passed as a hook to the OnCreate event of each item's command. |
|
ThemedDrawing | Indicates if the ToolbarPalette uses themed drawing. |
|
ToolTips | Indicates if the items tooltips are shown. |
CoClasses that implement IToolbarPalette
| CoClasses and Classes | Description |
|---|---|
| ToolbarPalette | A palette containing commands that can be used from a ToolbarControl or as a popup palette. |