EtsT_Obj_Dbox_Hide_Attr_Handler
Abstract
Callback: Used to determine whether an attribute should be hidden.
Syntax
<object_dbox_hide_attribute_handler_name> (attr_name, object, subobject_row, parent_object)
| Argument | Type | Description |
|---|---|---|
attr_name |
const char * |
Name of attribute to be considered for hiding. |
object |
EtsT_Obj_Handle |
Object that contains the attribute. If the attribute is a sub-attribute of a compound attribute, this should be the sub-object that contains the sub-attribute. |
subobject_row |
int |
Row index of the sub-object in object (if applicable). |
parent_object |
EtsT_Obj_Handle |
Immediate parent object of object. |
Return Type
EtsT_Boolean
EtsC_True if the attribute should be hidden; EtsC_False if the attribute is visible.
Header
ets_api_obj_dbox.h
Details
Object dbox hide attribute handlers determine whether an attribute should be visible or hidden in the GUI. This lets you reduce complexity by hiding those attributes of a node that are not applicable in a certain situation. For example, the standard firewall model contains some vendor-specific attributes. Using an object dbox hide attribute handler, you can show only the Cisco attributes when the model is used on a Cisco node.
An application calls an object dbox hide attribute handler whenever it is about to display an attribute and needs to determine if that attribute should be hidden; such as:
- When the object attribute dialog box is first drawn
- When a parent compound attribute is opened or renders its summary line
- When a change in an attribute triggers a reevaluation of other attributes
An object dbox hide attribute handler is not called during the Edit Object by Template or Edit Similar Objects operations.
Callbacks of this type are registered as the Hide Handler in an attribute’s Enter ETS Handlers dialog box (see “Active Attributes“ on page 51).