com.esri.arcgis.controls
Class ARCommandInfo

java.lang.Object
  extended by com.esri.arcgis.controls.ARCommandInfo
All Implemented Interfaces:
IARCommandInfo, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ARCommandInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARCommandInfo

ARCommandInfo object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Constructor Summary
ARCommandInfo(Object obj)
          Construct a ARCommandInfo using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 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.
 int hashCode()
          the hashcode for this object
 boolean isChecked()
          Indicates if the command is checked.
 boolean isEnabled()
          Indicates if the command is enabled.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ARCommandInfo

public ARCommandInfo(Object obj)
              throws IOException
Construct a ARCommandInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARCommandInfo.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ARCommandInfo o = (ARCommandInfo)obj; // will not work

ARCommandInfo o = new ARCommandInfo(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ARCommandInfo theARCommandInfo = (ARCommandInfo) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException
Indicates if the command is enabled.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
isEnabled in interface IARCommandInfo
Returns:
The enabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isChecked

public boolean isChecked()
                  throws IOException,
                         AutomationException
Indicates if the command is checked.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
isChecked in interface IARCommandInfo
Returns:
The checked
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getName in interface IARCommandInfo
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException
The caption of the command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getCaption in interface IARCommandInfo
Returns:
The caption
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTooltip

public String getTooltip()
                  throws IOException,
                         AutomationException
The tooltip of the command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getTooltip in interface IARCommandInfo
Returns:
The tooltip
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage()
                  throws IOException,
                         AutomationException
The message of the command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getMessage in interface IARCommandInfo
Returns:
The message
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException
The name of the help file associated with the command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getHelpFile in interface IARCommandInfo
Returns:
The helpFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID()
                     throws IOException,
                            AutomationException
The help context ID associated with the command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getHelpContextID in interface IARCommandInfo
Returns:
The helpContextID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBitmap

public int getBitmap()
              throws IOException,
                     AutomationException
The bitmap used as an icon by the command.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getBitmap in interface IARCommandInfo
Returns:
The bitmap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
The category the command is associated with.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getCategory in interface IARCommandInfo
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.