com.esri.arcgis.framework
Interface ICommandItem

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CommandBar, CommandItem, ICommandItemProxy

public interface ICommandItem
extends java.io.Serializable

COM Interface 'ICommandItem'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that define a command item.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID423b7723_b858_11d1_947b_080009eebecb
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void delete()
          Removes this object from the commandbar.
 void execute()
          Causes the command to execute.
 java.lang.String getAction()
          The name of the VBA macro this command should run when pressed.
 java.lang.String getCaption()
          The caption of this command item.
 java.lang.String getCategory()
          The name of the category with which this command item is associated.
 ICommand getCommand()
          A reference to the internal command object.
 java.lang.Object getFaceID()
          The bitmap that is used as the icon on this command item.
 int getHelpContextID()
          The help context ID associated with this command item.
 java.lang.String getHelpFile()
          The help file associated with this command item.
 IUID getID()
          The unique integer ID associated with this command item.
 int getIndex()
          The positional index of this command item within its menu or toolbar.
 java.lang.String getMessage()
          The status bar message for this command item.
 java.lang.String getName()
          The name of this command item.
 ICommandBar getParent()
          The menu or toolbar that this command item currently resides on.
 int getStyle()
          The display style of this command item.
 java.lang.String getTag()
          The tag for this command item.
 java.lang.String getTooltip()
          The tooltip for this command item.
 int getType()
          The type of this command item.
 boolean isBuiltIn()
          Indicates whether this command item is built-in or if it was implemented through VBA.
 boolean isGroup()
          Indicates if this command item begins a menu or toolbar group.
 void refresh()
          Causes the command to be redrawn.
 void reset()
          Restores this command item's properties to that of the original.
 void setAction(java.lang.String macro)
          The name of the VBA macro this command should run when pressed.
 void setCaption(java.lang.String name)
          The caption of this command item.
 void setFaceID(java.lang.Object faceID)
          The bitmap that is used as the icon on this command item.
 void setGroup(boolean group)
          Indicates if this command item begins a menu or toolbar group.
 void setHelpContextID(int contextID)
          The help context ID associated with this command item.
 void setHelpFile(java.lang.String helpFile)
          The help file associated with this command item.
 void setMessage(java.lang.String message)
          The status bar message for this command item.
 void setName(java.lang.String name)
          The name of this command item.
 void setStyle(int style)
          The display style of this command item.
 void setTag(java.lang.String tag)
          The tag for this command item.
 void setTooltip(java.lang.String tooltip)
          The tooltip for this command item.
 

Field Detail

IID423b7723_b858_11d1_947b_080009eebecb

static final int IID423b7723_b858_11d1_947b_080009eebecb
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getAction

java.lang.String getAction()
                           throws java.io.IOException,
                                  AutomationException
The name of the VBA macro this command should run when pressed.

Returns:
The macro
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAction

void setAction(java.lang.String macro)
               throws java.io.IOException,
                      AutomationException
The name of the VBA macro this command should run when pressed.

Parameters:
macro - The macro (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBuiltIn

boolean isBuiltIn()
                  throws java.io.IOException,
                         AutomationException
Indicates whether this command item is built-in or if it was implemented through VBA.

Returns:
The builtIn
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The name of the category with which this command item is associated.

Returns:
The category
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCommand

ICommand getCommand()
                    throws java.io.IOException,
                           AutomationException
A reference to the internal command object.

Returns:
A reference to a com.esri.arcgis.systemUI.ICommand
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

void delete()
            throws java.io.IOException,
                   AutomationException
Removes this object from the commandbar.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFaceID

void setFaceID(java.lang.Object faceID)
               throws java.io.IOException,
                      AutomationException
The bitmap that is used as the icon on this command item.

Parameters:
faceID - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFaceID

java.lang.Object getFaceID()
                           throws java.io.IOException,
                                  AutomationException
The bitmap that is used as the icon on this command item.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGroup

void setGroup(boolean group)
              throws java.io.IOException,
                     AutomationException
Indicates if this command item begins a menu or toolbar group.

Parameters:
group - The group (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGroup

boolean isGroup()
                throws java.io.IOException,
                       AutomationException
Indicates if this command item begins a menu or toolbar group.

Returns:
The group
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException
The help file associated with this command item.

Returns:
The helpFile
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHelpFile

void setHelpFile(java.lang.String helpFile)
                 throws java.io.IOException,
                        AutomationException
The help file associated with this command item.

Parameters:
helpFile - The helpFile (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpContextID

int getHelpContextID()
                     throws java.io.IOException,
                            AutomationException
The help context ID associated with this command item.

Returns:
The contextID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHelpContextID

void setHelpContextID(int contextID)
                      throws java.io.IOException,
                             AutomationException
The help context ID associated with this command item.

Parameters:
contextID - The contextID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

IUID getID()
           throws java.io.IOException,
                  AutomationException
The unique integer ID associated with this command item.

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndex

int getIndex()
             throws java.io.IOException,
                    AutomationException
The positional index of this command item within its menu or toolbar.

Returns:
The index
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of this command item.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The name of this command item.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCaption

void setCaption(java.lang.String name)
                throws java.io.IOException,
                       AutomationException
The caption of this command item.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCaption

java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException
The caption of this command item.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

ICommandBar getParent()
                      throws java.io.IOException,
                             AutomationException
The menu or toolbar that this command item currently resides on.

Returns:
A reference to a com.esri.arcgis.framework.ICommandBar
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws java.io.IOException,
                  AutomationException
Restores this command item's properties to that of the original.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyle

int getStyle()
             throws java.io.IOException,
                    AutomationException
The display style of this command item.

Returns:
A com.esri.arcgis.systemUI.esriCommandStyles constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStyle

void setStyle(int style)
              throws java.io.IOException,
                     AutomationException
The display style of this command item.

Parameters:
style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTag

java.lang.String getTag()
                        throws java.io.IOException,
                               AutomationException
The tag for this command item.

Returns:
The tag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTag

void setTag(java.lang.String tag)
            throws java.io.IOException,
                   AutomationException
The tag for this command item.

Parameters:
tag - The tag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTooltip

java.lang.String getTooltip()
                            throws java.io.IOException,
                                   AutomationException
The tooltip for this command item.

Returns:
The tooltip
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTooltip

void setTooltip(java.lang.String tooltip)
                throws java.io.IOException,
                       AutomationException
The tooltip for this command item.

Parameters:
tooltip - The tooltip (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws java.io.IOException,
                   AutomationException
The type of this command item.

Returns:
A com.esri.arcgis.framework.esriCommandTypes constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessage

java.lang.String getMessage()
                            throws java.io.IOException,
                                   AutomationException
The status bar message for this command item.

Returns:
The message
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMessage

void setMessage(java.lang.String message)
                throws java.io.IOException,
                       AutomationException
The status bar message for this command item.

Parameters:
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

void execute()
             throws java.io.IOException,
                    AutomationException
Causes the command to execute.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws java.io.IOException,
                    AutomationException
Causes the command to be redrawn.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.