Component |
组件基类
Inheritance HierarchySystemObject
LoongCAD.STC.PluginsPlugin
LoongCAD.STC.PluginsComponentPlugin
LoongCAD.STC.PluginsConnectionCompPlugin
LoongCAD.STC.PluginsCustomCompPlugin
LoongCAD.STC.PluginsDetailCompPlugin
LoongCAD.STC.PluginsPartCompPlugin
LoongCAD.STC.PluginsPlugin
LoongCAD.STC.PluginsComponentPlugin
LoongCAD.STC.PluginsConnectionCompPlugin
LoongCAD.STC.PluginsCustomCompPlugin
LoongCAD.STC.PluginsDetailCompPlugin
LoongCAD.STC.PluginsPartCompPlugin
Namespace: LoongCAD.STC.Plugins
Assembly: LoongSDKSTC (in LoongSDKSTC.dll) Version: 2025.0.9.12 (2025.0.9.12)
SyntaxC#
public abstract class ComponentPlugin : Plugin, IDefineInputPlugin
The ComponentPlugin type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ButtonImage | 显示在工具栏中的图标 |
| CommonPropsName | 通用属性名称 |
| CompDescription | 组件描述 若StandAlone属性为True，则必须重载此接口 |
| CompGroup | 组件分组 若StandAlone属性为True，则必须重载此接口 |
| CompKeyword | 组件关键词 |
| CompName | 组件名称 组件必须重载此接口 |
| CompNumber | 组件号码 组件必须重载此接口 |
| CompPath | 组件所在目录 |
| CompShortDescription | 组件简介 若StandAlone属性为True，则必须重载此接口 |
| CompType | 组件对象类型 若StandAlone属性为True，则必须重载此接口 |
| ConfigPrefix |
插件存储的配置文件名称前缀，默认为$CONFIG$，子类可重写此属性以修改前缀
(Inherited from Plugin) |
| CreateController | 组件简介 若StandAlone属性为True，可以设置此接口完全重载创建过程 |
| DebugMode |
返回True, 代表当前为调试模式，系统不会处理插件的任何错误，方便插件调试
返回False，代表当前为生产模式，系统会默认处理所有异常，不会因插件错误中断运行
(Inherited from Plugin) |
| DefaultsConfigPrefix | 组件默认值属性配置名称前缀，默认为$DEFAULT$，子类可重写此属性以修改前缀 |
| ExportableFieldNames | 可导出的字段属性名 若有需要导出的属性，则组件需要重载此属性 |
| FilePath |
插件文件路劲，由系统设置，开发者不应修改此项
(Inherited from Plugin) |
| FriendlyMode | 是否开启友好兼容模式 |
| Guid | (Overrides PluginGuid) |
| IconFileName | 图标文件名(不包含扩展名), 用于工具栏中插件按钮显示 |
| IconFileSubFolder | 图标文件相对插件所在目录的子路径 |
| PluginDataPrefix |
插件所有数据文件名称前缀，默认为CFG_PLUGIN_PROPS_，子类可重写此属性以修改前缀
(Inherited from Plugin) |
| RuntimeConfigName |
插件运行时属性配置名称，默认为$RUNTIME$，子类可重写此属性以修改此名称
(Inherited from Plugin) |
| SelectedButtonImage | 选中时的工具栏图标 |
| StandAlone | 当前组件是否为完全由插件实现的独立组件 |
| Thumbnail | 显示在组件管理器中的缩略图 |
| ThumbnailFileName | 缩略图文件名(不包含扩展名), 用于组件管理器中的缩略图模式显示 |
| ThumbnailFileSubFolder | 缩略图文件相对插件所在目录的子路径 |
Methods| Name | Description | |
|---|---|---|
 | DefineInput | 友好模式下输入处理函数 |
| DeleteDocumentData |
删除当前插件的模型数据
(Inherited from Plugin) |
| DeleteGlobalData |
删除当前插件的全局数据
(Inherited from Plugin) |
| GetDefaultsData | Obsolete. |
| GetDocumentData |
获取当前插件的模型数据
(Inherited from Plugin) |
| GetFieldDescription | 获取可导出字段的描述信息，必要时子类需要实现此方法 |
| GetFieldType | 获取可导出字段的数据类型，必要时子类需要实现此方法 |
| GetGlobalData |
获取当前插件的全局数据
(Inherited from Plugin) |
| GetRuntimeData |
获取当前插件的运行时模型数据
(Inherited from Plugin) |
| OnDefaultSetupShowForm | Obsolete. |
| OnDocumentClose |
模型关闭回调
(Inherited from Plugin) |
| OnDocumentOpen |
模型打开回调
(Inherited from Plugin) |
| OnFriendlyInstanceRun | 友好模式下运行组件 |
| OnFriendlyShowInstancePropsForm | 友好模式下显示组件实例的属性窗 |
| OnInstanceCreate | 创建组件实例的后处理操作，基于当前默认属性初始化组件 |
| OnInstanceRemoveField | 为组件实例移除FieldData |
| OnInstanceRun | 运行组件 |
| OnInstanceSetField | 为组件实例设置FieldData |
| OnInstanceShowForm | Obsolete. |
| OnInstanceWillRun | 在组件即将刷新前执行 |
| OnPluginDispose |
插件销毁回调
(Inherited from Plugin) |
| OnPluginInit |
插件初始化方法
(Inherited from Plugin) |
| OnShowDefaultPropsForm | 显示组件属性目标默认值编辑窗口 |
| OnShowInstancePropsForm | 显示组件实例的属性窗 |
| OnShowPluginPropsForm | 显示组件属性窗 |
| OnShowPropsForm | Obsolete. 显示组件属性窗 |
| QueryDocumentDataNames |
查询当前插件的模型数据名称列表
(Inherited from Plugin) |
| QueryGlobalDataNames |
查询当前插件的所有全局数据名称
(Inherited from Plugin) |
| SaveDocumentData |
保存当前插件专属的模型数据
(Inherited from Plugin) |
| SaveGlobalData |
保存当前插件专属的全局数据
(Inherited from Plugin) |
| SaveRuntimeData |
保存当前插件的运行时模型数据
(Inherited from Plugin) |
See Also