com.esri.arcgis.controls
Interface IToolbarMenu2

All Superinterfaces:
IToolbarMenu, java.io.Serializable
All Known Implementing Classes:
IToolbarMenu2Proxy, ToolbarMenu

public interface IToolbarMenu2
extends IToolbarMenu, java.io.Serializable

COM Interface 'IToolbarMenu2'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control ToolbarControl menu items.' 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 IIDb38cb2be_d09d_4c5e_9865_d8825d17ebbf
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.controls.IToolbarMenu
IIDe8f2ab83_e93b_4529_82f6_34b8e4544b9e
 
Method Summary
 int addMultiItem(java.lang.Object multiItem, int index, boolean beginGroup, int style)
          Adds a multi-item to the ToolbarMenu.
 int getIconSize()
          The size in pixels of icons displayed on the ToolbarMenu.
 Picture getMouseIcon()
          Custom mouse icon used if MousePointer is 99.
 int getMousePointer()
          The mouse pointer displayed over the ToolbarMenu.
 boolean isAlignLeft()
          Indicates if the ToolbarMenu displays aligned to the left or right.
 boolean isCustomize()
          Indicates if the ToolbarMenu is in customize mode.
 boolean isThemedDrawing()
          Indicates if the ToolbarMenu uses themed drawing.
 void setAlignLeft(boolean pVal)
          Indicates if the ToolbarMenu displays aligned to the left or right.
 void setCustomize(boolean newVal)
          Indicates if the ToolbarMenu is in customize mode.
 void setIconSize(int pVal)
          The size in pixels of icons displayed on the ToolbarMenu.
 void setMouseIconByRef(Picture ppMouseIcon)
          Custom mouse icon used if MousePointer is 99.
 void setMousePointer(int pVal)
          The mouse pointer displayed over the ToolbarMenu.
 void setThemedDrawing(boolean pVal)
          Indicates if the ToolbarMenu uses themed drawing.
 
Methods inherited from interface com.esri.arcgis.controls.IToolbarMenu
addItem, addSubMenu, find, getBitmap, getCaption, getCommandPool, getCount, getHook, getItem, getMenuDef, moveItem, popupMenu, remove, removeAll, setBitmap, setCaption, setCommandPoolByRef, setHook
 

Field Detail

IIDb38cb2be_d09d_4c5e_9865_d8825d17ebbf

static final int IIDb38cb2be_d09d_4c5e_9865_d8825d17ebbf
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

addMultiItem

int addMultiItem(java.lang.Object multiItem,
                 int index,
                 boolean beginGroup,
                 int style)
                 throws java.io.IOException,
                        AutomationException
Adds a multi-item to the ToolbarMenu.

Parameters:
multiItem - A Variant (in)
index - The index (in, optional, pass -1 if not required)
beginGroup - The beginGroup (in, optional, pass false if not required)
style - A com.esri.arcgis.systemUI.esriCommandStyles constant (in, optional, pass 2 if not required)
Returns:
The itemIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomize

void setCustomize(boolean newVal)
                  throws java.io.IOException,
                         AutomationException
Indicates if the ToolbarMenu is in customize mode.

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

isCustomize

boolean isCustomize()
                    throws java.io.IOException,
                           AutomationException
Indicates if the ToolbarMenu is in customize mode.

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

isThemedDrawing

boolean isThemedDrawing()
                        throws java.io.IOException,
                               AutomationException
Indicates if the ToolbarMenu uses themed drawing.

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

setThemedDrawing

void setThemedDrawing(boolean pVal)
                      throws java.io.IOException,
                             AutomationException
Indicates if the ToolbarMenu uses themed drawing.

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

getMousePointer

int getMousePointer()
                    throws java.io.IOException,
                           AutomationException
The mouse pointer displayed over the ToolbarMenu.

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

setMousePointer

void setMousePointer(int pVal)
                     throws java.io.IOException,
                            AutomationException
The mouse pointer displayed over the ToolbarMenu.

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

getIconSize

int getIconSize()
                throws java.io.IOException,
                       AutomationException
The size in pixels of icons displayed on the ToolbarMenu.

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

setIconSize

void setIconSize(int pVal)
                 throws java.io.IOException,
                        AutomationException
The size in pixels of icons displayed on the ToolbarMenu.

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

isAlignLeft

boolean isAlignLeft()
                    throws java.io.IOException,
                           AutomationException
Indicates if the ToolbarMenu displays aligned to the left or right.

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

setAlignLeft

void setAlignLeft(boolean pVal)
                  throws java.io.IOException,
                         AutomationException
Indicates if the ToolbarMenu displays aligned to the left or right.

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

setMouseIconByRef

void setMouseIconByRef(Picture ppMouseIcon)
                       throws java.io.IOException,
                              AutomationException
Custom mouse icon used if MousePointer is 99.

Parameters:
ppMouseIcon - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMouseIcon

Picture getMouseIcon()
                     throws java.io.IOException,
                            AutomationException
Custom mouse icon used if MousePointer is 99.

Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.