topic Re: ApplySymbologyFromLayer GeoProcessing Tool in ArcGIS Pro SDK Questions

ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Sun, 12 Dec 2021 08:45:28 GMT

Hi,

I'm trying to update the layers of a map by running the ApplySymbologyFromLayer GeoProcessing tool through some .NET code. For a while, there was a reported BUG-000106281 about this, but it is apparently fixed in 2.3.

But.....I still cannot get it to work. Is there something wrong with my code? All of my .lyr files are located on a network drive. I get a NULL Reference Exception at the .ExecuteToolAsync line.

Thanks,

                Map map = MapView.Active.Map;

                pBar.Minimum = 0;
                pBar.Maximum = map.Layers.Count;

                this.Cursor = Cursors.Wait;

                GPExecuteToolFlags flags = GPExecuteToolFlags.GPThread;

                foreach (Layer layer in map.GetLayersAsFlattenedList().OfType<FeatureLayer>())
                {   
                    var gpresult = await Geoprocessing.ExecuteToolAsync("ApplySymbologyFromLayer_management", new string[] { layer.Name.ToString(), @"K:\DSM Shared\ArcMap Symbology\10.2 Schema\Editing Symbols\" + layer.Name.ToString() + ".lyr" }, null, null, flags);
                    pBar.Value = pBar.Value + 1;
                }‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: ApplySymbologyFromLayer GeoProcessing Tool

KoryKramer — Wed, 19 Jun 2019 18:12:25 GMT

Maybe somebody in the ArcGIS Pro SDK‌ space could look since the question is about the code.

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Wed, 19 Jun 2019 18:16:39 GMT

I got it moved....thanks!

Re: ApplySymbologyFromLayer GeoProcessing Tool

Anonymous User — Sun, 12 Dec 2021 08:45:30 GMT

Brian,

Could be the cancellation source. Ive never had luck setting it to null and always specify a typed variable if needed.

      //create feature class from template
      var mva = Geoprocessing.MakeValueArray(@"C:\arcgis\ArcTutor\Editing\Zion.gdb", "test", "POINT",@"C:\arcgis\ArcTutor\Editing\Zion.gdb\Ranger_stations");
      var cts = new System.Threading.CancellationTokenSource();
      var result = await Geoprocessing.ExecuteToolAsync("CreateFeatureclass_management", mva, null, cts.Token,null,GPExecuteToolFlags.None);‍‍‍‍‍‍‍‍

If I didn't need to specify the GP flags i would just have the tool name and the value array like so:

mva = Geoprocessing.MakeValueArray(tablePath, "Layer", "STRING");
await Geoprocessing.ExecuteToolAsync("AddField_management", mva);‍‍

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Sun, 12 Dec 2021 08:45:33 GMT

Hi Sean Jones‌,

That is definitely helping and now I can get through the code with no errors, but....the symbology (from the layer file) still does not get applied.

I've tested using some hard coded values. When I use the Apply Symbology tool in ArcPro and use the same layer/layer file combination, it works. But when doing it through code it doesn't. No errors.....just no results. The original symbology is still there.

I've tried with both .lyr and .lyrx files.

Any ideas??

                    var mva = Geoprocessing.MakeValueArray("GISWRKS1.WORKS.WAT_Hydrant", @"K:\DSM Shared\ArcMap Symbology\TEST\Editing Symbols\GISWRKS1.WORKS.WAT_Hydrant.lyrx");
                    var gpresult = await Geoprocessing.ExecuteToolAsync("ApplySymbologyFromLayer_management", mva);‍‍

Re: ApplySymbologyFromLayer GeoProcessing Tool

GKmieliauskas — Thu, 20 Jun 2019 05:46:59 GMT

Hi Brian,

Have you tried to set GPExecuteToolFlags flags = GPExecuteToolFlags.GPThread;

More info here: https://community.esri.com/thread/198403-pro-20-bug-apply-symbology-from-layer-geoprocessing-tool

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Sun, 12 Dec 2021 08:45:36 GMT

Hi Gintautas Kmieliauskas‌,

Great, thanks! Things are working even better now. I can apply symbology through the code now, but it only works some of the time. If I only have one layer in my map, it works. But with multiple layers I run into problems. See example screenshots below, and the code is at the very bottom.

1. I add layers. They get the default symbology.

2. I want to apply custom symbology, so I click on my "Map Symbology" tool, pick a symbology ("Edit" in this case), and then click 'Symbolize'. The code runs, but only some of the layers get symbolized.

3. Only 2 of the 4 layers get the symbology applied. In the window I can see the name of each layer as it loops through them, and all 4 are hit, but only 2 get changed. The required 4 .lyr files are located in the network path in the code.

4. I then manually use the Apply Symbology from Layer GP Tool, to update the other layers. Basically doing the same thing that my the code should be doing. Manually it works.

Any ideas as to why this only works sometimes and not all the time??

Here is the code. It's a very simple loop.

namespace SymbologyTool_ArcPro
{
    /// <summary>
    /// Interaction logic for wdwSymbology.xaml
    /// </summary>
    public partial class wdwSymbology : ProWindow
    {
        public wdwSymbology()
        {
            InitializeComponent();
        }

        async private void btnSymbolize_Click(object sender, RoutedEventArgs e)
        {
            try
            {
                Map map = MapView.Active.Map;

                pBar.Minimum = 0;
                pBar.Maximum = map.Layers.Count;

                this.Cursor = Cursors.Wait;

                GPExecuteToolFlags flags = GPExecuteToolFlags.GPThread;
                                
                foreach (Layer layer in map.GetLayersAsFlattenedList().OfType<FeatureLayer>())
                {
                    lblLayerName.Content = layer.Name.ToString();
                    var mva = Geoprocessing.MakeValueArray(layer.Name.ToString(), @"K:\DSM Shared\ArcMap Symbology\10.2 Schema\Editing Symbols\" + layer.Name.ToString() + ".lyr");
                    var gpresult = await Geoprocessing.ExecuteToolAsync("ApplySymbologyFromLayer_management", mva, null, null, null, flags);
                    
                    pBar.Value = pBar.Value + 1;       
                }
            }

            catch  (Exception ex)
            {
                ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(ex.ToString());
            }
            
            finally
            {
                this.Cursor = Cursors.Arrow;
                MessageBox.Show("DONE");
                this.Close();
            }            
        }
    }
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: ApplySymbologyFromLayer GeoProcessing Tool

GKmieliauskas — Thu, 20 Jun 2019 14:05:12 GMT

Hi Brian,

I have had refreshing problems with symbolizing when using more complicated symbolization (symbol rotation, few different fields and etc.)

Have you tried refresh unsuccessful symbolized layers from layer property in TOC?

1. In opened layer properties select Cache page.

2. In Cache page press "Clear Cache".

3. After that choose "Don't cache any data locally". Press OK.

If it helps then you need to change your way and do not use ApplySymbologyFromLayer_management.

1. Remove existing layer

2. Create layer from lyr file

3. Update data source to removed layer path.

4.Clear cache

It sounds strange but I use that workaround from the beginning.

More info here:

https://community.esri.com/thread/198403-pro-20-bug-apply-symbology-from-layer-geoprocessing-tool

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Thu, 20 Jun 2019 14:51:19 GMT

Hi Gintautas Kmieliauskas‌,

Yes, I remember seeing that before, but removing and re-adding layers doesn't seem like a solution. More of a work-around to fix something that isn't working.

Sean Jones‌: Is there a bug with ApplySymbologyFromLayer in .NET?? I just want to figure out what I need to do moving forward.

Thanks,

Re: ApplySymbologyFromLayer GeoProcessing Tool

NobbirAhmed — Thu, 20 Jun 2019 21:14:15 GMT

Try this:

protected override async void OnClick()
{
Map map = MapView.Active.Map;

List<FeatureLayer> featLayers = map.GetLayersAsFlattenedList().OfType<FeatureLayer>().ToList();
FeatureLayer inputLayer = featLayers[0]; // the first layer will be updated with symbology

// Note: the layer file must have an extension of lyrx

string symbologyLayer = @"D:\ProSDKall\ApplySymbology\MyProject1\Stars.lyrx";

var parameters = Geoprocessing.MakeValueArray(inputLayer, symbologyLayer);

IGPResult pGPresult = await Geoprocessing.ExecuteToolAsync("management.ApplySymbologyFromLayer", parameters);

      await ArcGIS.Desktop.Framework.Threading.Tasks.QueuedTask.Run(() =>
            map.Redraw(true)   // this should redraw the layer with new symbology
      );
}

To apply symbology from another layer in the Map, such as the second layer, get that layer as:

FeatureLayer symbLayer = featLayers[1]; // symbology layer

FeatureLayer inputLayer = featLayers[0]; // this layer's symbology will be updated with featLayers[1]'s symbology

* Message me personally if you are still having problem

Re: ApplySymbologyFromLayer GeoProcessing Tool

Anonymous User — Thu, 20 Jun 2019 21:47:02 GMT

Hey Brian,

I'll pass it over to Nobbir from here.

I did some testing yesterday however and observed the following.

If the inputs have no spaces, then it seems to work all the time. (note that you cant find GP examples with spaces...)

With spaces in the paths (such as your example) then I got mixed results.

Old map with an old layer, i couldn't get it to work at all with just the command name and mva.

New map with a new layer then it works fine, even if the inputs have spaces. This concurs with Gintautas's comments above.

Putting the GPThread flag in the end also works for all scenarios, with the data I was using. Old or new. This kind of agrees with your last tests although you noticed it works some of the time.

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Fri, 21 Jun 2019 12:57:46 GMT

Hi Nobbir Ahmed‌,

I've modified your code to work with my filepaths and created a working .lyrx, but it makes no difference. Still the symbology does not apply. Also, for me the map.Redraw is not available. I am at 2.3.3. Are you using a different SDK??

Also, as Sean Jones‌ mentioned, I have tried this with and without spaces in my filepath, but it doesn't seem to make any difference.

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Sun, 12 Dec 2021 08:45:38 GMT

Hi Nobbir Ahmed‌,

Another thing I am noticing is that when the symbology does take, it doesn't always show up right. After manually doing some testing, it seems like it's the optionsal "Update Symbology Ranges by Data" field that needs to be modified to "MAINTAIN" in order for the symbology to show up properly.

I've added it to my Value Array, but when doing that it still only works once in a while.

var mva = Geoprocessing.MakeValueArray(layer.Name.ToString(), @"K:\DSM Shared\ArcMap Symbology\TEST\Editing Symbols\" + layer.Name.ToString() + ".lyrx", null, "MAINTAIN");‍‍‍

Not sure if that helps or just makes things more confusing.

Is there another way to accomplish updating the symbology without using the GP Tool?? In my ArcObjects code for ArcMap I do this same thing using the following code. Is there an equivalent method to this I should look at??

Do Until pLayer Is Nothing 'loop through all the layers
                
                'create an object to refence GxLayer, an ArcCatalog layer
                Dim gxLayer As IGxLayer = New GxLayerClass
                Dim gxFile As IGxFile = CType(gxLayer, IGxFile)

                If btnMapBooks.Checked = True Then
                    gxFile.Path = "K:\DSM Shared\ArcMap Symbology\10.2 Schema\Mapbook Symbols\" & pLayer.Name & ".lyr"
                ElseIf btnEditing.Checked = True Then
                    gxFile.Path = "K:\DSM Shared\ArcMap Symbology\10.2 Schema\Editing Symbols\" & pLayer.Name & ".lyr"
                ElseIf btnVLS.Checked = True Then
                    gxFile.Path = "K:\DSM Shared\ArcMap Symbology\10.2 Schema\VLS_Layers\" & pLayer.Name & ".lyr"
                End If


                If Dir$(gxFile.Path) <> "" Then
                    'if the .lyr file exists continue, else skip
                    Dim pGeoLayer As IGeoFeatureLayer
                    pGeoLayer = gxLayer.Layer
                    Dim pAnnoLayerPropsColl As IAnnotateLayerPropertiesCollection
                    pAnnoLayerPropsColl = pGeoLayer.AnnotationProperties

                    pLayer.Renderer = pGeoLayer.Renderer
                End If

                bCanceled = Not pTC.Continue

                'show a message box if the user hits ESC
                If bCanceled Then
                    MsgBox("Operation Cancelled.  Some layers may have been changed.", MsgBoxStyle.Critical, "User Interrupt")
                    Me.Cursor = Windows.Forms.Cursors.Arrow
                    Me.Close()
                    Exit Sub
                End If

                'go to the next layer
                pLayer = pEnumLayer.Next

                'increase the Progress Bar after each layer is processed
                pBar.Value = pBar.Value + 1

            Loop‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: ApplySymbologyFromLayer GeoProcessing Tool

UmaHarano — Sun, 12 Dec 2021 08:45:41 GMT

Hi Brian

Pro 2.4 allows you to apply symbology from a layer file using the Pro .NET API. A new LayerDocument class at 2.4 provides this functionality.

Pro 2.4 will be released this week. Using Pro 2.4, the snippet below will apply symbology from a lyr file to a feature layer in the TOC.

private static async Task ModifyLayerSymbologyFromLyrFileAsync(IEnumerable<FeatureLayer> featureLayers, string layerFile)
        {
            await QueuedTask.Run( () => {
                foreach (var featureLayer in featureLayers)
                {
                    //Get the Layer Document from the lyrx file
                    var lyrDocFromLyrxFile = new LayerDocument(layerFile);
                    var cimLyrDoc = lyrDocFromLyrxFile.GetCIMLayerDocument();

                    //Get the renderer from the layer file
                    //This lyr file has a unique value renderer.
                    var rendererFromLayerFile = ((CIMFeatureLayer)cimLyrDoc.LayerDefinitions[0]).Renderer as CIMUniqueValueRenderer;

                    //Apply the renderer to the feature layer
                    featureLayer?.SetRenderer(rendererFromLayerFile);
                }
               
            });
        }‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Thanks

Uma

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Tue, 25 Jun 2019 12:03:56 GMT

Sounds good. I will keep an eye out for the 2.4 update. Thanks for letting me know. I've been working with Nobbir to get the GP Tool code to work, but I'll check out this new class once it's available.

Re: ApplySymbologyFromLayer GeoProcessing Tool

BrianBulla — Sun, 12 Dec 2021 08:45:44 GMT

Uma Harano‌,

You are your team at esri are genius'!! This works really well and is way faster than using the GP tool Thanks so much for the sample code. I only had to make a slight modification to it, and it works perfectly.

Gintautas Kmieliauskas‌, check it out.

using ArcGIS.Desktop.Framework.Controls;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Shapes;
using ArcGIS.Desktop.Mapping;
using ArcGIS.Desktop.Catalog;
using ArcGIS.Desktop.Framework.Threading.Tasks;
using ArcGIS.Desktop.Core.Geoprocessing;
using ArcGIS.Core.CIM;

namespace SymbologyTool_ArcPro
{
    /// <summary>
    /// Interaction logic for wdwSymbology.xaml
    /// </summary>
    public partial class wdwSymbology : ProWindow
    {
        public wdwSymbology()
        {
            InitializeComponent();
        }

        private static async Task ModifyLayerSymbologyFromLyrFileAsync(IEnumerable<FeatureLayer> featureLayers)
        {
            await QueuedTask.Run(() => {
                foreach (var featureLayer in featureLayers)
                {
                    //Get the Layer Document from the lyrx file
                    var lyrDocFromLyrxFile = new LayerDocument(@"K:\DSM Shared\ArcMap Symbology\TEST\Editing Symbols\" + featureLayer.Name.ToString() + ".lyrx");
                    var cimLyrDoc = lyrDocFromLyrxFile.GetCIMLayerDocument();

                    //Get the renderer from the layer file
                    //This lyr file has a unique value renderer.
                    var rendererFromLayerFile = ((CIMFeatureLayer)cimLyrDoc.LayerDefinitions[0]).Renderer as CIMUniqueValueRenderer;

                    //Apply the renderer to the feature layer
                    featureLayer?.SetRenderer(rendererFromLayerFile);
                }

            });
        }

        async private void btnSymbolize_Click(object sender, RoutedEventArgs e)
        {
            try
            {
              
                Map map = MapView.Active.Map;

                this.Cursor = Cursors.Wait;

                await ModifyLayerSymbologyFromLyrFileAsync(map.GetLayersAsFlattenedList().OfType<FeatureLayer>());
            }

            catch  (Exception ex)
            {
                ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(ex.ToString());
            }
            
            finally
            {
                this.Cursor = Cursors.Arrow;
                MessageBox.Show("DONE");
                this.Close();
            }            
        }
    }
}

‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: ApplySymbologyFromLayer GeoProcessing Tool

GKmieliauskas — Thu, 04 Jul 2019 13:49:27 GMT

Hi Uma,

What about the same functionality for raster layers? I have installed 2.4 and found that RasterLayer does not have SetRenderer method.

My workarounds some how lock my data and I can't run calculations on the same database on ArcMap.

The place that locks my database is creating raster layer with symbology.

Re: ApplySymbologyFromLayer GeoProcessing Tool

UmaHarano — Sun, 12 Dec 2021 08:45:47 GMT

Hi Gintautas

Here is a code snippet for using this pattern with Raster layers. Raster use the Colorizer - Get/SetColorizer.

private static async Task ModifyLayerSymbologyFromLyrFileAsync(IEnumerable<RasterLayer> featureLayers, string layerFile)
        {
            await QueuedTask.Run(() =>
            {
                foreach (var featureLayer in featureLayers)
                {
                    //Get the Layer Document from the lyrx file
                    var lyrDocFromLyrxFile = new LayerDocument(layerFile);
                    var cimLyrDoc = lyrDocFromLyrxFile.GetCIMLayerDocument();

                    //Get the renderer from the layer file
                    //This lyr file has a unique value renderer.
                    var rendererFromLayerFile = ((CIMRasterLayer)cimLyrDoc.LayerDefinitions[0]).Colorizer as CIMRasterUniqueValueColorizer;

                    //Apply the renderer to the feature layer
                    featureLayer?.SetColorizer(rendererFromLayerFile);
                }

            });
        }‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Thanks

Uma

Re: ApplySymbologyFromLayer GeoProcessing Tool

GKmieliauskas — Tue, 09 Jul 2019 08:11:24 GMT

Hi Uma,

Thanks for reply.

Your snippet doesn’t work with old lyr files (crashes with HResult=0x80004005 Message=Could not determine encoding).

It does not work with “Classify“ colorizer in lyrx file too.

The only way what works is loading lyr(x) file and updating data source. But there are other problems with locking as I mentioned earlier.

Re: ApplySymbologyFromLayer GeoProcessing Tool

UmaHarano — Tue, 09 Jul 2019 18:22:10 GMT

I see the same issue with the old lyr file - I have informed the developer about this. I will let you know when this gets addressed.

With lyrx files, I was able to apply the symbology with the "Classify" colorizer - I did not load the lyrx file. Can you please explain the issues you are having?

Thanks

Uma