topic Re: Remove all construction tools in ArcGIS Pro SDK Questions

Remove all construction tools

JonathanDewalt — Tue, 10 Sep 2024 15:27:49 GMT

Has anybody got this sample to work? I want to be able to remove all construction tools and only use the my custom tools but I can't seem to find a way to remove the default tools without having to manually enter the ID for each and everytool. This example off ESRI web page shows featLayer.GetTemplates but the GetTemplates function does not exist.

QueuedTask.Run(() =>
{
  //hide all tools except line tool on layer  var featLayer = MapView.Active.Map.FindLayers("Roads").First();

  var editTemplates = featLayer.GetTemplates();
  var newCIMEditingTemplates = new List<CIMEditingTemplate>();

  foreach (var et in editTemplates)
  {
    //initialize template by activating default tool    et.ActivateDefaultToolAsync();
    var cimEditTemplate = et.GetDefinition();
    //get the visible tools on this template    var allTools = et.ToolIDs.ToList();
    //add the hidden tools on this template    allTools.AddRange(cimEditTemplate.GetExcludedToolIDs().ToList());
    //hide all the tools then allow the line tool  
    //At 2.x -
    //allTools.AddRange(cimEditTemplate.GetExcludedToolDamlIds().ToList());    allTools.AddRange(cimEditTemplate.GetExcludedToolIDs().ToList());
    
    //At 2.x - 
    //cimEditTemplate.SetExcludedToolDamlIds(allTools.ToArray());
    //cimEditTemplate.AllowToolDamlID("esri_editing_SketchLineTool");    
    cimEditTemplate.SetExcludedToolIDs(allTools.ToArray());
    cimEditTemplate.AllowToolID("esri_editing_SketchLineTool");
    newCIMEditingTemplates.Add(cimEditTemplate);
  }
  //update the layer templates  var layerDef = featLayer.GetDefinition() as CIMFeatureLayer;
  // Set AutoGenerateFeatureTemplates to false for template changes to stick  layerDef.AutoGenerateFeatureTemplates = false;
  layerDef.FeatureTemplates = newCIMEditingTemplates.ToArray();
  featLayer.SetDefinition(layerDef);
});

Re: Remove all construction tools

GKmieliauskas — Tue, 10 Sep 2024 17:00:20 GMT

Hi,

GetTemplates is static function of MappingExtensions class with MapMember type parameter. You need to add using :

using ArcGIS.Desktop.Mapping;

There are 2 alternatives to use GetTemplates method:

var editTemplates = featLayer.GetTemplates();
// or
var editTemplates1 = MappingExtensions.GetTemplates(featLayer);

Re: Remove all construction tools

JonathanDewalt — Tue, 10 Sep 2024 17:54:30 GMT

Hello,
I am using ArcGIS.Desktop.Mapping but it says GetTemplates does not exist and MappingExtensions also does not exist in ArcGIS.Desktop.Mapping

Re: Remove all construction tools

GKmieliauskas — Tue, 10 Sep 2024 18:11:50 GMT

What ArcGIS Pro SDK version do you use?

Re: Remove all construction tools

JonathanDewalt — Tue, 10 Sep 2024 19:12:30 GMT

Using 3.0 and also tried in 3.3

Re: Remove all construction tools

GKmieliauskas — Wed, 11 Sep 2024 10:48:17 GMT

I have tested on 3.1 and it works

Re: Remove all construction tools

UmaHarano — Wed, 11 Sep 2024 17:00:17 GMT

Hi @JonathanDewalt

When I run the tool, the Create features pane needed to be open. If it was not open, the code did not work. In your scenario, was the Create Features pane open?

Re: Remove all construction tools

JonathanDewalt — Wed, 11 Sep 2024 18:08:30 GMT

Right now it won’t even compile as it says the GetTemplates does not exist even though I am using ArcGis.desktop.mapping

Re: Remove all construction tools

UmaHarano — Wed, 11 Sep 2024 22:08:17 GMT

Would it be possible for you to zip up your code and send it over as an attachment?

Re: Remove all construction tools

JonathanDewalt — Mon, 16 Sep 2024 15:11:22 GMT

Here is a sample test class. I get compiler errors stating that MappingExtensions and GetTemplates do not exist.

using ArcGIS.Core.CIM;
using ArcGIS.Desktop.Framework.Threading.Tasks;
using ArcGIS.Desktop.Mapping;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace rmg.AlbertaWildfireTools.Core
{
public class Test
{

public static async Task SetConstructionToolsAsync(object sender, Layer layer, CancellationToken cancellationToken = default(CancellationToken))
{
await QueuedTask.Run(() => SetConstructionTools(sender, layer, cancellationToken));
}

public static void SetConstructionTools(object sender, Layer featLayer, CancellationToken cancellationToken = default(CancellationToken))
{

try
{
//self-documenting thread check
if (!QueuedTask.OnWorker) throw new ArcGIS.Core.CalledOnWrongThreadException();

if (cancellationToken.IsCancellationRequested == true)
{
rmg.Common.Events.ProgressBarEvents.OnTaskCancelled(sender);
return;
}

// var featLayer = MapView.Active.Map.FindLayers("Roads").First();

var x = MappingExtensions.GetTemplates(featLayer);
var editTemplates = featLayer.GetTemplates();

var newCIMEditingTemplates = new List<CIMEditingTemplate>();

foreach (var et in editTemplates)
{
//initialize template by activating default tool
et.ActivateDefaultToolAsync();
var cimEditTemplate = et.GetDefinition();
//get the visible tools on this template
var allTools = et.ToolIDs.ToList();
//add the hidden tools on this template
allTools.AddRange(cimEditTemplate.GetExcludedToolIDs().ToList());
//hide all the tools then allow the line tool

//At 2.x -
//allTools.AddRange(cimEditTemplate.GetExcludedToolDamlIds().ToList());
allTools.AddRange(cimEditTemplate.GetExcludedToolIDs().ToList());

//At 2.x -
//cimEditTemplate.SetExcludedToolDamlIds(allTools.ToArray());
//cimEditTemplate.AllowToolDamlID("esri_editing_SketchLineTool");

cimEditTemplate.SetExcludedToolIDs(allTools.ToArray());
cimEditTemplate.AllowToolID("rmg_AlbertaWildfireTools_Buttons_Editing_ConstructionTool_FireLine");
newCIMEditingTemplates.Add(cimEditTemplate);
}
//update the layer templates
var layerDef = featLayer.GetDefinition() as CIMFeatureLayer;
// Set AutoGenerateFeatureTemplates to false for template changes to stick
layerDef.AutoGenerateFeatureTemplates = false;
layerDef.FeatureTemplates = newCIMEditingTemplates.ToArray();
featLayer.SetDefinition(layerDef);

}
catch (Exception ex)
{
rmg.Common.Events.ProgressBarEvents.OnTaskCancelled(sender);
// errorHandler.WriteError(ex, "kkkkfeer");
return;
}

}

}
}

Re: Remove all construction tools

GKmieliauskas — Tue, 17 Sep 2024 13:14:03 GMT

Hi,

I have added your class to Esri Community sample AddFeatureTest, commented 2 lines with rmg.Common.Events.ProgressBarEvents.OnTaskCancelled and compiled without problems.

Check your Visual Studio project, .Net framework version, installed ArcGIS extensions and etc.

Re: Remove all construction tools

JonathanDewalt — Mon, 23 Sep 2024 20:44:17 GMT

Got it working. My code was missing the ArcGIS .Desktop.Extensions reference.