OpenToolDialog Method

In This Topic

Activate Geoprocessing pane and open the tool dialog in the pane.

Syntax

C#
Visual Basic (Declaration)

public static void OpenToolDialog( 
   string toolPath,
   IEnumerable<string> values,
   IEnumerable<KeyValuePair<string,string>> environments,
   bool newSubPane,
   GPToolExecuteEventHandler callback
)

Public Shared Sub OpenToolDialog( _
   ByVal toolPath As String, _
   ByVal values As IEnumerable(Of String), _
   Optional ByVal environments As IEnumerable(Of KeyValuePair(Of String,String)), _
   Optional ByVal newSubPane As Boolean, _
   Optional ByVal callback As GPToolExecuteEventHandler _
)

Parameters

toolPath

Use toolboxalias.toolname, toolname_toolboxalias pattern or full path

values

Array of parameter values

environments

Array of environment settings (name,value)

newSubPane

Add ToolDialog as new sub-pane

callback

callback events are:

OnBeginExecute - param = null. Can be sent miltiple times if user re-run the same tool
OnEndExecute - param type IGPResult. Can be sent miltiple times if user re-run the same tool
OnClose - param = null, send when user click back or open new tool in the same sub-pane

Example

open_dialog

string input_points = @"C:\data\ca_ozone.gdb\ozone_points";
      string output_polys = @"C:\data\ca_ozone.gdb\ozone_buff";
      string buffer_dist = "2000 Meters";

      var param_values = Geoprocessing.MakeValueArray(input_points, output_polys, buffer_dist);

      Geoprocessing.OpenToolDialog("analysis.Buffer", param_values);

Open a script tool dialog in Geoprocessing pane

string input_data = @"C:\data\data.gdb\Population";
      string out_pdf = @"C:\temp\Reports.pdf";
      string field_name = "INCOME";
      // use defaults for other parameters - no need to pass any value
      var arguments = Geoprocessing.MakeValueArray(input_data, out_pdf, field_name);

      string toolpath = @"C:\data\WorkflowTools.tbx\MakeHistogram";

      Geoprocessing.OpenToolDialog(toolpath, arguments);

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

Geoprocessing Class
Geoprocessing Members

Send feedback