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