Click or drag to resize

ComponentPlugin Class

返回用户文档首页
组件基类
Inheritance Hierarchy

Namespace: LoongCAD.STC.Plugins
Assembly: LoongSDKSTC (in LoongSDKSTC.dll) Version: 2025.0.9.7 (2025.0.9.7)
Syntax
C#
Copy
public abstract class ComponentPlugin : Plugin

The ComponentPlugin type exposes the following members.

Properties
 NameDescription
Public propertyButtonImage 显示在工具栏中的图标
Public propertyCommonPropsName 通用属性名称
Public propertyCompDescription 组件描述 若StandAlone属性为True，则必须重载此接口
Public propertyCompGroup 组件分组 若StandAlone属性为True，则必须重载此接口
Public propertyCompKeyword 组件关键词
Public propertyCompName 组件名称 组件必须重载此接口
Public propertyCompNumber 组件号码 组件必须重载此接口
Public propertyCompNumberPrefix 组件号码前缀，可以为空
Public propertyCompPath 组件所在目录
Public propertyCompShortDescription 组件简介 若StandAlone属性为True，则必须重载此接口
Public propertyCompType 组件对象类型 若StandAlone属性为True，则必须重载此接口
Public propertyConfigPrefix 插件存储的配置文件名称前缀，默认为$CONFIG$，子类可重写此属性以修改前缀
(Inherited from Plugin)
Public propertyCreateController 组件简介 若StandAlone属性为True，可以设置此接口完全重载创建过程
Public propertyDebugMode 返回True, 代表当前为调试模式，系统不会处理插件的任何错误，方便插件调试 返回False，代表当前为生产模式，系统会默认处理所有异常，不会因插件错误中断运行
(Inherited from Plugin)
Public propertyDefaultsConfigPrefix 组件默认值属性配置名称前缀，默认为$DEFAULT$，子类可重写此属性以修改前缀
Public propertyExportableFieldNames 可导出的字段属性名 若有需要导出的属性，则组件需要重载此属性
Public propertyFilePath 插件文件路劲，由系统设置，开发者不应修改此项
(Inherited from Plugin)
Public propertyFriendlyMode 插件是否为友好模式
Public propertyGuid 插件GUID，若未指定Guid, 则默认使用组件名称+组件编号的MD5生成Guid
(Overrides PluginGuid)
Public propertyPluginDataPrefix 插件所有数据文件名称前缀，默认为CFG_PLUGIN_PROPS_，子类可重写此属性以修改前缀
(Inherited from Plugin)
Public propertyRuntimeConfigName 插件运行时属性配置名称，默认为$RUNTIME$，子类可重写此属性以修改此名称
(Inherited from Plugin)
Public propertySelectedButtonImage 选中时的工具栏图标
Public propertyStandAlone 当前组件是否为完全由插件实现的独立组件
Public propertyThumbnail 显示在组件管理器中的缩略图
Top
Methods
 NameDescription
Public methodStatic memberCreateDefaultGuid 
Public methodDefineInput 友好模式下输入处理函数
Public methodDeleteDocumentData 删除当前插件的模型数据
(Inherited from Plugin)
Public methodDeleteGlobalData 删除当前插件的全局数据
(Inherited from Plugin)
Public methodGetDefaultsDataObsolete.
Public methodGetDocumentData 获取当前插件的模型数据
(Inherited from Plugin)
Public methodGetFieldDescription 获取可导出字段的描述信息，必要时子类需要实现此方法
Public methodGetFieldType 获取可导出字段的数据类型，必要时子类需要实现此方法
Public methodGetGlobalData 获取当前插件的全局数据
(Inherited from Plugin)
Public methodGetRuntimeData 获取当前插件的运行时模型数据
(Inherited from Plugin)
Public methodOnDefaultSetupShowFormObsolete.
Public methodOnDocumentClose 模型关闭回调
(Inherited from Plugin)
Public methodOnDocumentOpen 模型打开回调
(Inherited from Plugin)
Public methodOnInstanceCreate 创建组件实例的后处理操作，基于当前默认属性初始化组件
Public methodOnInstanceRemoveField 为组件实例移除FieldData
Public methodOnInstanceRun(BaseComponent) 友好模式下运行组件
Public methodOnInstanceRun(ComponentBase, Int64) 运行组件
Public methodOnInstanceSetField 为组件实例设置FieldData
Public methodOnInstanceShowFormObsolete.
Public methodOnInstanceWillRun 在组件即将刷新前执行
Public methodOnPluginDispose 插件销毁回调
(Inherited from Plugin)
Public methodOnPluginInit 插件初始化方法
(Inherited from Plugin)
Public methodOnShowDefaultPropsForm 显示组件属性目标默认值编辑窗口
Public methodOnShowInstancePropsForm(BaseComponent, Form) 友好模式下显示组件实例的属性窗
Public methodOnShowInstancePropsForm(ComponentBase, Int64, Form) 显示组件实例的属性窗
Public methodOnShowPluginPropsForm 显示组件属性窗
Public methodOnShowPropsFormObsolete.
显示组件属性窗
Public methodQueryDocumentDataNames 查询当前插件的模型数据名称列表
(Inherited from Plugin)
Public methodQueryGlobalDataNames 查询当前插件的所有全局数据名称
(Inherited from Plugin)
Public methodSaveDocumentData 保存当前插件专属的模型数据
(Inherited from Plugin)
Public methodSaveGlobalData 保存当前插件专属的全局数据
(Inherited from Plugin)
Public methodSaveRuntimeData 保存当前插件的运行时模型数据
(Inherited from Plugin)
Top
See Also