AnsweredAssumed Answered

How to set the command group icons for different commands?

Question asked by Laxman Warpe on May 14, 2020
Latest reply on May 18, 2020 by Artem Taturevych

Like • Show 0 Likes0
Comment • 7

Hi everyone,

I am adding the icons to the menus and toolbars. The single icon is getting repeated in multiple commands for a single command group. The image is attached here

Here is my code snippet:

SW.ICommandGroup cmdGroup = CmdMgr.CreateCommandGroup2(MainCmdGroupId + (count++), title, toolTip, "", -1, ignorePrevious, ref cmdGroupErr);

string ImageDataPath = "E:\\Laxman Programs\\Test Images";
var playPath = ImageDataPath + @"\play.png";
var seekPath = ImageDataPath + @"\SeekStart.png";
var seekEndpath = ImageDataPath + @"\SeekEnd.png";
var partingpath = ImageDataPath + @"\partingline.png";
var pausePath = ImageDataPath + @"\Pause.png";
var warningPath = ImageDataPath + @"\warning.png";
icons[0] = playPath;
icons[1] = seekPath;
icons[2] = seekEndpath;
cmdGroup.IconList = icons;
// cmdGroup.MainIconList = mainIcons;
cmdIndex0 = cmdGroup.AddCommandItem("Create Layout", locationIndex++, "Create Layout", "Create Layout", 0, "CreateLayout", "EnableCommanMenu", 12);
cmdIndex1 = cmdGroup.AddCommandItem("Identify Elements", locationIndex++, "Identify Elements", "Identify Elements", 1, "IdentifyElements", "EnableCommanAxwMenu", 12);

var materialGroup = CmdMgr.CreateCommandGroup2(MainCmdGroupId + (count++), title + "\\Specify Materials", "Specify Materials", "", locationIndex++, ignorePrevious, ref cmdGroupErr);
icons = new string[3];
icons[0] = partingpath;
icons[1] = pausePath;
icons[2] = warningPath;
materialGroup.IconList = icons;
mtrIndex0 = materialGroup.AddCommandItem("Material 1", -1, "Material 1", "Material1", 0, "EditMaterial", "EnableCommanMenu", 12);
mtrIndex1 = materialGroup.AddCommandItem("Material 2", -1, "Material 2", "Material 2", 1, "EditMaterial", "EnableCommanMenu", 12);

I am not clear about the ImageListIndex in AddcommandItem. From which list we have to set the index.

Here I am just using the hardcoded paths for images. How to use the bit map images from the project Resource

folder? I am trying to access it by using the Properties.Resource.image but it returns the bitmap and the above lists need the icon paths (string).

Artem Taturevych May 15, 2020 6:03 AM

Correct Answer

Hi Laxman,

Basically, if you have toolbar with 10 icons for SW 2016 and older you should have 2 bitmaps (not png)

First would be 160x16 (i.e. 10 icons of 16x16 aligned in a row) (which is called small icons list)

Second would be 240x24 (i.e. 10 icons of 24x24 aligned in a row) (which is called large icon list)

For newer versions of SOLIDWORKS you will need to have high res icons (you still can use old icons but it won't take benefit of high res which is now supported). For that you need

200x20 (10 icons of 20x20)

....

1280x128 (10 icons of 128x128)

In summary, all icons in all those 10 files are repeated just in different sizes. It is not that big problem unless you are not planning to add too many icons or change them or need to develop several add-ins...

I know I have mentioned this to you before (so I apologize for repeating), but this is why I have developed SwEx. So with that framework you can have single icon (doesn't even need to be square of any size, something like 256x256 and framework will do the rest, it will scale icon for needed sizes, compose it etc. - all behind the scenes) so you won't need to do anything. So for example this how the code would look for 3 buttons:

[Icon(typeof(Resources), nameof(Resources.export))]
public enum ExportCommands_e
{
[Icon(typeof(Resources), nameof(Resources.export_parasolid))]
Parasolid,

[Icon(typeof(Resources), nameof(Resources.export_iges))]
Iges,

[Icon(typeof(Resources), nameof(Resources.export_step))]
Step
}

where export_parasolid, export_iges, export_step are just 3 png images of any size in the resources (no need to stack them in one line, no need to fit them in a specific size or use gray as transparency key, just any png as you would normally use in any windows application). You can get some project examples here: solidworks-api-examples/swex/add-in at master · codestackdev/solidworks-api-examples · GitHub.

I'm going to stop supporting this framework soon as I have switched it to a new xCAD framework which has way more functionality and adapted to the modern .NET (i.e. .NET Standard and .NET Core). It is already published and available, but I haven't published complete documentation yet, just some small snippets. But you can look at this demo to see it in full action: Implementing SOLIDWORKS® Top Ten List Ideas 2020 from scratch using xCAD.NET - YouTube

See the reply in context

No one else had this question

Outcomes

Peter Brinkhuis May 14, 2020 4:31 PM

SolidWorks uses sprites for these images, so a list of multiple images, stored in one file. You set the image index and it shows only that part of the image file. That's what the ImageListIndex parameter is for.

I also find getting the path to those images hard. I mark the images as an embedded resource, add them to a folder called Assets and use this to get the path:

const string imagePath = "Assets\\icons{0}.png";

string uriString = Assembly.GetExecutingAssembly().CodeBase;
string localPath = new Uri(uriString).LocalPath;
string assemblyFolder = Path.GetDirectoryName(localPath);
return Path.Combine(assemblyFolder ?? throw new InvalidOperationException(), imagePath);

Luckily SolidDna makes adding menu items a lot easier, so I hardly have to deal with the command manager. The {0} is because we use multiple icon sizes, SolidDna replaces the {0} with the icon sizes.

Actions

Artem Taturevych May 15, 2020 2:52 AM

Check remarks section here: 2016 SOLIDWORKS API Help - IconList Property (ICommandGroup)

For SW 2016 and older you should be using 24x24 and 16x16 image groups for a newer version to take a benefit of high res icons you need to provide 6 different sizes: 20x20...128x128

Actions

Laxman Warpe @ Artem Taturevych on May 15, 2020 5:31 AM

Artem Taturevych thanks for the replay.

I think I am not understanding it properly. Setting Icons in SolidWorks looks weird. By reading the remarks of the IconList property what I understood that:

1. The IconList array will contain the 6 strings for 6 icon sizes. Like 16x16, 24x24...

2. For example, I have 10 toolbar commands then each file will contain the 10 icons. (16x16 image file will contain 10 images for 10 icons,24x24 image file will contain 10 images for 10 icons,... up to 128x128).

But how single .png or .bmp file will contain the multiple .png/.bmp?

Once one file contains the 10 images then will it get assigned to the 10 toolbar commands automatically?

By the way, I am able to access the .png files from the Resource folder instead of hardcoded using bitmap handler and assembly Peter Brinkhuis Thanks.

Actions

Artem Taturevych @ Laxman Warpe on May 15, 2020 6:03 AM

Hi Laxman,

Basically, if you have toolbar with 10 icons for SW 2016 and older you should have 2 bitmaps (not png)

First would be 160x16 (i.e. 10 icons of 16x16 aligned in a row) (which is called small icons list)

Second would be 240x24 (i.e. 10 icons of 24x24 aligned in a row) (which is called large icon list)

For newer versions of SOLIDWORKS you will need to have high res icons (you still can use old icons but it won't take benefit of high res which is now supported). For that you need

200x20 (10 icons of 20x20)

....

1280x128 (10 icons of 128x128)

[Icon(typeof(Resources), nameof(Resources.export))]
public enum ExportCommands_e
{
[Icon(typeof(Resources), nameof(Resources.export_parasolid))]
Parasolid,

[Icon(typeof(Resources), nameof(Resources.export_iges))]
Iges,

[Icon(typeof(Resources), nameof(Resources.export_step))]
Step
}

Actions

Laxman Warpe @ Artem Taturevych on May 15, 2020 7:00 AM

Thanks, Artem,

For time being I will try the older icons SW 2016 and before first. The use of the framework in our project needs management permissions. I will keep it in my favorite folder. If I want to create new add-in then definitely I will use this framework.

Actions

Laxman Warpe @ Artem Taturevych on May 18, 2020 3:45 AM

Hi Artem,

I am able to set the icons for the toolbars. Thanks for your valuable time.

1. If I want to change the resolution from one size to another then, should I check the SolidWorks version and then apply the

appropriate image file programmatically or is there any other way?

2. The SolidWorks view settings icon is getting replaced by my toolbar icon. What could be the reason?

Actions

Artem Taturevych @ Laxman Warpe on May 18, 2020 4:13 AM

For icon sizes you have 2 combinations of options: control panel sizes and SOLIDWORKS sizes. Both options described here: Increase icon size?

If your add-in needs to be supported for 2016 or older, than you need to use obsolete methods (SmallIconsList, LargeIconsList) and test it with older SW, if you only need to support 2017 and newer - disregard this.

For the icon hijacking. I saw this and I see this more often now. This seems to be something with command ids messed up. I only notice this on dev machines, where I do a lot of rebuilding and different add-ins, renaming etc.. I have never seen this reported on the prod machines. You may try to clear registry to get rid of this issue.

Actions

7 Replies

Peter Brinkhuis May 14, 2020 4:31 PM
Mark Correct
Correct Answer
SolidWorks uses sprites for these images, so a list of multiple images, stored in one file. You set the image index and it shows only that part of the image file. That's what the ImageListIndex parameter is for.

I also find getting the path to those images hard. I mark the images as an embedded resource, add them to a folder called Assets and use this to get the path:

const string imagePath = "Assets\\icons{0}.png";
string uriString = Assembly.GetExecutingAssembly().CodeBase;
string localPath = new Uri(uriString).LocalPath;
string assemblyFolder = Path.GetDirectoryName(localPath);
return Path.Combine(assemblyFolder ?? throw new InvalidOperationException(), imagePath);

Luckily SolidDna makes adding menu items a lot easier, so I hardly have to deal with the command manager. The {0} is because we use multiple icon sizes, SolidDna replaces the {0} with the icon sizes.
Like • Show 1 Like1
Actions
Artem Taturevych May 15, 2020 2:52 AM
Mark Correct
Correct Answer
Check remarks section here: 2016 SOLIDWORKS API Help - IconList Property (ICommandGroup)

For SW 2016 and older you should be using 24x24 and 16x16 image groups for a newer version to take a benefit of high res icons you need to provide 6 different sizes: 20x20...128x128
Like • Show 0 Likes0
Actions
- Laxman Warpe @ Artem Taturevych on May 15, 2020 5:31 AM
  Mark Correct
  Correct Answer
  Artem Taturevych thanks for the replay.
  I think I am not understanding it properly. Setting Icons in SolidWorks looks weird. By reading the remarks of the IconList property what I understood that:
  1. The IconList array will contain the 6 strings for 6 icon sizes. Like 16x16, 24x24...
  2. For example, I have 10 toolbar commands then each file will contain the 10 icons. (16x16 image file will contain 10 images for 10 icons,24x24 image file will contain 10 images for 10 icons,... up to 128x128).
  But how single .png or .bmp file will contain the multiple .png/.bmp?
  Once one file contains the 10 images then will it get assigned to the 10 toolbar commands automatically?
  
  By the way, I am able to access the .png files from the Resource folder instead of hardcoded using bitmap handler and assembly Peter Brinkhuis Thanks.
  Like • Show 0 Likes0
  Actions
  - Artem Taturevych @ Laxman Warpe on May 15, 2020 6:03 AM
    Unmark Correct
    Correct Answer
    Hi Laxman,
    
    Basically, if you have toolbar with 10 icons for SW 2016 and older you should have 2 bitmaps (not png)
    
    First would be 160x16 (i.e. 10 icons of 16x16 aligned in a row) (which is called small icons list)
    Second would be 240x24 (i.e. 10 icons of 24x24 aligned in a row) (which is called large icon list)
    
    For newer versions of SOLIDWORKS you will need to have high res icons (you still can use old icons but it won't take benefit of high res which is now supported). For that you need
    
    200x20 (10 icons of 20x20)
    ....
    1280x128 (10 icons of 128x128)
    
    In summary, all icons in all those 10 files are repeated just in different sizes. It is not that big problem unless you are not planning to add too many icons or change them or need to develop several add-ins...
    
    I know I have mentioned this to you before (so I apologize for repeating), but this is why I have developed SwEx. So with that framework you can have single icon (doesn't even need to be square of any size, something like 256x256 and framework will do the rest, it will scale icon for needed sizes, compose it etc. - all behind the scenes) so you won't need to do anything. So for example this how the code would look for 3 buttons:
    
    [Icon(typeof(Resources), nameof(Resources.export))]
    public enum ExportCommands_e
    {
    [Icon(typeof(Resources), nameof(Resources.export_parasolid))]
      Parasolid,
    
      [Icon(typeof(Resources), nameof(Resources.export_iges))]
      Iges,
    
      [Icon(typeof(Resources), nameof(Resources.export_step))]
      Step
    }
    
    where export_parasolid, export_iges, export_step are just 3 png images of any size in the resources (no need to stack them in one line, no need to fit them in a specific size or use gray as transparency key, just any png as you would normally use in any windows application). You can get some project examples here: solidworks-api-examples/swex/add-in at master · codestackdev/solidworks-api-examples · GitHub.
    
    I'm going to stop supporting this framework soon as I have switched it to a new xCAD framework which has way more functionality and adapted to the modern .NET (i.e. .NET Standard and .NET Core). It is already published and available, but I haven't published complete documentation yet, just some small snippets. But you can look at this demo to see it in full action: Implementing SOLIDWORKS® Top Ten List Ideas 2020 from scratch using xCAD.NET - YouTube
    Like • Show 1 Like1
    Actions
    - Laxman Warpe @ Artem Taturevych on May 15, 2020 7:00 AM
      Mark Correct
      Correct Answer
      Thanks, Artem,
      For time being I will try the older icons SW 2016 and before first. The use of the framework in our project needs management permissions. I will keep it in my favorite folder. If I want to create new add-in then definitely I will use this framework.
      Like • Show 0 Likes0
      Actions
    - Laxman Warpe @ Artem Taturevych on May 18, 2020 3:45 AM
      Mark Correct
      Correct Answer
      Hi Artem,
      I am able to set the icons for the toolbars. Thanks for your valuable time.
      1. If I want to change the resolution from one size to another then, should I check the SolidWorks version and then apply the
      appropriate image file programmatically or is there any other way?
      2. The SolidWorks view settings icon is getting replaced by my toolbar icon. What could be the reason?
      Like • Show 0 Likes0
      Actions
      - Artem Taturevych @ Laxman Warpe on May 18, 2020 4:13 AM
        Mark Correct
        Correct Answer
        For icon sizes you have 2 combinations of options: control panel sizes and SOLIDWORKS sizes. Both options described here: Increase icon size?
        
        If your add-in needs to be supported for 2016 or older, than you need to use obsolete methods (SmallIconsList, LargeIconsList) and test it with older SW, if you only need to support 2017 and newer - disregard this.
        
        For the icon hijacking. I saw this and I see this more often now. This seems to be something with command ids messed up. I only notice this on dev machines, where I do a lot of rebuilding and different add-ins, renaming etc.. I have never seen this reported on the prod machines. You may try to clear registry to get rid of this issue.
        Like • Show 0 Likes0
        Actions

How to set the command group icons for different commands?

Outcomes

Related Content

Recommended Content