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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.