Utility |
工具插件基类
Inheritance HierarchyNamespace: LoongCAD.STC.Plugins
Assembly: LoongSDKSTC (in LoongSDKSTC.dll) Version: 2024.0.9.3 (2024.0.9.3)
SyntaxC#
public class UtilityPlugin : Plugin
The UtilityPlugin type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ConfigPrefix |
插件存储的配置文件名称前缀，默认为$CONFIG$，子类可重写此属性以修改前缀
(Inherited from Plugin) |
| DebugMode |
返回True, 代表当前为调试模式，系统不会处理插件的任何错误，方便插件调试
返回False，代表当前为生产模式，系统会默认处理所有异常，不会因插件错误中断运行
(Inherited from Plugin) |
| FilePath | 插件文件路劲，由系统设置，开发者不应修改此项 |
| Guid |
插件GUID，子类需要重写此属性以返回插件自身的GUID，否则插件无法正常运行
(Inherited from Plugin) |
| PluginDataPrefix |
插件所有数据文件名称前缀，默认为CFG_PLUGIN_PROPS_，子类可重写此属性以修改前缀
(Inherited from Plugin) |
| RuntimeConfigName |
插件运行时属性配置名称，默认为$RUNTIME$，子类可重写此属性以修改此名称
(Inherited from Plugin) |
| SupportShortCut | 是否支持快捷键调用 |
| UtilityButtonText | 作为工具栏按钮时显示的文本 |
| UtilityDescription | 功能描述 |
| UtilityName | 工具名称 |
| UtilityShortDescription | 工具简介,会显示在Tip提示中 |
Methods| Name | Description | |
|---|---|---|
 | DeleteDocumentData |
删除当前插件的模型数据
(Inherited from Plugin) |
| DeleteGlobalData |
删除当前插件的全局数据
(Inherited from Plugin) |
| GetDocumentData |
获取当前插件的模型数据
(Inherited from Plugin) |
| GetGlobalData |
获取当前插件的全局数据
(Inherited from Plugin) |
| GetRuntimeData |
获取当前插件的运行时模型数据
(Inherited from Plugin) |
| IsUtilityValid | 当前工具此时是否有效 此属性决定，什么情况下，这个工具插件才能被调用 |
| OnClick | 当前工具插件在菜单或工具栏中被单击时的回调函数 |
| OnDocumentClose |
模型关闭回调
(Inherited from Plugin) |
| OnDocumentOpen |
模型打开回调
(Inherited from Plugin) |
| OnDoubleClick | 当前工具插件在工具栏中被双击时的回调函数 |
| OnPluginDispose |
插件销毁回调
(Inherited from Plugin) |
| OnPluginInit |
插件初始化方法
(Inherited from Plugin) |
| QueryDocumentDataNames |
查询当前插件的模型数据名称列表
(Inherited from Plugin) |
| QueryGlobalDataNames |
查询当前插件的所有全局数据名称
(Inherited from Plugin) |
| SaveDocumentData |
保存当前插件专属的模型数据
(Inherited from Plugin) |
| SaveGlobalData |
保存当前插件专属的全局数据
(Inherited from Plugin) |
| SaveRuntimeData |
保存当前插件的运行时模型数据
(Inherited from Plugin) |
See Also