com.esri.arcgis.controls
Interface IToolbarItem

All Superinterfaces:

Serializable

All Known Subinterfaces:

IToolbarItem2

All Known Implementing Classes:

IToolbarItem2Proxy, IToolbarItemProxy, ToolbarItem

public interface IToolbarItem
extends Serializable

Provides access to members that control ToolbarControl items.

Superseded By

IToolbarItem2

Description

A ToolbarItem represents a Command, Tool, ToolControl, Menu or Palette item on the ToolbarControl. These items generally appear as buttons however, a ToolControl will provide its own window, and will typically be a combo box.

Product Availability

Available with ArcGIS Engine.

Method Summary

ICommand	getCommand() The command used by the item.
Object	getCustomProperty() A property to associate data with an item.
int	getGroupSpacing() The width of the group separator in pixels if present.
IToolbarMenu	getMenu() If the item is a menu, this property is a ToolbarMenu object.
int	getStyle() The style of the item.
IUID	getUID() The UID of the command used by the item, which may be empty.
boolean	isGroup() Indicates if a group separator exists to the left of the item on the ToolbarControl.
void	setCustomProperty(Object pVal) A property to associate data with an item.
void	setGroup(boolean pVal) Indicates if a group separator exists to the left of the item on the ToolbarControl.
void	setGroupSpacing(int pVal) The width of the group separator in pixels if present.
void	setStyle(int pVal) The style of the item.

Method Detail

getCommand

ICommand getCommand()
                    throws IOException,
                           AutomationException

The command used by the item.

Description

Returns the ICommand object used by the Command, Tool or ToolControl item. If the item is using a Menu, an IMultiItem object or Palette Nothing is returned.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.systemUI.ICommand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUID

IUID getUID()
            throws IOException,
                   AutomationException

The UID of the command used by the item, which may be empty.

Description

Returns the UID of the Command used by the item. The method will return Nothing if the command has been added to the CommandPool using either the AddCommand or IToolbarControl::AddItem methods without a UID or ProgID supplied.

The UID objects are managed in association with objects implementing ICommand by the IToolbarControl::CommandPool.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGroup

boolean isGroup()
                throws IOException,
                       AutomationException

Indicates if a group separator exists to the left of the item on the ToolbarControl.

Description

Determines whether a separator exists to the left of the item on the ToolbarControl. The separator will appear as verticle line. By default Group is False.

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroup

void setGroup(boolean pVal)
              throws IOException,
                     AutomationException

Indicates if a group separator exists to the left of the item on the ToolbarControl.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroupSpacing

int getGroupSpacing()
                    throws IOException,
                           AutomationException

The width of the group separator in pixels if present.

Description

Determines the width in pixels of a Group separator if it exists to the left the of the item on the ToolbarControl. The separator appears as verticle line and is drawn to the left of the GroupSpacing. A zero value sets the GroupSpacing to its default value (currently 4 pixels).

Product Availability

Available with ArcGIS Engine.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupSpacing

void setGroupSpacing(int pVal)
                     throws IOException,
                            AutomationException

The width of the group separator in pixels if present.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyle

int getStyle()
             throws IOException,
                    AutomationException

The style of the item. Displays a combination of text caption and bitmap.

Description

Determines the Style of the item on the ToolbarControl, and whether the Caption, or Bitmap or Caption and Bitmap defined within the Command are displayed on the ToolbarControl. By default the Style is esriCommandStyleIconOnly. If the item has a Menu then the Style is fixed to a esriCommandStyleMenuBar Style.

Product Availability

Available with ArcGIS Engine.

Returns:

A com.esri.arcgis.systemUI.esriCommandStyles constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyle

void setStyle(int pVal)
              throws IOException,
                     AutomationException

The style of the item. Displays a combination of text caption and bitmap.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - A com.esri.arcgis.systemUI.esriCommandStyles constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with an item.

Description

Use the CustomProperty to associate any useful data with the ToolbarItem. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

Product Availability

Available with ArcGIS Engine.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException

A property to associate data with an item.

Product Availability

Available with ArcGIS Engine.

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMenu

IToolbarMenu getMenu()
                     throws IOException,
                            AutomationException

If the item is a menu, this property is a ToolbarMenu object.

Description

Returns the IToolbarMenu used by the item if the item represents a menu. If the item does not use a menu Nothing is returned.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.controls.IToolbarMenu

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.