Using HookActions in custom commands

Purpose
This sample demonstrates how to use the IHookActions interface in custom commands to zoom, pan, flash and create graphics, labels, and callouts of selected features. The sample uses the MapControl, GlobeControl, and ToolbarControl in conjunction with the control commands.

How to use

See How to use ArcGIS samples for help on compiling, setting up the debugger, and running the sample. If the sample has associated data, you will find that the sample's zip file includes a "data" folder alongside the language folders. However, you will need to update the sample to point to the location of the data once you have extracted all the files.

  1. Add data to map, globe or both. For instance, add wsiearth/wsiearth.tif as the globe backdrop to allow black graphics and callouts to be seen. You could add line features from UsaMajorHighways/usa_major_highways.shp.
  2. Select some features. Note: on globe, you must select multiple features using Shift+Ctrl; there is no extent selection.
  3. Right-click the display to zoom, pan, flash or create graphics, labels, or callouts of selected features.
  4. Note: on globe, graphics cannot be selected.

Additional information

Each custom command uses the HookHelper and GlobeHookHelper object to manage the hook passed to the ICommand.OnCreate event. In the ICommand.OnClick event, the IBasicMap.FeatureSelection method is used to return the feature selection of the IHookHelper.FocusMap or the IGlobeHookHelper.Globe. The geometry of each feature in the feature selection is added to an IArray.
The IHookActions.ActionSupportedOnMultiple property is used to determine whether the specified action (zoom, pan, flash, graphic, label, or callout) is supported with the geometries in the array. If the action is supported, the IHookActions.DoActionOnMultiple or IHookActions.DoActionWithNameOnMultiple method is called to perform the specific action. The DoActionWithNameOnMultiple method is used when performing a label or callout action. In addition to passing an array of geometries, an array of strings for labeling is also passed. In this case, that string array contains the value from the first field of each feature.
The custom commands are added to a ToolbarMenu using the IToolbarMenu.AddItem method and the ToolbarMenu's hook property is set to the ToolbarControl. In the MapControl and GlobeControl OnMouseDown event, the IToolbarMenu.PopupMenu method is used to display the menu when the right mouse button is clicked.


HookActions.cs Form file.
hookActionsCallout.cs
(view code)
 Class file.
hookActionsFlash.cs
(view code)
 Class file.
hookActionsGraphic.cs
(view code)
 Class file.
hookActionsLabel.cs
(view code)
 Class file.
hookActionsPan.cs
(view code)
 Class file.
hookActionsZoom.cs
(view code)
 Class file.
Download the C# files
HookActions.vb
(view code)
 Form file.
hookActionsCallout.vb
(view code)
 Class file.
hookActionsFlash.vb
(view code)
 Class file.
hookActionsGraphic.vb
(view code)
 Class file.
hookActionsLabel.vb
(view code)
 Class file.
hookActionsPan.vb
(view code)
 Class file.
hookActionsZoom.vb
(view code)
 Class file.
Download the VB.NET files

Download the files for all languages

See Also:

HookHelper
GlobeHookHelper
IHookActions



Development licensing Deployment licensing
Engine Developer Kit Engine: 3D Analyst
ArcGIS for Desktop Basic: 3D Analyst
ArcGIS for Desktop Standard: 3D Analyst
ArcGIS for Desktop Advanced: 3D Analyst