跳到主要内容

使用SwEx.AddIn框架在SOLIDWORKS工具栏中定义命令按钮

介绍使用SwEx框架在C#和VB.NET中定义SOLIDWORKS插件中命令组的方法 toc-group-name: labs-solidworks-swex

定义命令​

SwEx框架允许在枚举（enum）中定义命令。在这种情况下，枚举值将成为相应命令的ID。

Public Enum CommandsA_e
    CommandA1
    CommandA2
End Enum
public enum CommandsA_e
{
    CommandA1,
    CommandA2
}

命令装饰​

可以使用附加属性对命令进行装饰以定义命令的外观。

标题​

可以使用TitleAttribute来定义用户友好的标题。或者，任何继承DisplayNameAttribute的属性类都可以作为标题。

描述​

描述是当用户将鼠标悬停在命令上时在SOLIDWORKS命令栏中显示的文本。可以使用DescriptionAttribute来定义描述。

图标​

可以使用CommandIconAttribute来设置图标。这个属性有多个重载。用户可以提供：

  • 单个主图标
  • 2个图标（小图标和大图标）
  • 6个高分辨率图标（从SOLIDWORKS 2016开始支持）

也可以使用通用的IconAttribute来指定图标。

无论选择了上述哪个选项，SwEx框架都会根据SOLIDWORKS的版本适当地缩放图标。例如，如果为SOLIDWORKS 2016及更高版本指定了单个主图标，则会创建6个图标以支持高分辨率，对于旧版本的SOLIDWORKS，将创建2个图标（大图标和小图标）。如果用户指定了6个图标，则所有图标都将在SOLIDWORKS 2016或更新版本中按原样使用，但在旧版本中将转换为2个图标（小图标和大图标），因为在SOLIDWORKS 2016之前的版本中不支持高分辨率图标。

支持透明度。SwEx框架将自动为与SOLIDWORKS兼容性分配所需的透明度键。

图标可以从任何静态类引用。通常，这应该是一个资源类。需要将资源类的类型指定为第一个参数，并将资源名称指定为附加参数。使用nameof关键字加载资源名称以避免使用“魔术”字符串。

Imports CodeStack.SwEx.Common.Attributes
Imports CodeStack.SwEx.My.Resources
Imports System.ComponentModel

<Title(GetType(Resources), NameOf(Resources.ToolbarTitle))>
<Description("Command Group Title")>
<Icon(GetType(Resources), NameOf(Resources.commands))>
Public Enum CommandsB_e

    <Title("First Command")>
    <Description("Hint text for first command")>
    <Icon(GetType(Resources), NameOf(Resources.command1))>
    CommandB1

    <Title("Second Command")>
    <Description("Hint text for second command")>
    <Icon(GetType(Resources), NameOf(Resources.command2))>
    CommandB2

    <Title("Third Command")>
    <Description("Hint text for third command")>
    <Icon(GetType(Resources), NameOf(Resources.command3))>
    CommandB3

End Enum
using CodeStack.SwEx.Common.Attributes;
using CodeStack.SwEx.Properties;
using System.ComponentModel;

[Title(typeof(Resources), nameof(Resources.ToolbarTitle))]
[Description("Command Group Title")]
[Icon(typeof(Resources), nameof(Resources.commands))]
public enum CommandsB_e
{
    [Title("First Command")]
    [Description("Hint text for first command")]
    [Icon(typeof(Resources), nameof(Resources.command1))]
    CommandB1,

    [Title("Second Command")]
    [Description("Hint text for second command")]
    [Icon(typeof(Resources), nameof(Resources.command2))]
    CommandB2,

    [Title("Third Command")]
    [Description("Hint text for third command")]
    [Icon(typeof(Resources), nameof(Resources.command3))]
    CommandB3
}

命令范围​

可以为每个命令分配操作范围（即可以执行该命令的环境，例如零件、装配等）。可以使用CommandItemInfoAttribute属性通过在属性的构造函数的suppWorkspaces参数中指定值来分配范围。swWorkspaceTypes_e是一个标志枚举，因此可以组合工作区。

框架将根据指定的范围自动禁用/启用命令，以基于活动环境分配状态。有关分配状态的其他逻辑，请参阅自定义启用命令状态文章。

Imports CodeStack.SwEx.AddIn.Attributes
Imports CodeStack.SwEx.AddIn.Enums

Public Enum CommandsD_e

    <CommandItemInfo(swWorkspaceTypes_e.Part)>
    CommandD1

    <CommandItemInfo(swWorkspaceTypes_e.Part Or swWorkspaceTypes_e.Assembly)>
    CommandD2

End Enum
using CodeStack.SwEx.AddIn.Attributes;
using CodeStack.SwEx.AddIn.Enums;

public enum CommandsD_e
{
    [CommandItemInfo(swWorkspaceTypes_e.Part)]
    CommandD1,

    [CommandItemInfo(swWorkspaceTypes_e.Part | swWorkspaceTypes_e.Assembly)]
    CommandD2
}

用户分配的命令组ID​

CommandGroupInfoAttribute允许将静态命令ID分配给组。这应该应用于枚举器定义。如果不使用此属性，SwEx框架将自动分配ID。

Imports CodeStack.SwEx.AddIn.Attributes

<CommandGroupInfo(2)>
Public Enum CommandsE_e
    CommandE1
    CommandE2
End Enum
using CodeStack.SwEx.AddIn.Attributes;

[CommandGroupInfo(2)]
public enum CommandsE_e
{
    CommandE1,
    CommandE2
}