This document is archived and information here might be outdated. Recommended version. |
Provides access to members that control the ToolbarControl.
The IToolbarControlDefault interface is the default dispatch interface that most development environments will automatically expose. For example, placing the ToolbarControl in a container will typically generate an object called ToolbarControl1. The properties and methods available directly on this object correspond to this interface, together with container specific properties and methods.
The IToolbarControlDefault interface is a 'pure' dispatch interface, so can be extended with new properties and methods at future releases of ArcGIS. The methods and properties are identical to the highest numbered main interface on the ToolbarControl. For example, IToolbarControlDefault is equivalent to IToolbarControl2, but at future releases this could become IToolbarControl3. By using the IToolbarControlDefault interface you are guaranteed to always have access to the latest ToolbarControl.
There is a small performance overhead in making calls through to a pure dispatch interface, but to avoid this you can QI to a specific interface. In some development environments it is not possible to QI directly on the control to other COM interfaces, because the control is contained within a wrapper object. Use the Object property to get the real control before performing the QI.
Name | Description | |
---|---|---|
AboutBox | Displays a dialog of information about the ToolbarControl. | |
AddItem | Adds an item to the ToolbarControl. | |
AddMenuItem | Adds a menu item to the ToolbarControl. | |
AddToolbarDef | Appends the contents of the toolbar definition, specified by Guid or ToolbarDef, to the toolbar control. | |
AlignLeft | Indicates if the ToolbarControl displays menu and palette items aligned to the left or right. | |
Appearance | The appearance of the ToolbarControl. | |
BackColor | Background color of the ToolbarControl. | |
BorderStyle | The border style of the ToolbarControl. | |
Buddy | The object that will have its current tool managed by the toolbar. | |
CommandPool | The command pool used by the ToolbarControl to manage command objects. The command pool object maybe shared with other ToolbarControls and ToolbarMenus. | |
Count | The number of items on the ToolbarControl. | |
CurrentTool | The current tool of the buddy. | |
Customize | Indicates if the ToolbarControl is in customize mode. | |
CustomProperty | A property to associate data with a control. | |
Enabled | Indicates whether the ToolbarControl can respond to user generated events. | |
FadeColor | Background fade color of the ToolbarControl. | |
FillDirection | The fill direction of the ToolbarControl background color. | |
Find | Returns the index of the first item containing the given command, menu or palette. Returns -1 if the command is not found. | |
GetItem | Returns the item at the specified index from the ToolbarControl. | |
GetItemRect | Returns the dimensions of the item at the specified index. | |
HitTest | Returns the index of the item at the specified x and y coordinates. | |
hWnd | Handle to the window associated with the ToolbarControl. | |
IconSize | The size in pixels of icons displayed on the ToolbarControl. | |
ItemAppearance | The appearance of the items on the ToolbarControl. | |
KeyIntercept | A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values. | |
LargeIcons | Indicates if large icons are shown on all items on the ToolbarControl. | |
LoadItems | Loads items into the ToolbarControl from a previously saved stream. | |
MenuTracking | Indicates if menu tracking is enabled on the ToolbarControl. | |
MouseIcon | Custom mouse icon used if MousePointer is 99. | |
MousePointer | The mouse pointer displayed over the ToolbarControl. | |
MoveItem | Moves an item from one index to another. | |
Object | A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment. | |
OperationStack | The operation stack used for undo and redo functionality. If present commands can use it to store operations. | |
Orientation | Indicates if the ToolbarControl is horizontally or vertically aligned. | |
Remove | Removes the item at the specified index from the ToolbarControl. | |
RemoveAll | Removes all items from the ToolbarControl. | |
SaveItems | Saves the ToolbarControl items into a stream. | |
SetBuddyControl | Sets a control to be a buddy of the toolbar, this control must support IToolbarBuddy. | |
ShowHiddenItems | Indicates if the ToolbarControl has a hidden items menu containing items currently not visible. | |
TextAlignment | The caption placement for all items on the ToolbarControl. | |
ThemedDrawing | Indicates if the ToolbarControl uses themed drawing. | |
ToolTips | Indicates if the items tooltips are shown. | |
Transparent | Indicates if the ToolbarControl has a transparent background. | |
Update | Updates the enabled state of the specified item or all items if an index of -1 is specified. Specify fullUpdate to update the group, group spacing, style and bitmap properties. | |
UpdateInterval | The frequency in millisecs that update method is called on the ToolbarControl. |
Classes | Description |
---|---|
ToolbarControl | Esri ToolbarControl |
When querying interface to IToolbarControlDefault in Visual Basic .NET or Visual C# .NET the Object property or container specific code must be used. This is because .NET contains the real control inside a wrapper object known as an host.
IToolbarControlDefault toolbarControl = axToolbarControl1.Object as IToolbarControlDefault;
When querying interface to IToolbarControlDefault in Visual Basic .NET or Visual C# .NET the Object property or container specific code must be used. This is because .NET contains the real control inside a wrapper object known as an host.
Dim toolbarControl As IToolbarControlDefault = AxToolbarControl1.Object