In this topic
ArcGIS Explorer supports six types of add-in classes as a way to extend the application—buttons, check boxes, combo boxes, dock windows, extensions, and galleries. Each type of add-in class is implemented in .NET by deriving from an abstract class in the ESRI.ArcGISExplorer.Application namespace.
Buttons
A button displays on the ribbon, and runs code when the button is clicked. Built-in Buttons include Folder, View, and Link in the Create group on the default home tab. Target, Point, Line and Area are also buttons, although they are shown as a smaller button. See the following screen shot:
Buttons derive from the Button abstract class and can override Enabled, OnClick, and OnUpdate. Buttons are placed on the ribbon at runtime.
Buttons can specify a caption and an image that are used to display the button on the ribbon.
A checkBox displays on the ribbon and runs code when the box is checked or unchecked. Built in checkBoxes include options on the Display to set 3D effects such as Stars, Fog, Atmospheric Halo, and Sun Lighting. See the following screen shot:
CheckBoxes derive from the CheckBox abstract class and can override OnClick and OnUpdate.
A comboBox displays on the ribbon and runs code when an item from the drop down list is selected. Built-in combo boxes include the Coordinates and Distance on the Display tab. See the following screen shot:
ComboBoxes derive from the ComboBox abstract class and can override OnSelectionChanged. ComboBoxes can specify a caption and an image that are used to display the combo box on the ribbon.
DockWindows
A DockWindow is a dockable window that displays in the application and behaves like other built-in dockable windows. Built-in DockWindows include the Find window. See the following screen shot:
DockWindows derive from the DockWindow abstract class (which in turn derives from System.Windows.Forms.UserControl), and provides a surface on which to place other Windows Forms controls to provide a user interface (UI).
DockWindows appear as separate child windows of the application that can be docked or floated. A caption and image can be specified, which is used to display a button that appears on the ribbon; this button is used to show and activate the DockWindow.
Galleries
A gallery appears on the ribbon and shows a series of choices that you can click. Built-in galleries include the Basemaps gallery and the Symbol gallery. See the following screen shot:
Galleries use a visual representation of each choice to help the user select the appropriate item.
Galleries derive from the Gallery abstract class and GalleryItems added to the GalleryItemCollection are displayed as choices.
Overriding the OnClick event provides an opportunity to perform work based on the user's choice; Enabled and OnUpdate can also be overridden. A gallery can display on the ribbon or as a drop-down selection, and a caption and image can be specified for the drop-down option.
Extensions
An extension is a class that does not rely on user-interaction, but instead, can be used to run code in response to the application starting up or shutting down. Another use of an extension is to add a timer and run code periodically while the application is running without requiring user interaction, for example, to show and update graphics on the map.
Extensions derive from the Extension abstract class and can override OnStartup and OnShutdown.
Extensions automatically start when the application starts and their lifetime is tied to the lifetime of the application. Extensions have no UI and are useful for custom functionality that runs in the background.