Object_IsHidden

This document is no longer available beyond version 4. Information can now be found here: Object_IsHidden for version 5

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

Parent page: Schematic Query Functions - Membership Checks

Summary

Returns all child objects of pin objects whose Hide property complies with the Query.

Syntax

Object_IsHidden(Parent) : Boolean/Boolean_String

Example Usage

Object_IsHidden(Parent)
Object_IsHidden(Parent) = True
Object_IsHidden(Parent) = 'True'

Returns all child objects of pin objects whose Hide property is enabled.

Not Object_IsHidden(Parent)
Object_IsHidden(Parent) = False
Object_IsHidden(Parent) = 'False'

Returns all objects except child objects of pin objects whose Hide property is enabled.

Object_ObjectKind(Parent) = 'Pin' && Not Object_IsHidden(Parent)
Returns all child objects of pin objects except those pin objects whose Hide property is disabled.

Tips

  1. The Hide property is defined for harness connector type, parameter, pin, sheet symbol designator, and sheet symbol file name objects, but only pin objects can have children that are returnable by this expression.