ProSnippets Geoprocessing - kataya/arcgis-pro-sdk GitHub Wiki

// get the model tool's parameter syntax from the model's help
string input_roads = @"C:\data\Input.gdb\PlanA_Roads";
string buff_dist_field = "Distance";   // use values from a field
string input_vegetation = @"C:\data\Input.gdb\vegtype";
string output_data = @"C:\data\Output.gdb\ClippedFC2";

// the model name is ExtractVegetation
string tool_path = @"C:\data\MB\Models.tbx\ExtractVegetation";

var args = Geoprocessing.MakeValueArray(input_roads, buff_dist_field, input_vegetation, output_data);

var result = Geoprocessing.ExecuteToolAsync(tool_path, args);

var parameters = Geoprocessing.MakeValueArray(@"C:\data\data.gdb\HighwaysUTM11", @"C:\data\data.gdb\Highways_extent");
var ext = Geoprocessing.MakeEnvironmentArray(extent: "460532 3773964 525111 3827494");
var gp_result = await Geoprocessing.ExecuteToolAsync("management.CopyFeatures", parameters, ext);

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, args);

var gpItems = CoreModule.CurrentProject.Items.OfType<GeoprocessingProjectItem>();

// go through all the available toolboxes
foreach (var gpItem in gpItems)
{
  var itemsInsideToolBox = gpItem.GetItems();

  // then for each toolbox list the tools inside
  foreach (var toolItem in itemsInsideToolBox)
  {
    string newTool = String.Join(";", new string[] { toolItem.Path, toolItem.Name });
    // do something with the newTool
    // for example, add to a list to track or use them later
  }
}

// However, settings in Pro App's Geoprocessing Options will override option set in code
// for example, in Pro App's Options > Geoprocessing dialog, if you check 'Add output datasets to an open map'
// then the output WILL BE added to history overriding settings in code
var GPresult = Geoprocessing.ExecuteToolAsync(tool_path, args, null, null, null, GPExecuteToolFlags.None);

// However, settings in Pro App's Geoprocessing Options will override option set in code
// for example, if in Options > Geoprocessing dialog, if you uncheck 'Write geoprocessing operations to Geoprocessing History'
// then the output will not be added to history. 
var result2 = Geoprocessing.ExecuteToolAsync(tool_path, args, null, null, null, GPExecuteToolFlags.AddToHistory);

//The data referenced in this snippet can be downloaded from the arcgis-pro-sdk-community-samples repo
//https://github.com/Esri/arcgis-pro-sdk-community-samples
protected async Task<string> CreateRings(EditingTemplate currentTemplate)
      {
  var valueArray = await QueuedTask.Run(() =>
  {
      return Geoprocessing.MakeValueArray(currentTemplate.MapMember.Name,
            @"C:\Data\FeatureTest\FeatureTest.gdb\Points_MultipleRingBuffer",
            new List<string> { "1000", "2000" }, "Meters", "Distance",
            "ALL", "FULL");
  });
  IGPResult gpResult = await Geoprocessing.ExecuteToolAsync("Analysis.MultipleRingBuffer", valueArray);
  return string.IsNullOrEmpty(gpResult.ReturnValue)
        ? $@"Error in gp tool: {gpResult.ErrorMessages}"
        : $@"Ok: {gpResult.ReturnValue}";
      }

//The data referenced in this snippet can be downloaded from the arcgis-pro-sdk-community-samples repo
//https://github.com/Esri/arcgis-pro-sdk-community-samples
protected async Task<string> NonBlockingExecuteGP(EditingTemplate currentTemplate)
{
  var valueArray = await QueuedTask.Run(() =>
  {
    string in_data = @"C:\tools\data.gdb\cities";
    string cities_buff = @"E:\data\data.gdb\cities_2km";

    return Geoprocessing.MakeValueArray(in_data, cities_buff, "2000 Meters");
  });

  // to let the GP tool run asynchronously without blocking the main thread
  // use the GPThread option of GPExecuteToolFlasgs
  //
  GPExecuteToolFlags flags = GPExecuteToolFlags.GPThread;  // instruct the tool run non-blocking GPThread
  IGPResult gpResult = await Geoprocessing.ExecuteToolAsync("Analysis.Buffer", valueArray, null, null, null, flags);

  return string.IsNullOrEmpty(gpResult.ReturnValue)
        ? $@"Error in gp tool: {gpResult.ErrorMessages}"
        : $@"Ok: {gpResult.ReturnValue}";
}

public async Task<IGPResult> ExecuteSnap()
{
  var environments = Geoprocessing.MakeEnvironmentArray(overwriteoutput: true);

  string toolName = @"Snap_edit";
   
  // Snap tool takes multiple inputs each of which has 
  // Three (3) parts: a feature class or layer, a string value and a distance
  // Each part is separated by a semicolon - you can get example of sytax from the tool documentation page
  var snapEnv = @"'C:/SnapProject/fgdb.gdb/line_1' END '2 Meters';'C:/SnapProject/fgdb.gdb/points_1' VERTEX '1 Meters';'C:/SnapProject/fgdb.gdb/otherline_1' END '20 Meters'";

  var parameters = await QueuedTask.Run(() =>
  {
    var infc = @"C:/SnapProject/fgdb.gdb/poly_1";
    return Geoprocessing.MakeValueArray(infc, snapEnv);
  });

  GPExecuteToolFlags tokens = GPExecuteToolFlags.RefreshProjectItems | GPExecuteToolFlags.GPThread | GPExecuteToolFlags.AddToHistory;

  var gpResult = await Geoprocessing.ExecuteToolAsync(toolName, parameters, environments, null, null, flags: tokens);

  return gpResult;
}