Web controls

Summary This topic describes the Web controls available in the Web Application Developer Framework (ADF).

In this topic

About Web ADF controls

The Web ADF includes Web controls that enhance the Web developer experience and provide a rapid application development environment. All Web ADF controls are designed to work asynchronously in a Web application by utilizing AJAX patterns included with ASP.NET. All Web ADF controls can be considered script controls because they implement the ASP.NET Asynchronous JavaScript and XML (AJAX) System.Web.UI.IScriptControl interface. This means that you can interact with Web ADF controls via JavaScript in the client browser if the Web controls have a scriptable implementation. The Web ADF includes a comprehensive public JavaScript Library that can be used to work with scriptable controls and enhance a Web application using client side logic.
Web ADF controls leverage the Common Data Source application programming interface (Common API) to interact with multiple sources of data as resources. In most cases, resources are managed by resource manager controls. Other controls consume the managed resources directly or via another control.
The following diagram illustrates the property relationships between Web ADF core and task framework controls and data sources that are supported out of the box. For example, the MapTips control uses the MapResourceManager to select a resource and layer on which to construct map tips and can be buddied with a Map control to display the map tips. Likewise, the SearchAttributesTask uses the MapResourceManager to select the resources, layers, and fields in which to search. The task can be buddied with a TaskResults control to display tabular results and the TaskResults control can be buddied with a Map control to display graphic results.
The following sections provide a brief description of each Web control included with the Web ADF.

MapResourceManager

The MapResourceManager control is often the first control added to a Web application. The design-time interface allows you to add, remove, and set properties for any resource that provides mapped output—for example, an ArcIMS Image Service or an ArcGIS Server map service.
Since the MapResourceManager control is designed to manage multiple resources at once, it provides properties that define how the resources interact, such as the order of layers and transparency of map image output. Multiple controls can use the same MapResourceManager to access the same resources. As a result, changes to a resource by one control can be reflected in other controls associated with the same MapResourceManager.
For more information, see MapResourceManager control.

Map

The Map control displays geographic data from one or more resources provided by various data source types. The Map control must be associated with a MapResourceManager control to define the resources displayed in the map. Multiple resources displayed in the map are blended together and rendered as a single image. Since each service is treated as a separate layer in the map, you can use the MapResourceManager control to set transparency levels for each resource. Advanced map tool functionality enables continuous panning and zooming capabilities without reloading the Web page that contains the map, and a full postback is not required. In addition, game style navigation provides scroll-wheel zoom and keyboard navigation options at run time.
A number of other Web ADF controls—such as Toolbar, Navigation, MapTips, and ZoomLevel—buddy with the Map control to enhance the user experience.
For more information, see Map control.

ColorPicker

The ColorPicker control provides a run time dialog that can be used to select a color. The ColorPicker control can be incorporated into a page or control (for example, a custom task) to provide you the ability to select a color. The selected color can be used to define properties for a component in the application or the control.
For more information, see ColorPicker control.

ContextMenu

The ContextMenu control displays a dialog during a right-click event (onContextMenu event) on an element in a browser at run time. The element can be a Web control (such as the Map control), the contents of a control (such as a node in TaskResults), or any client-side element on which an event can be triggered. A ContextMenu control contains one or more items that you can select to initiate an action.
For more information, see ContextMenu control.

DockExtender

The DockExtender control allows you to dock a target control in a Map control. Target controls often include an OverviewMap, ScaleBar, ZoomLevel and\or Navigation control. At run time, the target control is anchored to a Map control at a predefined location (for example, the corner, side, or center of the Map control).
For more information, see DockExtender control.

FloatingPanel

The FloatingPanel control provides a floating window within a Web page that can contain other controls. You can drag and drop, resize, and minimize the window in the browser. FloatingPanels can be used to enhance the usability and appearance of a Web page. When you add an OverviewMap or Toolbar to a floating window, it can be minimized when not in use or dragged to a new location on the screen.
For more information, see FloatingPanel control.

GeocodeResourceManager

The GeocodeResourceManager control allows you to add, remove, and set properties for any resource that provides geocoding services. ArcGIS Server, ArcIMS data sources can be utilized. The FindAddressTask control uses the resources provided by the GeocodeResourceManager to geocode address inputs.
For more information, see GeocodeResourceManager control.

GeoprocessingResourceManager

The GeoprocessingResourceManager control allows you to add, remove, and set properties for any resource that provides geoprocessing services. Only ArcGIS Server geoprocessing services are supported at this time. The GeoprocessingTask control uses the resources provided by the GeoprocessingResourceManager to work with geoprocessing tasks on the server.
For more information, see GeoprocessingResourceManager control.

HoverExpandExtender

The HoverExpandExtender control gives you the ability to change the opacity or image display behavior of a control. The targeted control alternates between opacity values, images, or both when the mouse hovers over or does not hover over the control.
For more information, see HoverExpandExtender control.

Magnifier

The Magnifier control extends the FloatingPanel control to provide a floating window that contains a map of a resource in the buddied Map control. The map in the Magnifier control zooms in on the underlying Map control to show additional detail without changing the extent of the map in the Map control. A crosshair in the center of the Magnifier control enables you to position the control over the map to select an area to view. A scale factor drop-down list (from 2x to 10x the current Map extent) enables you to select how much to zoom in on the map.
For more information, see Magnifier control.

MapCopyrightText

The MapCopyrightText control shows interactive copyright text when associated with a Map control.
For more information, see MapCopyrightText control.

MapTips

The MapTips control provides the ability, at run time, to hover the mouse over a point feature in a map and instantly display attribute information about the specific feature. The MapTips control uses client-side logic in the browser to display features on top of the map control. The MapTips control uses attribute information in a point feature layer, accessed via a resource in MapResourceManager. MapTips can retrieve information from a resource in one MapResourceManager and display it in another unrelated Map control.
For more information, see MapTips control.

Navigation

The Navigation control is associated with a single Map control. The Navigation control provides common map navigation functionality (pan and zoom) in a single control. The Navigation control can be moved dynamically on the Web page at run time, so an application user can choose the location of the control.
For more information, see Navigation control.

OverviewMap

The OverviewMap control is similar to the Map control in that it displays geographic data. The purpose of an overview map, however, is to provide a point of reference for the area displayed on its associated Map control. The OverviewMap control always displays greater extent than its associated Map control. An area of interest box on the overview map represents the currently displayed area on its associated Map control.
For more information, see How to use the OverviewMap control.
The OverviewMap and Map controls can use two different MapResourceManagers, thus different sources of data.

PageLayout

The PageLayout control displays the layout of a map and is analogous to layout view in ArcMap. The PageLayout control displays all the map elements, including data frames and any map surrounds, such as north arrows and scale bars. The PageLayout control is only supported for use with ArcGIS Server local data sources.
For more information, see PageLayout control.

ScaleBar

The ScaleBar control provides a simple scale bar for the map. It uses ArcGIS Server or ArcIMS resources in a Map control to calculate relative scale and construct the control.
For more information, see ScaleBar control.

Toc

The Toc (table of contents) control lists the layers on the map and shows what the features represent. A Toc control is buddied with a Map control. As a result, checking a layer in the Toc control draws it in the Map control. Each resource associated with a Map control can contain one or more layers. The Toc control represents each resource as a group layer; essentially a layer that contains layers.
For more information, see Toc control.

Toolbar

The Toolbar control can be associated with one or more Map controls. Toolbars contain functions for working with a map, such as common navigation tools (for example, pan and zoom). Custom tools can be added to the toolbar to enhance the capabilities of a Web application.
For more information, see Toolbar control.

TreeViewPlus

The TreeViewPlus control is a container that presents information at run time in a nested structure of nodes (a tree). Two Web ADF controls, TaskResults and Toc, build on its framework.

ZoomLevel

The ZoomLevel control provides a set of levels, or map scales, representing different static extents to which the Map control can zoom. The Map control must reference a resource that contains at least one static layer, for example, an ArcGIS Server MapServer with a cached data layer. When created, the cached data layer defines a set of levels, or scales, at which the cached data was generated. The ZoomLevel control uses these levels to define the number of segments displayed by the control.
For more information, see ZoomLevel control.

GoToLocation

The GoToLocation control provides a user interface to enter a location (coordinate) at runtime and zoom to or pan to that location. The control is buddied with Map control. The location or coordinates are based on Map's spatial reference. Several options can be modified, such as the label text and zoom factor.
For more information, see GoToLocation control.

ZoomToScale

The ZoomToScale control uses the primary map resource to determine how it functions at runtime.  If the primary map resource is a cached service, a user can select from a list of cache levels . If the primary map resource is dynamic, a user can enter the scale in a text box.
For more information, see ZoomToScale control.

TaskManager

The TaskManager control organizes tasks in a Web application. The TaskManager control generates hierarchical Extensible Markup Language (XML) data that can be used by an ASP.NET navigation control, such as Menu or TreeView. At run time, nodes in the ASP.NET Menu or TreeView can be used to display the floating panel for a task. It is only visible at design time.
For more information, see TaskManager control.

TaskResults

The TaskResults control stores the results of tasks that produce ADO.NET DataSet output. The results are presented as nodes in a TreeView. The TaskResults control also enables you to zoom or pan to a feature, highlight a feature in a result set, re-run a task, or remove task results.
For more information, see TaskResults control.

EditorTask

The EditorTask control provides a suite of tools for Web-based editing of features in both versioned and non-versioned enterprise geodatabases. If configured, specific versions can be selected for editing. The run time dialog provides tools to modify, add, and remove feature geometry and attributes.
For more information, see EditorTask control.

FindAddressTask

The FindAddressTask control utilizes resources in the GeocodeResourceManager to perform geocode operations. The FindAddressTask control interface is created dynamically at run time based on the inputs required by the geocode resource it will use. The results are provided as an ADO.NET DataSet to be displayed in a TaskResults control.
For more information, see FindAddressTask control.

GeoprocessingTask

The GeoprocessingTask control utilizes resources in the GeoprocessingResourceManager to execute geoprocessing tasks. The GeoprocessingTask control interface is created dynamically at run time based on the inputs required by the geoprocessing resource and task it will use. The results, which include input and output parameters as well as progress messages, are provided as an ADO.NET DataSet to be displayed in a TaskResults control.
For more information, see GeoprocessingTask control.

PrintTask

The PrintTask control provides run time print capabilities to a Web ADF application. The PrintTask control enables you to print a map and task results, as well as a legend, scale bar, copyright, and north arrow.
For more information, see PrintTask control.

QueryAttributesTask

The QueryAttributesTask control enables you to explicitly define the parameters used to query values in a field. This control enhances the basic query capability of the SearchAttributesTask control. At run time, the QueryAttributesTask query can provide a drop-down list of preset choices or a text box for general text entry. Each query can utilize a validator to restrict the values entered. In addition, multiple queries can be grouped together to produce a single result. Only feature layers in resources provided by a MapResourceManager can be used. The results are provided as an ADO.NET DataSet to be displayed in a TaskResults control.
For more information, see QueryAttributesTask control.

SearchAttributesTask

The SearchAttributesTask control enables you to select fields, provided by resources, in which to search for the occurrence of a user-provided value. At run time, each field is queried for the occurrence of a value provided by the user. Partial values are permitted. Only feature layers in resources provided by a MapResourceManager can be used. The results are provided as an ADO.NET DataSet to be displayed in a TaskResults control.
For more information, see SearchAttributesTask control.

UserControlTask

The UserControlTask control enables you to integrate an ASP.NET user control as a task in an ADF application. The UserControlTask control only works with the ASP.NET AJAX partial postback pattern for asynchronous communication in a Web application. A ScriptManager must be on the page for the UserControlTask to function.
For more information, see UserControlTask control.


See Also:

Customizing the Web Mapping Application