com.esri.arcgis.controls
Class ControlsEditingVertexContextMenu

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

public class ControlsEditingVertexContextMenu
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMenuDef

Engine edit vertex context menu.

Description

This object is new at ArcGIS 9.3.

The CLSID of this menu is: {4F29BC92-2988-45E8-8317-0169EAB954C6}.

This menu works with the ToolbarControl, PageLayoutControl and MapControl.

If the ArcGIS Engine application using this menu is initialized with an ArcGIS Engine Runtime license or an ArcView license, this menu can be used to edit shapefiles and personal geodatabases.

If the ArcGIS Engine application using this menu is initialized with an ArcGIS Engine GeoDatabase Editing license, or ArcEditor or ArcInfo, this menu can be used to edit data within an enterprise geodatabase.

Remarks

This menu can only be used as a pop up menu or context menu. Create a new ToolbarMenu and add this predefined menu to it using the IToolbarMenu::AddItem method. To display the ToolbarMenu as a right click context menu use the IToolbarMenu::PopupMenu method.

This menu contains commands that only work in conjunction with the "Modify Feature" engine edit task. Therefore, only pop up this menu when the IEngineEditTask::UniqueName of the IEngineEditor::CurrentTask is "ControlToolsEditing_ModifyFeatureTask".

It is essential to execute the IEngineEditSketch::SetEditLocation method prior to calling the commands on this menu. This will ensure that the vertex location, segment and part are made available to each command.

An example of using this context menu is provided in the Feature editing with the control commands sample.

Product Availability

Available with ArcGIS Engine.

See Also:
Serialized Form

Constructor Summary
ControlsEditingVertexContextMenu()
          Constructs a ControlsEditingVertexContextMenu using ArcGIS Engine.
ControlsEditingVertexContextMenu(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ControlsEditingVertexContextMenu theControlsEditingVertexContextMenu = (ControlsEditingVertexContextMenu) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getCaption()
          The caption of this menu.
static String getClsid()
          getClsid.
 int getItemCount()
          The number of items in this menu.
 void getItemInfo(int pos, IItemDef itemDef)
          The CLSID for the item on this menu at the specified index.
 String getName()
          The name of this menu.
 int hashCode()
          the hashcode for this object
 
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

ControlsEditingVertexContextMenu

public ControlsEditingVertexContextMenu()
                                 throws IOException,
                                        UnknownHostException
Constructs a ControlsEditingVertexContextMenu using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ControlsEditingVertexContextMenu

public ControlsEditingVertexContextMenu(Object obj)
                                 throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ControlsEditingVertexContextMenu theControlsEditingVertexContextMenu = (ControlsEditingVertexContextMenu) obj;

Construct a ControlsEditingVertexContextMenu using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ControlsEditingVertexContextMenu.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


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

getItemCount

public int getItemCount()
                 throws IOException,
                        AutomationException
The number of items in this menu.

Remarks

When implementing IMenuDef to create a custom menu, use the ItemCount property to specify how many items will be on this menu.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getItemCount in interface IMenuDef
Returns:
The numItems
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfo

public void getItemInfo(int pos,
                        IItemDef itemDef)
                 throws IOException,
                        AutomationException
The CLSID for the item on this menu at the specified index.

Description


pos represents the locational index number of this item on the menu.

itemDef is an IItemDef object that defines the item at this position of the menu.

Remarks

When implementing IMenuDef to create a custom menu, use the GetItemInfo method to define what items are on this menu.

To find the CLSID, ProgID, and subtype of a built-in command or menu in ArcMap or ArcCatalog, refer to the following technical documents:

ArcObjects Developer Help > Technical Documents > ArcMap: Names and IDs of commands and commandbars

ArcObjects Developer Help > Technical Documents > ArcCatalog: Names and IDs of commands and commandbars

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getItemInfo in interface IMenuDef
Parameters:
pos - The pos (in)
itemDef - A reference to a com.esri.arcgis.systemUI.IItemDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IItemDef

getName

public String getName()
               throws IOException,
                      AutomationException
The name of this menu.

Remarks

When implementing IMenuDef to create a custom menu, use the Name property to set the name of this menu.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IMenuDef
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 this menu.

Remarks

When implementing IMenuDef to create a custom menu, use the Caption property to set the caption of this menu.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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