Ets_Obj_UI_Status_Set()
摘要
允许客户端修改网络域中特定对象的用户界面显示状态。
语法
Ets_Obj_UI_Status_Set (ets_obj_hndl, ui_status)
| 参数 | 类型 | 说明 |
|---|---|---|
ets_obj_hndl |
EtsT_Obj_Handle |
待修改状态对象的句柄 |
ui_status |
EtsT_Obj_UI_Status |
对象的新状态,取详情中所述枚举值之一。 |
返回类型
EtsT_Compcode
若对象句柄与新状态均为有效输入值,返回 EtsC_Compcode_Success,否则返回 EtsC_Compcode_Failure。
头文件
ets_api_obj.h
详情
该函数根据输入的状态修改输入对象的 UI 状态。合适的传入对象句柄是类型为 EtsC_Obj_Mtype_Link 和 EtsC_Obj_Mtype_Site 的对象。下表列出 ui_status 参数的可能取值及其影响的 UI 特性。
| 若 ui_status 的值为…… | UI 效果为…… |
|---|---|
EtsC_Obj_UI_Status_Hide |
使对象不再可见。 |
EtsC_Obj_UI_Status_Show |
若对象处于隐藏状态,则使其可见。 |
EtsC_Obj_UI_Status_Hide_Label |
隐藏与该对象对应的文本标签。 |
EtsC_Obj_UI_Status_Show_Label |
若对象的文本标签处于隐藏状态,则使其可见。 |
EtsC_Obj_UI_Status_Top_Layer |
将对象移动到最上层绘图层。 |
EtsC_Obj_UI_Status_Bottom_Layer |
将对象移动到最下层绘图层。 |
EtsC_Obj_UI_Status_Expand |
以展开方式绘制子网(仅适用于子网对象)。 |
EtsC_Obj_UI_Status_Collapse |
以折叠方式绘制子网(仅适用于子网对象)。 |
EtsC_Obj_UI_Copy_Disabled |
表示该对象不能被复制。 |
EtsC_Obj_UI_Cut_Disabled |
表示该对象不能被剪切。 |
每当客户端需要在用户界面中修改网络对象的外观时,都应使用该函数。它可以与 Ets_Obj_UI_Status_Query() 配合使用,在修改对象之前先获取其当前的 UI 状态。