Ets_Obj_UI_Status_Set()
Abstract
Allows the client to modify the user-interface display status of specific objects in the network domain.
Syntax
Ets_Obj_UI_Status_Set (ets_obj_hndl, ui_status)
| Argument | Type | Description |
|---|---|---|
ets_obj_hndl |
EtsT_Obj_Handle |
Object handle of the object whose status will be modified |
ui_status |
EtsT_Obj_UI_Status |
New status of the object, represented by one of the enumerated values described in Details. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the object handle and new status were valid input values, EtsC_Compcode_Failure otherwise.
Header
ets_api_obj.h
Details
This function modifies the UI status of the input object according to the input status. Appropriate object handles to pass in are objects of type EtsC_Obj_Mtype_Link and EtsC_Obj_Mtype_Site. The following table lists possible values for the ui_status argument and the UI feature affected.
| If the value of ui_status is… | The UI effect will be… |
|---|---|
EtsC_Obj_UI_Status_Hide |
Makes the object no longer visible. |
EtsC_Obj_UI_Status_Show |
Makes the object visible if it is hidden. |
EtsC_Obj_UI_Status_Hide_Label |
Hides the text label corresponding to the object. |
EtsC_Obj_UI_Status_Show_Label |
Makes the object’s text label visible if it is hidden. |
EtsC_Obj_UI_Status_Top_Layer |
Moves the object to the top drawing layer. |
EtsC_Obj_UI_Status_Bottom_Layer |
Moves the object to the bottom drawing layer. |
EtsC_Obj_UI_Status_Expand |
Draws the subnet expanded (subnet objects only). |
EtsC_Obj_UI_Status_Collapse |
Draws the subnet collapsed (subnet objects only). |
EtsC_Obj_UI_Copy_Disabled |
Indicates that the object cannot be copied. |
EtsC_Obj_UI_Cut_Disabled |
Indicates that the object cannot be cut. |
This function should be used whenever the client needs to modify the appearance of a network object in the user interface. It can be used in conjunction with Ets_Obj_UI_Status_Query() to obtain the current UI status of objects before modifying them.