com.esri.arcgis.controls
Interface IARCommandInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

ARCommandInfo, IARCommandInfoProxy

public interface IARCommandInfo
extends Serializable

Provides access to members that control the ARCommandInfo.

Description

The IARCommandInfo interface is a starting point for getting properties about the built-in tools.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Method Summary

int	getBitmap() The bitmap used as an icon by the command.
String	getCaption() The caption of the command.
String	getCategory() The category the command is associated with.
int	getHelpContextID() The help context ID associated with the command.
String	getHelpFile() The name of the help file associated with the command.
String	getMessage() The message of the command.
String	getName() The name of the command.
String	getTooltip() The tooltip of the command.
boolean	isChecked() Indicates if the command is checked.
boolean	isEnabled() Indicates if the command is enabled.

Method Detail

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the command is enabled.

Description

Indicates the enabled state of the specified ARTool command. Check a tools enabled state before setting it as the IARControl::CurrentARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChecked

boolean isChecked()
                  throws IOException,
                         AutomationException

Indicates if the command is checked.

Description

Indicates the checked state of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The checked

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The name of the command.

Description

Returns the Name of the specified ARTool command. By convention a command's name should include its Category name and Caption (<Category>_<Caption>).

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCaption

String getCaption()
                  throws IOException,
                         AutomationException

The caption of the command.

Description

Returns the Caption of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTooltip

String getTooltip()
                  throws IOException,
                         AutomationException

The tooltip of the command.

Description

Returns the Tooltip of the specified ARTool command.

Remarks

For example, use the Tooltip to set the label caption that appears when the mouse moves over an ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The tooltip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

String getMessage()
                  throws IOException,
                         AutomationException

The message of the command.

Description

Returns the Message of the specified ARTool command. For example, use the Message to set the text that appears in a status bar as the mouse moves over an ARTool.

Remarks

For example, use the Message to set the text that appears in a status bar as the mouse moves over an ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

String getHelpFile()
                   throws IOException,
                          AutomationException

The name of the help file associated with the command.

Description

Returns the HelpFile of the specified ARTool command. This is the name of the help file that contains the context sensitive help topic for the ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

int getHelpContextID()
                     throws IOException,
                            AutomationException

The help context ID associated with the command.

Description

Returns the HelpContextID of the specified ARTool command. This is used to specify the mapped numeric value of the topic ID of the context sensitive help topic for the ARTool.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The helpContextID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitmap

int getBitmap()
              throws IOException,
                     AutomationException

The bitmap used as an icon by the command.

Description

Returns the Bitmap handle of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The bitmap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The category the command is associated with.

Description

Returns the Category of the specified ARTool command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.