Working with the Task Framework

In this topic

• About tasks and the Web ADF
• Web ADF Task Framework
• Interfaces and classes
• Task support controls
• Out-of-the-box task controls
• UserControlTask control

About tasks and the Web ADF

Web ADF Task Framework  

• Interfaces and abstract classes to create custom tasks
• Controls to support task management and results
• Pluggable architecture to integrate a custom task in Visual Studio or ArcGIS Manager (Manager)

Interfaces and classes

• The items in "red" are part of the Web ADF Task Framework.
• The items in "green" show where you can customize the task framework and how it is related to existing framework components.
• The Task and FloatingPanelTask abstract classes implement the basic ITask interface. All interfaces can be used to create a custom task depending on the capabilities required by the task.
  
  

• ITaskDesigner to customize the Visual Studio design-time verbs available on the custom task control.
• IWebConfigurator interface to define how to integrate the custom task into the Manager application. This enables you to select the custom task from a list when creating a new Web application using Manager.
• ITaskResultsContainer interface to define a custom container or control to display task results.

namespace ESRI.ArcGIS.ADF.Web.UI.WebControls
{
    public interface ITask
    {
        string ShowUrl { get;}
        string Title { get; set;}
        string ToolTip { get;set;}
        string NavigationPath { get; set;}
        BuddyControlCollection TaskResultsContainers { get;}
        object Results { get;set;}
        void ExecuteTask();
        string TaskActivityIndicatorText { get;}
        bool GroupResultsByTable { get;set;}
        bool ShowFieldAttributes { get;set;}
        bool ShowLegend { get; set;}
        object Input { get; set;}
        void Refresh();
        void Show();
        CallbackResultCollection CallbackResults { get;}
        string UniqueID { get;}
        List<GISResourceItemDependency> GetGISResourceItemDependencies();
    }
}

Task support controls

• TaskManager—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. The TaskManager control is only visible at design time.
• TaskResults—Stores the results of tasks that produce ADO.NET DataSet output. The results are presented as nodes in TreeView. You can also use the TaskResults control to zoom or pan to a feature, highlight a feature in a result set, re-run a task, or remove task results.

Out-of-the-box task controls

• SearchAttributesTask—Enables you to select a set of 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 user-provided value. Partial values are permitted. Only feature layers in resources provided by MapResourceManager can be used. The results are provided as an ADO.NET DataSet to be displayed in a TaskResults control.
• QueryAttributesTask—Enables you to explicitly define the parameters used to query values in a field. This control enhances the basic query capability of SearchAttributesTask. 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 use a validator to restrict the values added. In addition, multiple queries can be grouped to produce a single result. Only feature layers in resources provided by MapResourceManager can be used. The results are provided as an ADO.NET DataSet to be displayed in a TaskResults control.  
• FindAddressTask—Utilizes resources in GeocodeResourceManager to perform geocode operations. The control interface is created dynamically at run time, based on the inputs required by the geocode resource it uses. The results (match or address candidates) are provided as an ADO.NET DataSet to be displayed in a TaskResults control.
• GeoprocessingTask—Uses resources in GeoprocessingResourceManager to execute geoprocessing tasks. The control interface is created dynamically at run time, based on the inputs required by the geoprocessing resource and the task it uses. The results, which include input and output parameters, and progress messages, are provided as an ADO.NET DataSet to be displayed in a TaskResults control.
• EditorTask—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 box provides tools to modify, add, and remove feature geometry and attributes.
• PrintTask—Provides run time print capabilities to a Web ADF application. It enables you to print a map and task results, along with a legend, scale bar, copyright, and north arrow.

UserControlTask Control

See Also: