PartDisplayMode

This document is no longer available beyond version 4. Information can now be found here: PartDisplayMode 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 - Fields

Summary

Returns all part objects whose Display Mode property complies with the Query. Each part has a standard display mode, called Normal. In additiona, a part can have up to 255 alternate display modes (Alternate 1 - Alternate 255).

Syntax

PartDisplayMode = PartDisplayMode_String
PartDisplayMode <> PartDisplayMode_String

PartDisplayMode_String specifies the part display mode, and must be one of the following strings:

  • 'Normal'
  • 'Alternate 1'
  • 'Alternate 2'
  • .
  • .
  • .
  • 'Alternate 255'

Example Usage

PartDisplayMode = 'Normal'
Returns all part objects whose Display Mode property is Normal.

PartDisplayMode <> 'Alternate 1'
Returns all objects except part objects whose Display Mode property is Alternate 1.

IsPart && PartDisplayMode <> 'Normal'
Returns all part objects except those whose Display Mode property is Normal.

Tips

  1. The single quote characters (') at the start and end of PartDisplayMode_String are mandatory.
  2. The Display Mode property is only defined for part objects.