topic Re: Get Addin info Pro 3.0 in ArcGIS Pro SDK Questions

Get Addin info Pro 3.0

AbelPerez — Tue, 12 Jul 2022 17:47:24 GMT

At Pro 2.9 there was this great helper class that got info for your own addin. https://github.com/Esri/arcgis-pro-sdk-community-samples/tree/master/Content/AddInInfoManager

It bombs at 3.0 and I have not been able to locate an alternative API or other form of getting the info programmatically.

I tweaked the function and it turns out the the code is returning zero guid attributes:

public static string GetAddInGuid() { // get the GUID that identifies the current add-in Assembly exAssembly = Assembly.GetExecutingAssembly(); //GuidAttribute gAttribute = (GuidAttribute)exAssembly.GetCustomAttributes(typeof(GuidAttribute), true)[0]; object[] custAtts = exAssembly.GetCustomAttributes(typeof(GuidAttribute), true); if (custAtts.Length == 0) { throw new Exception("No custom attributes."); } GuidAttribute gAttribute = (GuidAttribute)custAtts[0]; // guid={903288ab-2c9c-4e49-8a3d-0321f68425c1} return string.Format("{{{0}}}", gAttribute.Value); }

Anyone know an alternative to programmatically get info for your own addin or just the GUID?

Re: Get Addin info Pro 3.0

StephenRhea2 — Tue, 12 Jul 2022 18:04:48 GMT

Haven't tried this with 3.0, but for 2.9 you need to pass false to GetCustomAttributes instead of true.

// ... var idAttribute = Assembly.GetExecutingAssembly().GetCustomAttributes(false).OfType<GuidAttribute>().FirstOrDefault(); if (idAttribute == null) return string.Empty; var id = idAttribute.Value; if (!Guid.TryParse(id, out var guid)) return string.Empty; // ...

Re: Get Addin info Pro 3.0

AbelPerez — Tue, 12 Jul 2022 18:14:52 GMT

So tried your code and I'm getting a null on line 3. I also tried just the plain jane GetCustomAttributes() and that also returns zero elements.

Re: Get Addin info Pro 3.0

Wolf — Tue, 12 Jul 2022 20:19:03 GMT

@AbelPerez , it appears that the AddinInfoManager sample was missing when we published the 3.0 community samples. Sorry about that, but i added a 3.0 version of the sample and it appeared to work for me. arcgis-pro-sdk-community-samples/Content/AddInInfoManager at master · Esri/arcgis-pro-sdk-community-samples (github.com)

Re: Get Addin info Pro 3.0

AbelPerez — Wed, 13 Jul 2022 13:54:13 GMT

@Wolf that is still a no-go for me. The line where it crashes is same as before

var attribute = (GuidAttribute)assembly.GetCustomAttributes(typeof(GuidAttribute), true)[0];

When I run string guidStr = AddIn.GetAddInId(); it seems that the function GetCustomAttributes returns an empty collection.

Rather odd since I started this project from scratch and used the guide here https://developers.arcgis.com/documentation/arcgis-add-ins-and-automation/arcgis-pro/tutorials/build-your-first-add-in/. I did however go to the Project Properties and change some stuff there. Mainly default namespace and assembly version. Mainly in the Package section.

Re: Get Addin info Pro 3.0

AbelPerez — Wed, 13 Jul 2022 17:53:23 GMT

Ok this is very odd. I thought I had changed something that broke it. But I just created a brand new Addin with the VS template, added a button, added the Addin and Extensions classes. It still bombs at the same line.

My guess is that a project migration from Framework to Core keeps some properties while a brand new project based on Core doesn't have them. Idk.

Re: Get Addin info Pro 3.0

tempStephenRhea_NV5 — Wed, 13 Jul 2022 18:32:50 GMT

I was wondering that as well. It seems like the way the Config.daml attributes are written to the assembly is different between .NET Framework 4.8 and .NET 6, assuming your daml file is the same in both, of course.

Re: Get Addin info Pro 3.0

AbelPerez — Wed, 13 Jul 2022 18:37:06 GMT

I looked up the documentation and it seems that parameter for isInherit is required in the call but ultimately ignored in GetCustomAttributes .

Re: Get Addin info Pro 3.0

AbelPerez — Wed, 13 Jul 2022 18:38:50 GMT

Unfortunately my knowledge base is limited when it comes to the writing of the assembly. But my tests showed that something is missing.

Re: Get Addin info Pro 3.0

GKmieliauskas — Thu, 14 Jul 2022 05:29:20 GMT

Hi,

Have you tried GetConfigDamlAddInInfo method from @Wolf suggested sample? Returning AddIn class has Id property and it must contain Guid you are looking. It works on 2.9

Re: Get Addin info Pro 3.0

AbelPerez — Thu, 14 Jul 2022 15:24:58 GMT

Yes I did and it works IF you know the file path of the addin. To know the path of the Addin you need the guid. So to get the guid, you need the guid.

// 1. get the filename of this .esriAddinX file var fileName = AddIn.GetAddInId(); // 2. get the config.daml content from the esriAddinX file var versionTuple = AddIn.GetConfigDamlAddInInfo(fileName); MessageBox.Show($@"Version: {versionTuple.Version} desktopVersion: {versionTuple.DesktopVersion} Id: {Module1.Id}");

But again this fails for me on line 2.

Re: Get Addin info Pro 3.0

Wolf — Thu, 14 Jul 2022 16:05:06 GMT

I am still looking at this issue. I was able to duplicate the difference in behavior between an Addin that is migrated to 3.0 and an Addin that is built with 3.0.

When migrating to 3.0 the migration process retains the existing AssemblyInfo.cs file (where the Assembly Guid attribute is set) and then sets the tag "GenerateAssemblyInfo" in the project file to false (false means the AssemblyInfo is used instead of auto generated assembly info). After migrating a project to 3.0 the Assembly Guid attribute is extracted from the migrated AssemblyInfo.cs (in essence this works just like in 2.x). This doesn't happen when creating a new project using the Addin project template because it is using the .Net default (which is: GenerateAssemblyInfo = true) which doesn't create the assembly info source and apparently doesn't generate an Assembly Guid attribute. I am trying to find another way to get the Guid.

As a workaround you could change the project file and add this under the first PropertyGroup tag:

<GenerateAssemblyInfo>false</GenerateAssemblyInfo>

and then add a n AssemblyInfo.cs file under the project's Properties folder (use and modify an AssemblyInfo.cs file from community samples).

Re: Get Addin info Pro 3.0

AbelPerez — Thu, 14 Jul 2022 15:49:58 GMT

@Wolf thank you so much. I also sent you some suggestions on the class methods.

Re: Get Addin info Pro 3.0

Wolf — Thu, 14 Jul 2022 16:45:48 GMT

I tried this method on both 2.x migrated projects and 3.0 created addin projects. There might be a better way to do this but for the time being this should work:

public static string GetAddInGuid() { // get the GUID that identifies the current add-in Assembly exAssembly = Assembly.GetExecutingAssembly(); var dirs = exAssembly.Location.Split(System.IO.Path.DirectorySeparatorChar); if (dirs.Length > 2 && Guid.TryParse(dirs[dirs.Length - 2], out Guid assemblyGuid)) { return assemblyGuid.ToString(); } throw new Exception($@"Assembly path doesn't contain a GUID: {exAssembly.Location}"); }

Re: Get Addin info Pro 3.0

AbelPerez — Thu, 14 Jul 2022 17:29:49 GMT

Ok let me try this. thank you.

Re: Get Addin info Pro 3.0

AbelPerez — Thu, 14 Jul 2022 18:23:19 GMT

Ok your alternative code works! Thank you so much. I made some very small modifications so that we can keep the prior logic, and it that doesn't work then use the new logic. I also wrapped the GUID with squigglies as that is probably what users expect. I also didn't want an exception thrown so on a fail I just return an empty string.

Here is my mod to your code:

/// <summary> /// Get the current add-in module's daml / AddInInfo Id tag (which is the same as the Assembly GUID) /// </summary> /// <returns></returns> public static string GetAddInId() { // Module.Id is internal, but we can still get the GUID from the assembly var assembly = Assembly.GetExecutingAssembly(); //var attribute = (GuidAttribute)assembly.GetCustomAttributes(typeof(GuidAttribute), true)[0]; object[] custAtts = assembly.GetCustomAttributes(typeof(GuidAttribute), true); Debug.Print("custAtts.Count={0}", custAtts.Count()); if (custAtts.Count() > 0) { GuidAttribute attribute = (GuidAttribute)custAtts[0]; string aguid = string.Format("{{{0}}}", attribute.Value); return aguid; } else { // if no custom attributes returned then try through the assembly location which has the GUID // embedded in the path. Debug.Print("assembly.Location={0}", assembly.Location); var dirs = assembly.Location.Split(Path.DirectorySeparatorChar); if (dirs.Length > 2 && Guid.TryParse(dirs[dirs.Length - 2], out Guid assemblyGuid)) { Debug.Print("assemblyGuid={0}", assemblyGuid.ToString()); string aguid = string.Format("{{{0}}}", assemblyGuid.ToString()); return aguid; } else { //throw new Exception($@"Assembly path doesn't contain a GUID: {assembly.Location}"); Debug.Print($@"Assembly path doesn't contain a GUID: {assembly.Location}"); return string.Empty; } } }

Re: Get Addin info Pro 3.0

Wolf — Fri, 15 Jul 2022 14:30:36 GMT

Thanks for your diligence on this issue. Also @UmaHarano wanted me to let you know that the API now has the AddInInfo Class

You can retrieve the list of all AddInInfos using FrameworkApplication.GetAddInInfos()

Using your GetAddInId() helper method allows to select the AddInInfo object for the running AddIn - here is the sample code for getting an AddInInfo instance for the running AddIn:

protected override void OnClick() { try { // get the ID of this Addin var myAddinGuid = GetAddInGuid(); var addinInfos = FrameworkApplication.GetAddInInfos(); var myAddin = addinInfos.Where(x => x.ID == myAddinGuid).FirstOrDefault(); if (myAddin != null) { MessageBox.Show(GetAddInInfoDetail(myAddin)); } else throw new Exception("Can't find Addin Guid"); } catch (Exception ex) { MessageBox.Show($@"Error: {ex.ToString()}"); } } private static string GetAddInInfoDetail(AddInInfo info) { StringBuilder sb = new(); sb.AppendLine($"Addin: {info.Name}"); sb.AppendLine($"Description {info.Description}"); sb.AppendLine($"ImagePath {info.ImagePath}"); sb.AppendLine($"Author {info.Author}"); sb.AppendLine($"Company {info.Company}"); sb.AppendLine($"Date {info.Date}"); sb.AppendLine($"Version {info.Version}"); sb.AppendLine($"FullPath {info.FullPath}"); sb.AppendLine($"DigitalSignature {info.DigitalSignature}"); sb.AppendLine($"IsCompatible {info.IsCompatible}"); sb.AppendLine($"IsDeleted {info.IsDeleted}"); sb.AppendLine($"TargetVersion {info.TargetVersion}"); sb.AppendLine($"ErrorMsg {info.ErrorMsg}"); sb.AppendLine($"ID {info.ID}"); sb.AppendLine(""); return sb.ToString(); } private static string GetAddInGuid() { // get the GUID that identifies the current add-in Assembly exAssembly = Assembly.GetExecutingAssembly(); var dirs = exAssembly.Location.Split(System.IO.Path.DirectorySeparatorChar); if (dirs.Length > 2 && Guid.TryParse(dirs[dirs.Length - 2], out Guid assemblyGuid)) { return $@"{{{assemblyGuid.ToString()}}}"; } throw new Exception($@"Assembly path doesn't contain a GUID: {exAssembly.Location}"); }

Re: Get Addin info Pro 3.0

AbelPerez — Fri, 15 Jul 2022 14:36:17 GMT

Yes thank you, I have that in my code from the 2.x days.