|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.interop.Dispatch com.esri.arcgis.framework.ICommandItemProxy
public class ICommandItemProxy
Provides access to members that define a command item.
A CommandItem is any item on a commandbar. For example, buttons, tools, and menu items that appear on commandbars are all commanditems. The ICommandItem interface allows you to get or set the properties of the commanditem such as caption, button image, statusbar message, tooltip, display style, help context ID, and more. The ICommandItem interface also provides methods to execute, delete, refresh, and reset the commanditem. Use ICommandBars::Find, ICommandBar::Find, or ICommandBar::Item to obtain a reference to a particular commanditem.
ICommandBars.find(java.lang.Object, boolean, boolean)
,
ICommandBar.find(java.lang.Object, boolean)
,
ICommandBar.getItem(int)
,
ICommandBar.createMacroItem(String, java.lang.Object, String, java.lang.Object)
,
ICommandBar.popup(int, int)
,
ICommandBar.add(com.esri.arcgis.system.IUID, java.lang.Object)
,
Serialized FormField Summary | |
---|---|
boolean |
noncastable
|
Fields inherited from class com.esri.arcgis.interop.Dispatch |
---|
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef |
Constructor Summary | |
---|---|
|
ICommandItemProxy()
|
|
ICommandItemProxy(Object obj)
|
protected |
ICommandItemProxy(Object obj,
String iid)
|
Method Summary | |
---|---|
void |
addListener(String iidStr,
Object theListener,
Object theSource)
|
void |
delete()
Removes this object from the commandbar. |
void |
execute()
Causes the command to execute. |
String |
getAction()
The name of the VBA macro this command should run when pressed. |
String |
getCaption()
The caption of this command item. |
String |
getCategory()
The name of the category with which this command item is associated. |
ICommand |
getCommand()
A reference to the internal command object. |
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. |
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. |
String |
getMessage()
The status bar message for this command item. |
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. |
String |
getTag()
The tag for this command item. |
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 |
removeListener(String iidStr,
Object theListener)
|
void |
reset()
Restores this command item's properties to that of the original. |
void |
setAction(String macro)
The name of the VBA macro this command should run when pressed. |
void |
setCaption(String name)
The caption of this command item. |
void |
setFaceID(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(String helpFile)
The help file associated with this command item. |
void |
setMessage(String message)
The status bar message for this command item. |
void |
setName(String name)
The name of this command item. |
void |
setStyle(int style)
The display style of this command item. |
void |
setTag(String tag)
The tag for this command item. |
void |
setTooltip(String tooltip)
The tooltip for this command item. |
Methods inherited from class com.esri.arcgis.interop.Dispatch |
---|
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public boolean noncastable
Constructor Detail |
---|
public ICommandItemProxy()
public ICommandItemProxy(Object obj) throws IOException
IOException
protected ICommandItemProxy(Object obj, String iid) throws IOException
IOException
Method Detail |
---|
public void addListener(String iidStr, Object theListener, Object theSource) throws IOException
addListener
in class com.esri.arcgis.interop.Dispatch
IOException
public void removeListener(String iidStr, Object theListener) throws IOException
removeListener
in class com.esri.arcgis.interop.Dispatch
IOException
public String getAction() throws IOException, AutomationException
Action is a string representing the full name of the VBA macro that is to be executed when the command item is clicked. The name of the macro must include the name of the VBA project in which this macro is located.
Here are some examples of the syntax of the value for the Action property.
Macro called MyMacro in ThisDocument in Normal template:
"Normal.ThisDocument.MyMacro"
Macro called MyMacro in Module1 in Normal template:
"Normal.Module1.MyMacro"
Macro called MyMacro in ThisDocument in the current document:
"Project.ThisDocument.MyMacro"
Macro called MyMacro in Module1 in the current document:
"Project.Module1.MyMacro"
Macro called MyMacro in ThisDocument in a base template:
"TemplateProject.ThisDocument.MyMacro"
Macro called MyMacro in Module1 in a base template:
"TemplateProject.Module1.MyMacro"
Note: This property only applies to macro items.
getAction
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAction(String macro) throws IOException, AutomationException
setAction
in interface ICommandItem
macro
- The macro (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isBuiltIn() throws IOException, AutomationException
Returns True if the command is a COM command that was created by implementing ICommand and compiling into a DLL. Returns False if the command is a UIControl or a VBA macro.
isBuiltIn
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
Category is a string that represents the category of the command on which this command item is based. The category determines where the command will appear in the Commands panel of the Customize dialog.
getCategory
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICommand getCommand() throws IOException, AutomationException
Returns a reference to the command (Button, Tool, ToolControl, or MultiItem) on which this command item is based.
getCommand
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ICommand
public void delete() throws IOException, AutomationException
When you delete a commanditem from a commandbar it is not deleted from the application; it is just removed from the commandbar. You can always add that command back to a commandbar.
delete
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFaceID(Object faceID) throws IOException, AutomationException
setFaceID
in interface ICommandItem
faceID
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getFaceID() throws IOException, AutomationException
The values for FaceID from the built-in icon palette are:
You can also use your own bitmap (.bmp file) with ICommandItem::FaceID. To use your own bitmap, you could create a UserForm in VBA with a Image control on it. Set the Picture property of the Image control to your bitmap.
If you are using your own bitmap, it must be a Bitmap file (.bmp); Icon files (.ico) are not supported. Bitmap files should be 16 X 16 pixels. The color of the upper left pixel of the bitmap is treated as the transparent color. For example, if the upper left pixel of the bitmap is red, then all of the red pixels in the bitmap will be converted to transparent.
getFaceID
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setGroup(boolean group) throws IOException, AutomationException
setGroup
in interface ICommandItem
group
- The group (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isGroup() throws IOException, AutomationException
If Group is set to True, the command item is the first item in a group on a toolbar or menu. There will be a separator bar to the left of the command item. If Group is set to False, the command item does not have a separator bar to the left of it.
isGroup
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHelpFile() throws IOException, AutomationException
You cannot set HelpFile for built-in commands. It is not implemented for macro items and UIControls.
getHelpFile
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHelpFile(String helpFile) throws IOException, AutomationException
setHelpFile
in interface ICommandItem
helpFile
- The helpFile (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHelpContextID() throws IOException, AutomationException
You cannot set HelpContextID for built-in commands. It is not implemented for macro items and UIControls.
getHelpContextID
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHelpContextID(int contextID) throws IOException, AutomationException
setHelpContextID
in interface ICommandItem
contextID
- The contextID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getID() throws IOException, AutomationException
getID
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IUID
public int getIndex() throws IOException, AutomationException
getIndex
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
Returns the programmatic identifying name string for the command on which this command item is based. Note, this is usually different from the Caption property of a the command.
You can modify Name for VBA macro items but not built-in commands and UIControls. Setting this property for a built-in command or UIControls will return "This method cannot be called on built in commands" run-time error.
getName
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
Returns the programmatic identifying name string for the command on which this command item is based. Note, this is usually different from the Caption property of a the command.
setName
in interface ICommandItem
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCaption(String name) throws IOException, AutomationException
setCaption
in interface ICommandItem
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCaption() throws IOException, AutomationException
The Caption property of a command item is a string that appears when the command item is placed on a menu or when the command item's display style property is set to Text Only or Image and Text.
getCaption
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICommandBar getParent() throws IOException, AutomationException
Returns a reference to the CommandBar that this command item is on.
getParent
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ICommandBar
public void reset() throws IOException, AutomationException
reset
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getStyle() throws IOException, AutomationException
The Style of a command item determines whether the command item is displayed on a command bar using its caption, image or both. Refer to the esriCommandStyles constants topic for the values for Style.
When a command is put on a toolbar, the command is displayed with the bitmap only by default; the display type is set to Image Only (Style = esriCommandStyleIconOnly).
When a command is put on a menu, the command is displayed with the bitmap and caption by default; the display type is set to Image and Text (Style = esriCommandStyleIconAndText).
However, if the Bitmap property (ICommand::Bitmap) is not set for this command, then the command will be displayed with the caption only by default when it is put on a toolbar or menu; the display type is set to Text Only (Style = esriCommandStyleTextOnly).
getStyle
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.esriCommandStyles
public void setStyle(int style) throws IOException, AutomationException
setStyle
in interface ICommandItem
style
- A com.esri.arcgis.systemUI.esriCommandStyles constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.esriCommandStyles
public String getTag() throws IOException, AutomationException
getTag
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTag(String tag) throws IOException, AutomationException
setTag
in interface ICommandItem
tag
- The tag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTooltip() throws IOException, AutomationException
Tooltip is a string that appears in the screen tip when the mouse hovers over the command item.
You can modify Tooltip for VBA macro items but not built-in commands and UIControls. Setting this property for a built-in command or UIControls will return "This method cannot be called on built in commands" run-time error.
getTooltip
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTooltip(String tooltip) throws IOException, AutomationException
setTooltip
in interface ICommandItem
tooltip
- The tooltip (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getType() throws IOException, AutomationException
Returns the type of this command item using the esriCommandTypes constants. The command item can be one of the following types:
getType
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.esriCommandTypes
public String getMessage() throws IOException, AutomationException
Message is a string that appears as the message in the statusbar of the application when the mouse passes over the command item.
You can modify Message for VBA macro items but not built-in commands and UIControls. Setting this property for a built-in command or UIControls will return "This method cannot be called on built in commands" run-time error.
getMessage
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMessage(String message) throws IOException, AutomationException
setMessage
in interface ICommandItem
message
- The message (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void execute() throws IOException, AutomationException
execute
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void refresh() throws IOException, AutomationException
Causes the command item to be redrawn on the CommandBar in order to correctly display any new property changes.
It is generally unnecessary to explicitly call Refresh; CommandItem updates such as setting the caption, image, and style all automatically call Refresh.
refresh
in interface ICommandItem
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |