System Projects Reference > Situational Awareness System Projects > Situational Awareness Include Project > NavigationLink_IsHidden

NavigationLink_IsHidden

Checks if link object should be hidden based on whether the selected equipment is a member of the control group. See Use Navigational Genies on Content Pages.

Syntax

NavigationLink_IsHidden(STRING sEquipFrom, STRING sEquipTo [, INT bIsControlLink])

sEquipFrom

The name (path) of the equipment that the control link is from. Set this to empty if have none.

sEquipTo

The name (path) of equipment that the control link links to. Set this to empty if have none.

blsControlLink

Indicates whether the link is a control link. Default value is TRUE. This is an optional parameter.

Return Value

Returns FALSE (not hidden) if the selected equipment belongs to the control group; otherwise it returns TRUE.

Example

NavigationLink_IsHidden("AlarmSite.Area2.Equipment1","AlarmSite.Area2.Equipment11",TRUE)
        

See Also

Published June 2018