概述
SView Designer Control为OCX控件提供三维模型基本的浏览、模型属性操作、基本三维对象操作、动画播放等功能的实现接口,可实现基本的 三维模型展示功能,以便于用户个性化定制属于自己的产品。文档主要介绍了OCX控件提供的接口说明。SView Designer Control控件集成说明的介绍请查看SView Designer Control 集成说明文档。
接口列表
基本浏览
打开本地文件
方法
void Open(BSTR fileName)
说明
打开本地文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
fileName | 是 | 本地文件路径。 |
返回值
TRUE-成功FALSE-失败
备注
D:\\1.svl 打开D盘下的1.svl文件
显示已加载的模型
方法
VARIANT_BOOL Show()
说明
显示已加载的模型
参数
无
返回值
TRUE-成功FALSE-失败
备注
无
打开显示模型
方法
VARIANT_BOOL OpenShow(BSTR fileName)
说明
打开显示模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
fileName | 是 | 模型本地路径文件 |
返回值
TRUE-成功FALSE-失败
备注
无
关闭模型文件
方法
void Close()
说明
关闭模型文件
参数
无
返回值
无
备注
无
保存模型
方法
VARIANT_BOOL Save(BSTR filePath, BOOL bDistribution)
说明
将当前模型保存到指定目录
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 文件保存路径 |
bDistribution | 是 | 是否分散存储 |
返回值
TRUE-成功FALSE-失败
备注
无
设置选择的模型
方法
void SelectModels(BSTR objid)
说明
设置选择的模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
objid | 是 | 输入参数,模型实例ID (如:PATH|0|2;PATH|0|5 多个用分号隔开) |
返回值
void
备注
无
设置选择的模型
方法
void SelectModels2(BSTR objid,BYTE selPolicy)
说明
设置选择的模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
objid | 是 | 输入参数,模型实例ID (如:PATH|0|2;PATH|0|5 多个用分号隔开) |
selPolicy | 是 | 值:0/1:0是取消之前所有的选中模型;1不取消之前选择的模型 |
返回值
void
备注
无
获取选择的模型
方法
BSTR GetSelectedModels()
说明
获取选择的模型
参数
无
返回值
选择模型ID数组(如:PATH|0|3,ELBOW_FIT;PATH|0|4,CLAMP)
备注
无
显隐模型
方法
void SetModelVisibility(BSTR objid,VARIANT_BOOL bshow)
说明
根据模型实例ID,显隐模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
objid | 是 | 模型实例ID(多个用逗号隔开,如PATH|0|1,PATH|0|3) |
bshow | 是 | 显示/隐藏状态 |
返回值
void
备注
无
设置模型颜色
方法
void SetModelSelected(BSTR svlPath, VARIANT_BOOL selected)
说明
设置模型颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
objColor | 是 | 要改变的颜色 |
svlPath | 是 | 对象ID(如:PATH|0|1) |
返回值
void
备注
获取父对象的ID
方法
void GetParentObject(BSTR objid)
说明
获取父对象的ID
参数
参数 | 是否必须 | 说明 |
---|---|---|
objid | 是 | 对象ID(如:PATH|0|1) |
返回值
void
备注
无
显示或者隐藏所有的模型
方法
void ChangeAllItemState(VARIANT_BOOL bshow)
说明
显示或者隐藏所有的模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
bshow | 是 | 显示/隐藏标志 |
返回值
void
备注
无
根据名称显隐零件
方法
void ShowFromName(LPCTSTR itemName,VARIANT_BOOL bshow,VARIANT_BOOL isOnly)
说明
根据名称显隐零件
参数
参数 | 是否必须 | 说明 |
---|---|---|
itemName | 是 | 零件名称(多个用分号隔开,区分大小写) |
bshow | 是 | 显示/隐藏标志 |
isOnly | 是 | 暂时未用 |
返回值
void
备注
无
根据名称设置模型的颜色
方法
void SetModelColorByName(LONG objColor,BSTR objName)
说明
根据名称设置模型的颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
objColor | 是 | 设置的颜色值 |
objName | 是 | 模型名称(多个用分号隔开) |
返回值
void
备注
无
获取视图列表
方法
BSTR GetModelViewList()
说明
获取视图列表
参数
无
返回值
回视图ID和名称组合字符串;格式如下:ID,名称;ID,名称。
备注
无
根据视图ID设置当前视图
方法
void SetModelViewByID(LONG viewID)
说明
根据视图ID设置当前视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
返回值
void
备注
无
获取当前视图ID
方法
LONG GetModelViewID()
说明
获取当前视图ID。
参数
无
返回值
当前视图ID
备注
无
显示默认视图
方法
void ShowDefaultView()
说明
显示默认视图
参数
无
返回值
void
备注
无
根据名称获取配置路径
方法
BSTR GetInstanceIDByName(BSTR objName)
说明
根据名称获取配置路径
参数
参数 | 是否必须 | 说明 |
---|---|---|
objName | 是 | 零件名称 (如:elbow(1)|BOLT(2)) |
返回值
零件内部ID,如果没有或者是跟节点,都返回 PATH|0
备注
无
根据配置路径获取零件名称
方法
BSTR GetNamesByInstanceId(BSTR objid)
说明
根据配置路径获取零件名称
参数
参数 | 是否必须 | 说明 |
---|---|---|
objid | 是 | objid 零件id (如:PATH|0|a) 路径是十六进制 |
返回值
零件名称
备注
无
添加模型
方法
int AddModel(BSTR filePath,BSTR parentID,BSTR* strNewPlcPath)
说明
添加模型接口
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 插入的模型文件路径 |
parentID | 是 | 父对象配置路径,如:PATH|0|3 |
strNewPlcPath | 是 | 输出值。新插入实例的ID |
返回值
0-成功1-失败
备注
无
删除模型
方法
int DeleteModelById(BSTR ids)
说明
删除模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 模型ID,多个中间用 ";"分割(如:PATH|0|2;PATH|0|5) |
返回值
0-成功1-失败
备注
无
设置模型实例显隐
方法
void SetObjLinkVisible(BSTR ids,BOOL bShow)
说明
设置模型实例显隐
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 模型ID,多个中间用";"分割(如:PATH|0|2;PATH|0|5) |
bShow | 是 | 显示/隐藏标志 |
返回值
void
备注
无
刷新视口
方法
VARIANT_BOOL RefreshViewWindow()
说明
刷新视口
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
根据属性获取实例
方法
BSTR GetInstanceIDByPropertyName(BSTR propertyName,BSTR objProperty)
说明
根据属性获取实例
参数
参数 | 是否必须 | 说明 |
---|---|---|
propertyName | 是 | 属性名 |
objProperty | 是 | 属性值 |
返回值
零件内部ID,如果没有或者是跟节点,都返回 PATH|0
备注
无
根据属性名称获取指定零件的属性值
方法
BSTR GetPropertyNameByID(BSTR objId,BSTR PropertyName)
说明
根据属性名称获取指定零件的属性值
参数
参数 | 是否必须 | 说明 |
---|---|---|
objId | 是 | 零组件配置路径(如:PATH|0|2) |
PropertyName | 是 | 属性名称 |
返回值
属性值
备注
无
添加属性
方法
VARIANT_BOOL AddProperty(BSTR plcPath,BSTR PropertyName,BSTR PropertyValue)
说明
添加属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 零组件配置路径。 |
PropertyName | 是 | 属性名称 |
PropertyValue | 是 | 属性值 |
返回值
TRUE-成功FASLE-失败
备注
无
编辑属性
方法
VARIANT_BOOL EditProperty(BSTR plcPath,BSTR PropertyName,BSTR PropertyValue)
说明
编辑属性,改变该属性名下的属性值
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 零组件配置路径 |
PropertyName | 是 | 属性名称 |
PropertyValue | 是 | 属性值 |
返回值
TRUE-成功FASLE-失败
备注
无
根据属性名获得属性值
方法
BSTR GetPropertyValueByPropertyName(BSTR plcPath,BSTR PropertyName)
说明
根据属性名获得属性值
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 零组件配置路径 |
PropertyName | 是 | 属性名称 |
返回值
属性值
备注
无
生成快照
方法
VARIANT_BOOL CustomScreenShot()
说明
生成快照
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
自定义截图
方法
VARIANT_BOOL CustomScreenShot()
说明
自定义截图
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
控制工具条显隐
方法
VARIANT_BOOL ShowHideToolBarByName(BSTR ToolBarName, VARIANT_BOOL bShowFlag)
说明
控制工具条显隐
参数
参数 | 是否必须 | 说明 |
---|---|---|
ToolBarName | 是 |
ToolBarName控制显隐的工具条名称: "Toolbar"工具条 "PMI"标记工具条 "CLIP"剖切工具条 "REC"录制工具条 "ASSY"装配工具条 "COLLISION"干涉工具条 "CABLE"线缆工具条选 |
bShowFlag | 是 | 工具条显隐 |
返回值
TRUE-成功FASLE-失败
备注
无
导出BOM装配结构到指定路径
方法
ARIANT_BOOL ExportBOM(BSTR filename)
说明
导出BOM装配结构到指定路径
参数
参数 | 是否必须 | 说明 |
---|---|---|
filename | 是 | BOM文件保存路径 |
返回值
TRUE-成功FASLE-失败
备注
无
设置工具栏按钮是否可用
方法
void SetToolBarItemEnable(BSTR itemName,VARIANT_BOOL state)
说明
设置工具栏按钮是否可用
参数
参数 | 是否必须 | 说明 |
---|---|---|
itemName | 是 | 按钮名称 |
state | 是 | 是否可用标志 |
返回值
void
备注
无
显示关于对话框
方法
void AboutBox()
说明
显示关于对话框
参数
无
返回值
void
备注
无
设置是否显示选中模型的包围盒标志
方法
void ShowBox(VARIANT_BOOL bShow)
说明
设置是否显示选中模型的包围盒标志
参数
参数 | 是否必须 | 说明 |
---|---|---|
bShow | 是 | 显示/隐藏标志 |
返回值
void
备注
无
获取包围盒的长、宽、高
方法
BSTR GetBox()
说明
获取是否显示选中模型的包围盒标志
参数
无
返回值
长宽高
备注
无
选中模型事件
事件
void OnModelSelected(BSTR objid,BSTR objname)
说明
选中模型事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
objid | 是 | 拾取零件的配置路径 |
objname | 是 | 拾取零件的名称 |
返回值
void
备注
无
鼠标事件
事件
void OnMouseEven(int mouseKey)
说明
鼠标事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
mouseKey | 是 |
1-单击左键 2-单击右键 3-双击左键 4-双击右键 |
返回值
void
备注
按下鼠标时触发,只实现了双击事件
打开文件后触发事件
事件
void OpenDocumentFinishEvent()
说明
打开文件后触发事件
参数
无
返回值
void
备注
无
自定义截图事件
事件
void OnCustomScreenShot()
说明
自定义截图
参数
无
返回值
void
备注
无
动画
播放动画
方法
void Play(SHORT mode)
说明
播放动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
mode | 是 | 0-复位 1-循环播放 2-播放 3-停止 4-继续 |
返回值
void
备注
无
创建新的步骤
方法
BSTR CreateStep()
说明
创建新的步骤
参数
无
返回值
步骤ID,如:0|1(0代表过程ID,1代表步骤ID)
备注
无
播放指定步骤ID的动画
方法
void PlayStepByID(BSTR strStepID)
说明
播放指定步骤ID的动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
strStepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
void
备注
无
删除指定步骤ID的动画
方法
void DeleteStep(BSTR strStepID)
说明
删除指定步骤ID的动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
strStepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
void
备注
无
设置成当前活动的步骤
方法
void SetCurStep(BSTR strStepID)
说明
设置成当前活动的步骤
参数
参数 | 是否必须 | 说明 |
---|---|---|
strStepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
void
备注
无
更新当前步骤
方法
void UpdateCurStep()
说明
更新当前步骤
参数
无
返回值
void
备注
无
开始播放动
方法
void BeginRec()
说明
开始播放动画,即把当前正在播放的动画清空
参数
无
返回值
void
备注
无
保存动画
方法
BSTR SaveAnimation()
说明
保存动画
参数
无
返回值
动画信息的字符串流
备注
无
播放指定文件的动画
方法
void PlayByXMLPaths(LPCTSTR strXMLPaths)
说明
播放指定文件的动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
strXMLPaths | 是 | 动画文件列表,用分号;隔开 |
返回值
void
备注
无
按步骤播放动画
方法
void PlayStep(LONG playMode,BOOL bReverse)
说明
按步骤播放动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
playMode | 是 | 播放模式(1:播放单个步骤 2:从当前步骤开始播放 3:播放一个过程 4:从当前过程播放 5:播放所有动画 6:播放当前的活动步骤) |
bReverse | 是 | 是否是倒播 |
返回值
void
备注
无
PMI
获取选择的PMI
方法
BSTR GetSelectPMI()
说明
获取选择的PMI
参数
无
返回值
选择的PMI ID集合中间用";"号分割。多行文本用"\r\n"分割
备注
无
选择PMI
方法
void SelectPMI(BSTR ids)
说明
选择PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 选择的PMI ID集合。多个PMI中间用";"号分割,多行文本用"\r\n"分割 |
返回值
void
备注
无
选择PMI
方法
void SelectPMI2(BSTR ids,BYTE selPolicy)
说明
选择PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 选择的PMI ID集合。多个PMI中间用";"号分割,多行文本用"\r\n"分割 |
selPolicy | 是 | 0-是取消之前所有的选中模型,1-不取消之前选择的模型 |
返回值
void
备注
无
设置PMI显隐状态
方法
void SetPMIVisibity(BSTR ids,bool bShow)
说明
设置PMI显隐状态
参数
参数 | 是否必须 | 说明 |
---|---|---|
ids | 是 | 选择的PMI ID集合。多个PMI中间用";"号分割,多行文本用"\r\n"分割 |
bShow | 是 | 显隐状态 |
返回值
void
备注
无
显示隐藏所有的PMI
方法
void ShowHideAllPMI(bool bShow)
说明
显示隐藏所有的PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
bShow | 是 | 显示隐藏所有的PMI |
返回值
void
备注
无
获取零组件对应的标注
方法
VARIANT_BOOL GetComponentNote(BSTR plcPath,BSTR* noteIDs,BSTR* noteNames)
说明
获取零组件对应的零组件标注
参数
参数 | 是否必须 | 说明 |
---|---|---|
plcPath | 是 | 零件配置路径(如:PATH|0|1) |
noteIDs | 是 | 零组件标注ID,多个用';'分割 |
noteNames | 是 | 零组件标注名称,多个用';'分割 |
返回值
TRUE-成功FASLE-失败
备注
无
根据PMI类型名称获取该类型所有PMI
方法
BSTR GetPMIInfo(BSTR propertyName)
说明
根据PMI类型名称获取该类型所有PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
propertyName | 是 | PMI类型名称 "COMPONENT_SN"代表零件序号PMI名称;"TORQUE"代表扭矩PMI名称;"GAP"表示间隙;""获取所有PMI信息 |
返回值
总装下所有该类型的PMI,格式为"配置路径1:PMI名称;配置路径2:PMI名称2"。当输入为"",获取所有PMI信息,格式为"id:内容,显隐状态;id:内容,显隐状态"。多行文本用"\r\n"分割
备注
目前,只支持“COMPONENT_SN”类型和“”
创建零组件标注
方法
VARIANT_BOOL CreateComponentNote()
说明
创建零组件标注
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
创建零组件序号标注
方法
VARIANT_BOOL CreateComponentSNNote()
说明
创建零组件序号标注
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
添加标注后缀
方法
VARIANT_BOOL AddNoteSuffix()
说明
给序号标注添加后缀功能
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
编辑标注后缀
方法
VARIANT_BOOL EditNoteSuffix()
说明
实现给已添加后缀的标注进行后缀的变更功能
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
根据ID获取PMI显隐状态
方法
BSTR GetPMIStateById(BSTR PMIId)
说明
根据ID获取PMI显隐状态
参数
参数 | 是否必须 | 说明 |
---|---|---|
PMIId | 是 | PMI ID集合。中间用";"号分割。 |
返回值
PMI的显示隐藏状态,格式为"PMIID1,显示隐藏状态1;PMIID2,显示隐藏状态2",例如:"id,true;id,false;"
备注
无
高亮PMI并打开关联视图
方法
void SelectAndShowView(BSTR PMIId)
说明
高亮显示PMI,并转到PMI关联的自定义视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
PMIId | 是 | PMI ID,该ID为源CAD模型中的CHECKID信息。 |
返回值
无
备注
无
创建零组件标注前事件
事件
void OnCreateComponentNote()
说明
创建零组件标注前事件,在执行创建零组件标注时,创建标注前触发
参数
无
返回值
无
备注
1)在执行工具栏命令"零组件标注"时响应2)接收事件后,若需后续处理,请调用接口CreateComponentNote。
创建零组件序号标注前事件
事件
void OnCreateComponentSNNote()
说明
创建零组件序号标注前事件,在执行创建零组件序号标注时,创建序号前触发
参数
无
返回值
无
备注
1)在执行工具栏命令"序号标注-零组件"时响应2)接收事件后,若需后续处理,请调用接口CreateComponentSNNote。
添加标注后缀前事件
事件
void OnAddNoteSuffix()
说明
添加标注后缀前事件,执行添加后缀时,添加标注后缀前触发
参数
无
返回值
无
备注
1)在执行工具栏命令"添加后缀"时响应2)接收事件后,若需后续处理,请调用接口AddNoteSuffix。
编辑标注后缀前事件
事件
BSTR GetPMIStateById(BSTR PMIId)
说明
编辑标注后缀前事件
参数
无
返回值
无
备注
1)在执行工具栏命令"编辑后缀"时响应2)接收事件后,若需后续处理,请调用接口EditNoteSuffix。
创建PMI完成事件
事件
SHORT OnPMICmdFinishEvent()
说明
创建PMI完成时触发
参数
无
返回值
PMI ID
备注
1)在执行PMI命令结束后响应的事件2)接收事件后,若需后续处理,请调用接口OnPMICmdFinishEvent。
选中PMI事件
事件
void OnSelectPMIEvent()
说明
选中PMI时触发
参数
无
返回值
无
备注
1)在选择PMI时响应的事件处理2)接收事件后,若需后续处理,请调用接口OnSelectPMIEvent。
删除PMI事件
事件
void OnIntegrateTagDel(BSTR bstrID,BSTR bstrName)
说明
删除PMI时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | PMI ID。 |
bstrName | 是 | PMI的值。 |
返回值
无
备注
删除PMI时响应的事件处理
编辑协同面板中的注释、批注事件
事件
void OnIntegrateTagEdit(BSTR bstrID,BSTR bstrName)
说明
编辑协同面板中的注释、批注时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | PMI ID。 |
bstrName | 是 | PMI的值。 |
返回值
无
备注
无
磁力线
创建磁力线
方法
VARIANT_BOOL CreateMegneticLine()
说明
创建磁力线,用于标注的对齐
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
删除磁力线
方法
VARIANT_BOOL DelMegneticLine(BSTR bstrID)
说明
删除磁力线
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | 磁力线ID,多个用';'间隔 |
返回值
TRUE-成功FASLE-失败
备注
无
设置当前选中磁力线的属性
方法
VARIANT_BOOL MegneticLinePropertySet()
说明
设置当前选中磁力线的属性
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
设置磁力线的显隐状态
方法
VARIANT_BOOL SetMegneticLineVisible(BSTR bstrID,VARIANT_BOOL bVisible)
说明
设置磁力线的显隐状态
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | 磁力线ID,多个用';'间隔 |
bVisible | 是 | 显示隐藏标志 |
返回值
TRUE-成功FASLE-失败
备注
无
设置磁力线磁力有效
方法
VARIANT_BOOL SetMegneticLineEffective(BSTR bstrID,VARIANT_BOOL bEffective)
说明
设置磁力线磁力有效
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | 磁力线ID,多个用';'间隔 |
bEffective | 是 | 是否有效标志 |
返回值
TRUE-成功FASLE-失败
备注
无
创建磁力线事件
事件
void OnCreateMegneticLine()
说明
创建磁力线事件
参数
无
返回值
void
备注
1)在执行工具栏命令"磁力线"时响应。2)接收事件后,若需后续处理,请调用接口CreateMegneticLine。
删除磁力线事件
事件
void OnDelMegneticLine()
说明
删除磁力线事件
参数
无
返回值
void
备注
1)删除磁力线通知事件。2)响应场景:标注面板、视口的磁力线删除操作。
3)接收事件后,若需后续处理,请调用接口DelMegneticLine。
磁力线设置通知事件
事件
void OnMegneticLinePropertySet(BSTR bstrID)
说明
进行磁力线设置通知事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | 返回值。磁力线ID |
返回值
void
备注
1)进行磁力线设置通知事件。2)响应场景:标注面板右键菜单属性设置。
3)接收事件后,若需后续处理,请调用接口MegneticLinePropertySet。
设置磁力线显示隐藏状态事件
事件
void OnSetMegneticLineVisible(BSTR bstrID,VARIANT_BOOL bVisible)
说明
设置磁力线显示隐藏状态事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | 磁力线ID,多个用';'间隔 |
bVisible | 是 | 显示隐藏标志 |
返回值
void
备注
1)在视口中右键磁力线时弹出菜单"隐藏"时响应。2)接收事件后,若需后续处理,请调用接口SetMegneticLineVisible。
批注
设置用户信息
方法
void SetUserInfo(BSTR userName,BSTR departmenterName,BSTR roleName)
说明
设置当前选中批注的用户信息
参数
参数 | 是否必须 | 说明 |
---|---|---|
userName | 是 | 用户名称 |
departmenterName | 是 | 部门名称 |
roleName | 是 | 角色名称 |
返回值
void
备注
无
获取用户信息
方法
BSTR GetUserInfo()
说明
获取当前选中批注的用户信息
参数
无
返回值
用户名;部门名称;开发
备注
无
新建批注
方法
void CreateNote()
说明
新建批注
参数
无
返回值
void
备注
无
编辑选中的批注
方法
void EditNote/EditTag()
说明
编辑选中的批注
参数
无
返回值
void
备注
无
获取选中的批注信息
方法
BSTR GetSelectedUserNotes()
说明
获取选中的批注信息
参数
无
返回值
选中的批注列表字符串。格式(ID1:批注信息1;ID2:批注信息2)。选择多个用分号隔开,如:34:2|ssswasdsdsaxc;18:2|dsafsaf
备注
无
选中批注
方法
void SelectUserNotes(BSTR userNoteIds)
说明
选中批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
userNoteIds | 是 | 批注ID,多个用';'间隔 |
返回值
void
备注
无
删除批注
方法
void DeleteNote/DeleteTag(BSTR bstrID)
说明
删除批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
bstrID | 是 | 批注ID,多个用';'间隔 |
返回值
void
备注
无
打开批注文件
方法
void OpenNoteFile(BSTR filename,BSTR showname,VARIANT_BOOL bShowMsgDlg)
说明
打开批注文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
filename | 是 | 批注文件 |
showname | 是 | 显示名称 |
bShowMsgDlg | 是 | 是否显示提示框 |
返回值
void
备注
无
保存某文件的批注
方法
void SaveNoteFile(BSTR filename,VARIANT_BOOL bShowMsgDlg)
说明
保存某文件的批注,如果文件不在打开列表中,则保存新建的不属于任何文件的批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
filename | 是 | 批注文件 |
bShowMsgDlg | 是 | 是否显示提示框 |
返回值
void
备注
无
显隐某文件的批注
方法
void ShowNoteGroup(BSTR groupname,VARIANT_BOOL bshow)
说明
显隐某文件的批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
groupname | 是 | 组的名称 |
bshow | 是 | 显示隐藏标志 |
返回值
void
备注
无
删除批注文件
方法
void RemoveNoteGroup/DeleteNoteByFile(BSTR fileName)
说明
删除指定的批注文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
fileName | 是 | 批注文件路径 |
返回值
void
备注
无
设置编辑的批注文件
方法
void SetActiveNodeGroup(BSTR fileName)
说明
设置编辑的批注文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
fileName | 是 | 批注文件路径 |
返回值
void
备注
无