Schematic Fields Query Language Keywords in Altium Designer

Summary

Returns all No ERC objects whose Active property complies with the Query.

Syntax

Active : Boolean_String

Example Usage

Active = 'True'
Returns all No ERC objects whose Active property is enabled.

Active = 'False'
Returns all No ERC objects whose Active property is disabled.

Note

The Active property is only defined for No ERC objects.

Summary

Returns all note, port and text frame objects whose Alignment property complies with the Query.

Syntax

Alignment = Alignment_String
Alignment <> Alignment_String

Alignment_String specifies the type of alignment and must be one of the following strings:

• 'Center'
• 'Left'
• 'Right'

Example Usage

Alignment = 'Center'
Returns all note, port and text frame objects whose Alignment property is Center.

Alignment <> 'Right'
Returns all objects except note, port and text frame objects whose Alignment property is Right.

Notes

• The single quote characters (') at the start and end of Alignment_String are mandatory.
• The Alignment property is only defined for note, port and text frame objects.

Summary

Returns all sheet entry objects whose Arrow Kind property complies with the Query.

Syntax

ArrowKind = ArrowKind_String
ArrowKind <> ArrowKind_String

ArrowKind_String specifies the arrow kind and must be one of the following strings:

• 'Arrow'
• 'Arrow Tail'
• 'Block & Triangle'
• 'Triangle'

Example Usage

ArrowKind = 'Block & Triangle'
Returns all sheet entry objects whose Arrow Kind property is Block & Triangle.

ArrowKind <> 'Triangle'
Returns all objects except sheet entry objects whose Arrow Kind property is Triangle.

Notes

• The single quote characters (') at the start and end of ArrowKind_String are mandatory.
• The Arrow Kind property is only defined for sheet entry objects.

Summary

Returns all note objects whose Author property complies with the Query.

Syntax

Author : String

Example Usage

Author = 'Neal Geneare'
Returns all note objects whose Author property is Neal Geneare.

Author Like 'Ge*'
Returns all note objects whose Author property starts with Ge.

Author <> 'Robert'
Returns all objects except note objects whose Author property is Robert.

Author <> '' && Author <> 'Des Igner'
Author > '' && Author <> 'Des Igner'
IsNote && Author <> 'Des Igner'
Returns all note objects except those whose Author property is Des Igner.

Notes

The Author property is only defined for note objects.

Summary

Returns all port objects whose AutoSize property complies with the Query.

Syntax

AutoSize : Boolean_String

Example Usage

AutoSize = 'True'
Returns all port objects whose AutoSize property is enabled.

AutoSize = 'False'
Returns all port objects whose AutoSize property is disabled.

Notes

The AutoSize property is only defined for port objects.

Summary

Returns all blanket, harness connector, image, port, rectangle, round rectangle, sheet symbol, and text frame objects whose Border Width property complies with the Query.

Syntax

BorderWidth = BorderWidth_String
BorderWidth <> BorderWidth_String

BorderWidth_String specifies the border width style and must be one of the following strings:

• 'Large'
• 'Medium'
• 'Small'
• 'Smallest'

Example Usage

BorderWidth = 'Small'
Returns all blanket, harness connector, image, port, rectangle, round rectangle, sheet symbol, and text frame objects whose Border Width property is Small.

BorderWidth <> 'Medium'
Returns all objects except blanket, harness connector, image, port, rectangle, round rectangle, sheet symbol, and text frame objects whose Border Width property is Medium.

Notes

• The single quote characters (') at the start and end of BorderWidth_String are mandatory.
• The Border Width property is only defined for blanket, harness connector, image, port, rectangle, round rectangle, sheet symbol, and text frame objects.

Summary

Returns all blanket, compile mask, and note objects whose Collapsed and Disabled property complies with the Query.

Syntax

Collapsed : Boolean_String

Example Usage

Collapsed = 'True'
Returns all blanket, compile mask, and note objects whose Collapsed and Disabled property is enabled.

Collapsed = 'False'
Returns all blanket, compile mask, and note objects whose Collapsed and Disabled property is disabled.

Notes

The Collapsed and Disabled property is only defined for blanket, compile mask, and note objects.

Summary

Returns all objects whose Color property complies with the Query.

Syntax

Color : Numeric_String
Color : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the Color keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Color Div 65536
• Green = Color Div 256 Mod 256
• Red = Color Mod 256

Example Usage

Color = '0'
Color <> '' && Color = 0
Returns all objects whose Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

Color = '16711680'
Color > '' && Color = 16711680
Returns all objects whose Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

Color <> '16777215'
Returns all objects except those whose Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

ObjectKind <> 'Part' && Color <> 16777215
Returns all objects – except parts – whose Color property is 16777215.

Not IsPart && Color Div 65536 >= 96 && Color Div 256 Mod 256 Between 64 And 192 && Color Mod 256 <= 128
Returns all objects – except parts – whose Color property is such that the Blue component has a value which is greater than or equal to 96, the Green component has a value which is greater than or equal to 64 and less than or equal to 192, and the Red component has a value which is less than or equal to 128.

IsArc Or IsBezier && Color Mod 256 Between 64 And 192
Returns all arc and Bezier objects whose Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

Summary

Returns all part objects whose Component Type property complies with the Query.

Syntax

ComponentType = ComponentType_String

ComponentType <> ComponentType_String

ComponentType_String must be one of the strings from the following list:

• 'Graphical'
• 'Jumper'
• 'Mechanical'
• 'Net Tie'
• 'Net Tie (In BOM)'
• 'Standard'
• 'Standard (No BOM)'

Example Usage

ComponentType = 'Graphical'
Returns all parts whose Component Type is Graphical.

ComponentType <> 'Standard'
Returns all objects except parts whose Component Type is Standard.

Notes

• The Component Type property is only defined for part objects.
• The single quote characters (') at the start and end of ComponentType_String are mandatory.

Summary

Returns all blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose X2 property complies with the Query.

Syntax

CornerLocationX : Numeric_String
CornerLocationX : Number

Example Usage

CornerLocationX = '1400'
Returns all blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose X2 property is 1400.

CornerLocationX Between '150' And '430'
Returns all blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose X2 property is greater than, or equal to, 150, and less than, or equal to, 430.

IsRectangle Or IsRoundRectangle && CornerLocationX >= 250
Returns all rectangle and round rectangle objects whose X2 property is greater than, or equal to, 250.

IsSheetSymbol && CornerLocationX < 350
Returns all sheet symbol (sheet symbol, device sheet symbol, managed sheet instance symbol) objects whose X2 property is less than 350.

CornerLocationX <> '210'
Returns all objects except blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose X2 property is 210.

Notes

The X2 property is only defined for blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects.

Summary

Returns all blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose Y2 property complies with the Query.

Syntax

CornerLocationY : Numeric_String
CornerLocationY : Number

Example Usage

CornerLocationY = '1400'
Returns all blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose Y2 property is 1400.

CornerLocationY Between '150' And '430'
Returns all blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose Y2 property is greater than, or equal to, 150, and less than, or equal to, 430.

IsRectangle Or IsRoundRectangle && CornerLocationY >= 250
Returns all rectangle and round rectangle objects whose Y2 property is greater than, or equal to, 250.

IsSheetSymbol && CornerLocationY < 350
Returns all sheet symbol (sheet symbol, device sheet symbol, managed sheet instance symbol) objects whose Y2 property is less than 350.

CornerLocationY <> '210'
Returns all objects except blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects whose Y2 property is 210.

Notes

The Y2 property is only defined for blanket, bus entry, compile mask, harness connector, image, note, rectangle, round rectangle, sheet symbol and text frame objects.

Summary

Returns all part objects whose Current Footprint property complies with the Query.

Syntax

CurrentFootprint : String

Example Usage

CurrentFootprint = 'DIP14'
Returns all part objects whose Current Footprint property is DIP14.

CurrentFootprint Like 'SIP?*'
Returns all part objects that have a Current Footprint property whose associated string starts with SIP, and which contains at least one more following character.

Notes

The Current Footprint property is only defined for part objects.

Summary

Returns all part objects whose Current Footprint property complies with the Query.

Syntax

CurrentFootprint : String

Example Usage

CurrentFootprint = 'DIP14'
Returns all part objects whose Current Footprint property is DIP14.

CurrentFootprint Like 'SIP?*'
Returns all part objects that have a Current Footprint property whose associated string starts with SIP, and which contains at least one more following character.

Notes

The Current Footprint property is only defined for part objects.

Summary

Returns all part objects whose Database Table Name property complies with the Query.

Syntax

DatabaseTableName : String

Example Usage

DatabaseTableName = 'Tantalum_Capacitors'
Returns all part objects whose Database Table Name property is Tantalum_Capacitors.

DatabaseTableName Like '*Res*'
Returns all part objects whose Database Table Name property includes Res.

Notes

The Database Table Name property is only defined for part objects.

Summary

Returns all part and pin objects whose Description property complies with the Query.

Syntax

Description : String

Example Usage

Description = 'TTL-RS232 DRIVER'
Returns all part and pin objects whose Description property is TTL-RS232 DRIVER.

Description Like '*RS485*'
Returns all part and pin objects whose Description property includes RS485.

Notes

The Description property is only defined for part and pin objects.

Summary

Returns all part objects whose Lock Designator property complies with the Query.

Syntax

DesignatorLocked : Boolean_String

Example Usage

DesignatorLocked = 'True'
Returns all part objects whose Lock Designator property is enabled.

DesignatorLocked = 'False'
Returns all part objects whose Lock Designator property is disabled.

Notes

The Lock Designator property is only defined for part objects.

Summary

Returns all part objects whose Design Item ID property complies with the Query.

Syntax

DesignItemID : String

Example Usage

DesignItemID = 'LM833'
Returns all part objects whose Design Item ID is LM833.

Notes

The Design Item ID property is only defined for part objects.

Summary

Returns all arc objects whose Stop Angle property complies with the Query.

Syntax

EndAngle : Numeric_String
EndAngle : Number

Example Usage

EndAngle = '320'
Returns all arc objects whose Stop Angle property is 320.

EndAngle Between '150' And '230'
Returns all arc objects whose Stop Angle property is greater than or equal to 150, and less than or equal to 230.

IsArc && EndAngle >= 250
Returns all arc objects whose Stop Angle property is greater than or equal to 250.

EndAngle <> '210'
Returns all objects except arc objects whose Stop Angle property is 210.

Notes

The Stop Angle property is only defined for arc objects.

Summary

Returns all polyline objects whose End Line Shape property complies with the Query.

Syntax

EndLineShape = EndLineShape_String
EndLineShape <> EndLineShape_String

EndLineShape_String specifies the shape at the end of the line and must be one of the following strings:

• 'Arrow'
• 'Circle'
• 'None'
• 'SolidArrow'
• 'SolidTail'
• 'Square'
• 'Tail'

Example Usage

EndLineShape = 'Arrow'
Returns all polyline objects whose End Line Shape property is Arrow.

EndLineShape <> 'SolidArrow'
Returns all objects except polyline objects whose End Line Shape property is SolidArrow.

Notes

• The single quote characters (') at the start and end of EndLineShape_String are mandatory.
• The End Line Shape property is only defined for polyline objects.

Summary

Returns all image and sheet symbol file name objects whose File Name property complies with the Query.

Syntax

FileName : String

Example Usage

FileName = 'C:\Templates\newAltmlogo.bmp'
Returns all image and sheet symbol file name objects whose File Name property is C:\Templates\newAltmlogo.bmp.

Notes

The File Name property is only defined for image and sheet symbol file name objects.

Summary

Returns all blanket, compile mask, ellipse, harness connector, note, polygon, port, rectangle, round rectangle, sheet entry, sheet symbol, and text frame objects whose Fill Color property complies with the Query.

Syntax

FillColor : Numeric_String
FillColor : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the FillColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Fill Color property's Blue, Green, and Red components by using the following constructs:

• Blue = Fill Color Div 65536
• Green = Fill Color Div 256 Mod 256
• Red = Fill Color Mod 256

Example Usage

FillColor = '0'
FillColor <> '' && FillColor = 0
Returns all blanket, compile mask, ellipse, harness connector, note, polygon, port, rectangle, round rectangle, sheet entry, sheet symbol, and text frame objects whose Fill Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

FillColor = '16711680'
FillColor > '' && FillColor = 16711680
Returns all blanket, compile mask, ellipse, harness connector, note, polygon, port, rectangle, round rectangle, sheet entry, sheet symbol, and text frame objects whose Fill Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

FillColor <> '16777215'
Returns all blanket, compile mask, ellipse, harness connector, note, polygon, port, rectangle, round rectangle, sheet entry, sheet symbol, and text frame objects except those whose Fill Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

IsBlanket Or IsCompileMask && FillColor Mod 256 Between 64 And 192
Returns all blanket and compile mask objects whose Fill Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

Notes

The Fill Color property is only defined for blanket, compile mask, ellipse, harness connector, note, polygon, port, rectangle, round rectangle, sheet entry, sheet symbol, and text frame objects.

Summary

Returns all harness connector type, harness entry, net label, note, parameter, port, power port, sheet entry, text frame, and text string objects whose Font property complies with the Query.

Syntax

Font : String

Example Usage

Font = 'Trebuchet MS, 10'
Returns all harness connector type, harness entry, net label, note, parameter, port, power port, sheet entry, text frame, and text string objects whose Font property is Trebuchet MS, 10.

Font Like 'Treb*'
Returns all harness connector type, harness entry, net label, note, parameter, port, power port, sheet entry, text frame, and text string objects whose Font property begins with Treb.

Notes

The Font property is only defined for harness connector type, harness entry, net label, note, parameter, port, power port, sheet entry, text frame, and text string objects.

Summary

Returns all harness connector objects whose Harness Connector Side property complies with the Query.

Syntax

HarnessConnectorSide = HarnessConnectorSide_String
HarnessConnectorSide <> HarnessConnectorSide_String

HarnessConnectorSide_String specifies on which side of the object the connector appears, and must be one of the following strings:

• 'Bottom'
• 'Left'
• 'Right'
• 'Top'

Example Usage

HarnessConnectorSide = 'Right'
Returns all harness connector objects whose Harness Connector Side property is Right.

HarnessConnectorSide <> 'Left'
Returns all objects except harness connector objects whose Harness Connector Side property is Left.

Notes

• The single quote characters (') at the start and end of HarnessConnectorSide_String are mandatory.
• The Harness Connector Side property is only defined for harness connector objects.

Summary

Returns all harness connector, port, and sheet entry objects whose Harness Type property complies with the Query.

Syntax

HarnessType : String

Example Usage

HarnessType = 'JTAG'
Returns all harness connector, port, and sheet entry objects whose Harness Type property is JTAG.

HarnessType Like '*SPI*'
Returns all harness connector, port, and sheet entry objects whose Harness Type property includes SPI.

Notes

The Harness Type property is only defined for harness connector, port, and sheet entry objects.

Summary

Returns all objects which caused at least one violation to be reported during compilation.

Syntax

HasError : Boolean

Example Usage

HasError
HasError = True
Returns all objects which caused at least one violation to be reported during compilation.

Not HasError
HasError = False
Returns all objects which caused no violations to be reported during compilation.

Summary

Returns all port objects whose Height property complies with the Query.

Syntax

Height : Numeric_String
Height : Number

Example Usage

Height = '100'
Returns all port objects whose Height property is 100.

Height Between '60' And '130'
Returns all port objects whose Height property is greater than, or equal to, 60, and less than, or equal to, 130.

IsPort && Height >= 60
Returns all port objects whose Height property is greater than, or equal to, 60.

Height <> '70'
Returns all objects except port objects whose Height property is 70.

Notes

The Height property is only defined for port objects.

Summary

Returns all harness connector objects whose Hide Harness Type property complies with the Query.

Syntax

HideHarnessType : Boolean/Boolean_String

Example Usage

HideHarnessType = 'True'
Returns all harness connector objects whose Hide Harness Type property is enabled.

HideHarnessType = 'False'
Returns all harness connector objects whose Hide Harness Type property is disabled.

Notes

The Hide Harness Type property is only defined for harness connector objects.

Summary

Returns all designator, parameter, sheet file name, sheet name, and text string objects whose Horizontal Justification property complies with the Query.

Syntax

HorizontalJustification = HorizontalJustification_String
HorizontalJustification <> HorizontalJustification_String

HorizontalJustification_String specifies the text justification and must be one of the following strings:

• 'Center'
• 'Left'
• 'Right'

Example Usage

HorizontalJustification = 'Left'
Returns all designator, parameter, sheet file name, sheet name, and text string objects whose Horizontal Justification property is Left.

HorizontalJustification <> 'Center'
Returns all objects except designator, parameter, sheet file name, sheet name, and text string objects whose Horizontal Justification property is Center.

Notes

• The single quote characters (') at the start and end of HorizontalJustification_String are mandatory.
• The Horizontal Justification property is only defined for designator, parameter, sheet file name, sheet name, and text string objects.

Summary

Returns all IEEE Symbol objects whose Symbol property complies with the Query.

Syntax

IeeeSymbol = IeeeSymbol_String
IeeeSymbol <> IeeeSymbol_String

IeeeSymbol_String must be one of the following strings:

• 'Active Low Input'
• 'Active Low Output'
• 'Analog Signal In'
• 'And'
• 'Bidirectional Signal Flow'
• 'Clock'
• 'Delay'
• 'Digital Signal In'
• 'Dot'
• 'GreaterThan/Equal'
• 'Group Bin'
• 'Group Line'
• 'High Current'
• 'Hiz'
• 'Input/Output'
• 'Invertor'
• 'Left Right Signal Flow'
• 'Less Than/Equal'
• 'No Symbol'
• 'Not Logic Connection'
• 'Open Collector'
• 'Open Collector Pull Up'
• 'Open Emitter'
• 'Open Emitter Pull Up'
• 'Open Output'
• 'Or'
• 'PiSymbol'
• 'Postponed Output'
• 'Pulse'
• 'Right Left Signal Flow'
• 'Schmitt'
• 'Shift Left'
• 'Shift Right'
• 'Sigma'
• 'Xor'

Example Usage

IeeeSymbol = 'Left'
Returns all IEEE Symbol objects whose Symbol property is Left.

IeeeSymbol <> 'Center'
Returns all objects except IEEE Symbol objects whose Symbol property is Center.

IsSymbol && IeeeSymbol <> 'Open Output'
Returns all IEEE Symbol objects except those whose Symbol property is Open Output.

Notes

• The single quote characters (') at the start and end of IeeeSymbol_String are mandatory.
• The Symbol property is only defined for IEEE Symbol objects.

Summary

Returns all image objects whose Embedded property complies with the Query.

Syntax

ImageEmbedded : Boolean_String

Example Usage

ImageEmbedded = 'True'
Returns all image objects whose Embedded property is enabled.

ImageEmbedded = 'False'
Returns all image objects whose Embedded property is disabled.

Notes

The Embedded property is only defined for image objects.

Summary

Returns all image objects whose XY Ratio 1:1 property complies with the Query.

Syntax

ImageKeepAspect : Boolean_String

Example Usage

ImageKeepAspect = 'True'
Returns all image objects whose XY Ratio 1:1 property is enabled.

ImageKeepAspect = 'False'
Returns all image objects whose XY Ratio 1:1 property is disabled.

Notes

The XY Ratio 1:1 property is only defined for image objects.

Summary

Returns all harness connector type, parameter, pin, sheet symbol designator, and sheet symbol file name objects whose Hide property complies with the Query.

Syntax

IsHidden : Boolean/Boolean_String

Example Usage

IsHidden
IsHidden = True
IsHidden = 'True'
Returns all harness connector type, parameter, pin, sheet symbol designator, and sheet symbol file name objects whose Hide property is enabled.

Not IsHidden
IsHidden = False
IsHidden = 'False'
Returns all objects except harness connector type, parameter, pin, sheet symbol designator, and sheet symbol file name objects whose Hide property is enabled.

Notes

The Hide property is only defined for harness connector type, parameter, pin, sheet symbol designator, and sheet symbol file name objects.

Summary

Returns all IEEE symbol, part, and text string objects whose Mirrored property complies with the Query.

Syntax

IsMirrored : Boolean_String

Example Usage

IsMirrored = 'True'
Returns all IEEE symbol, part, and text string objects whose Mirrored property is enabled.

IsMirrored = 'False'
Returns all IEEE symbol, part, and text string objects whose Mirrored property is disabled.

Notes

The Mirrored property is only defined for IEEE symbol, part, and text string objects.

Summary

Returns all part and sheet symbol (managed sheet instance) objects whose Item property complies with the Query. This is a Component Item, or Schematic Sheet Item (Managed Sheet), that has been sourced and placed from a server.

Syntax

Item : String

Example Usage

Item = 'CMP-1034-02113'
Returns all part and sheet symbol (managed sheet instance) objects whose Item property is CMP-1034-02113.

Item Like '*0603*'
Returns all part and sheet symbol (managed sheet instance) objects whose Item property includes 0603.

Notes

The Item property is only defined for part and sheet symbol (managed sheet instance) objects.

Summary

Returns all manual junction objects whose Size property complies with the Query.

Syntax

JunctionSize = JunctionSize_String
JunctionSize <> JunctionSize_String

JunctionSize_String specifies the junction size and must be one of the following strings:

• 'Large'
• 'Medium'
• 'Small'
• 'Smallest'

Example Usage

JunctionSize = 'Small'
Returns all manual junction objects whose Size property is Small.

JunctionSize <> 'Medium'
Returns all objects except manual junction objects whose Size property is Medium.

IsJunction && JunctionSize <> 'Smallest'
Returns all Junction objects except those whose Size property is Smallest.

Notes

• The single quote characters (') at the start and end of JunctionSize_String are mandatory.
• The Size property is only defined for manual junction objects.

Summary

Returns all polyline objects whose Line Shape Size property complies with the Query.

Syntax

LineShapeSize = LineShapeSize_String
LineShapeSize <> LineShapeSize_String

LineShapeSize_String specifies the line shape size, and must be one of the following strings:

• 'Large'
• 'Medium'
• 'Small'
• 'Smallest'

Example Usage

LineShapeSize = 'Small'
Returns all polyline objects whose Line Shape Size property is Small.

LineShapeSize <> 'Medium'
Returns all objects except polyline objects whose Line Shape Size property is Medium.

IsPolyline && LineShapeSize <> 'Smallest'
Returns all polyline objects except those whose Line Shape Size property is Smallest.

Notes

• The single quote characters (') at the start and end of LineShapeSize_String are mandatory.
• The Line Shape Size property is only defined for polyline objects.

Summary

Returns all arc, bezier, bus, bus entry, ellipse, polygon, polyline, and wire objects whose Line Width property complies with the Query.

Syntax

LineWidth = LineWidth_String
LineWidth <> LineWidth_String

LineWidth_String specifies the line width, and must be one of the following strings:

• 'Large'
• 'Medium'
• 'Small'
• 'Smallest'

Example Usage

LineWidth = 'Small'
Returns all arc, bezier, bus, bus entry, ellipse, polygon, polyline and wire objects whose Line Width property is Small.

LineWidth <> 'Medium'
Returns all objects except arc, bezier, bus, bus entry, ellipse, polygon, polyline and wire objects whose Line Width property is Medium.

IsPolyline && LineWidth <> 'Smallest'
Returns all polyline objects except those whose Line Width property is Smallest.

Notes

• The single quote characters (') at the start and end of LineWidth_String are mandatory.
• The Line Width property is only defined for arc, bezier, bus, bus entry, ellipse, polygon, polyline, and wire objects.

Summary

Returns all objects whose X1 property complies with the Query.

Syntax

LocationX : Numeric_String

Example Usage

LocationX = '320'
Returns all objects whose X1 property is equal to 320.

LocationX Between '150' And '430'
Returns all objects whose X1 property is greater than or equal to 150 and less than or equal to 430.

LocationX >= '250'
Returns all objects whose X1 property is greater than or equal to 250.

LocationX < 350
Returns all objects whose X1 property is less than 350.

LocationX <> '210'
Returns all objects whose X1 property is not equal to 210.

Summary

Returns all objects whose Y1 property complies with the Query.

Syntax

LocationY : Numeric_String

Example Usage

LocationY = '320'
Returns all objects whose Y1 property is equal to 320.

LocationY Between '150' And '430'
Returns all objects whose Y1 property is greater than or equal to 150 and less than or equal to 430.

LocationY >= '250'
Returns all objects whose Y1 property is greater than or equal to 250.

LocationY < 350
Returns all objects whose Y1 property is less than 350.

LocationY<> '210'
Returns all objects whose Y1 property is not equal to 210.

Summary

Returns all objects whose Locked property complies with the Query.

Syntax

Locked : Boolean/Boolean_String

Example Usage

Locked
Locked = True
Locked = 'True'
Returns all objects whose Locked property is enabled.

Not Locked
Locked = False
Locked = 'False'
Returns all objects whose Locked property is disabled.

Summary

Returns all note and text frame objects whose Long Text property complies with the Query.

Syntax

LongStringText : String

Example Usage

LongStringText = 'Warning: No NiCAD Batteries here!'
Returns all note and text frame objects whose Long Text property is Warning: No NiCAD Batteries here!.

LongStringText Like '*Res*'
Returns all note and text frame objects whose Long Text property includes Res.

IsNote && LongStringText Like 'Warning:*'
Returns all note objects whose Long Text property starts with Warning:.

Notes

The Long Text property is only defined for note and text frame objects.

Summary

Returns all harness entry, parameter set, pin, port, probe, and sheet entry objects whose Name property complies with the Query.

Syntax

Name : String

Example Usage

Name = 'W\R\'
Returns all harness entry, parameter set, pin, port, probe, and sheet entry objects whose Name property is W\R\.

Name Like 'INT?'
Returns all harness entry, parameter set, pin, port, probe, and sheet entry objects that have a Name property whose associated string commences with INT and which contains one more following character.

Notes

The Name property is only defined for harness entry, parameter set, pin, port, probe, and sheet entry objects.

Summary

Returns all No ERC objects whose No ERC Symbol property complies with the Query.

Syntax

NoERCSymbol = NoERCSymbol_String
NoERCSymbol <> NoERCSymbol_String

NoERCSymbol_String must be one of the following strings:

• 'Checkbox'
• 'Small Cross'
• 'Thick Cross'
• 'Thin Cross'
• 'Triangle'

Example Usage

NoERCSymbol = 'Thin Cross'
Returns all No ERC objects whose No ERC Symbol property is Thin Cross.

NoERCSymbol <> 'Triangle'
Returns all objects except No ERC objects whose No ERC Symbol property is Triangle.

IsNoERC && NoERCSymbol <> 'Checkbox'
Returns all No ERC objects except those whose No ERC Symbol property is Checkbox.

Notes

• The single quote characters (') at the start and end of NoERCSymbol_String are mandatory.
• The No ERC Symbol property is only defined for No ERC objects.

Summary

Returns all objects whose Object Kind property complies with the Query.

Syntax

ObjectKind = ObjectKind_String
ObjectKind <> ObjectKind_String

ObjectKind_String specifies the object kind and must be one of the following strings:

Electrical Objects – 'Blanket', 'Bus' , 'Bus Entry', 'Compile Mask', 'Harness Connector', 'Harness Entry', 'Net Label', 'No ERC', 'Off Sheet Connector', 'Parameter Set', 'Part', 'Pin', 'Port', 'Power Object', 'Probe', 'Sheet Entry', 'Sheet Symbol', 'Signal Harness', 'Wire'.

Non-Electrical Objects – 'Arc', 'Bezier', 'Designator', 'Ellipse', 'Harness Connector Type', 'IEEE Symbol', 'Image', 'Line', 'Note', 'Parameter', 'Polygon', 'Rectangle', 'Round Rectangle', 'Sheet File Name', 'Sheet Name', 'Text Frame', 'Text String'.

Example Usage

ObjectKind = 'Bus'
Returns all bus objects.

ObjectKind <> 'Pie'
Returns all objects except for pie charts.

ObjectKind = 'Line'
Returns all line objects.

Notes

The single quote characters (') at the start and end of ObjectKind_String are mandatory.

Summary

Returns all off sheet connector objects whose Off Sheet Style property complies with the Query.

Syntax

OffSheetStyle = OffSheetStyle_String
OffSheetStyle <> OffSheetStyle_String

OffSheetStyle_String must be one of the following strings:

• 'Left'
• 'Right'

Example Usage

OffSheetStyle = 'Left'
Returns all off sheet connector objects whose Off Sheet Style property is Left.

OffSheetStyle <> 'Left'
Returns all objects except off sheet connector objects whose Off Sheet Style property is Left.

IsOffSheetConnector && OffSheetStyle <> 'Right'
Returns all off sheet connector objects except those whose Off Sheet Style property is Right.

Notes

• The single quote characters (') at the start and end of OffSheetStyle_String are mandatory.
• The Off Sheet Style property is only defined for off sheet connector objects.

Summary

Returns all designator, harness connector type, IEEE symbol, net label, off sheet connector, parameter, parameter set, part, pin, power port, probe, sheet symbol designator, sheet symbol file name, and text string objects whose Orientation property complies with the Query.

Syntax

Orientation = Orientation_String
Orientation <> Orientation_String

Orientation_String must be one of the strings from the following list:

• '0 Degrees'
• '90 Degrees'
• '180 Degrees'
• '270 Degrees'

Example Usage

Orientation = '90 Degrees'
Returns all designator, harness connector type, IEEE symbol, net label, off sheet connector, parameter, parameter set, part, pin, power port, probe, sheet symbol designator, sheet symbol file name, and text string objects whose Orientation property is 90 Degrees.

Orientation <> '180 Degrees'
Returns all objects except designator, harness connector type, IEEE symbol, net label, off sheet connector, parameter, parameter set, part, pin, power port, probe, sheet symbol designator, sheet symbol file name, and text string objects whose Orientation property is 180 Degrees.

Orientation <> '' && Orientation <> '180 Degrees'
Orientation > '' && Orientation <> '180 Degrees'
Returns all designator, harness connector type, IEEE symbol, net label, off sheet connector, parameter, parameter set, part, pin, power port, probe, sheet symbol designator, sheet symbol file name, and text string objects whose Orientation property is not 180 Degrees.

Notes

• The Orientation property is only defined for designator, harness connector type, IEEE symbol, net label, off sheet connector, parameter, parameter set, part, pin, power port, probe, sheet symbol designator, sheet symbol file name, and text string objects.
• The single quote characters (') at the start and end of Orientation_String are mandatory.

Summary

Returns all objects whose Owner Document property complies with the Query.

Syntax

OwnerDocument : String

Example Usage

OwnerDocument = 'Example_Schematic.SchDoc'
Returns all objects whose Owner Document property is Example_Schematic.SchDoc.

OwnerDocument Like '*con*'
Returns all objects whose Owner Document property includes con.

Notes

The Owner Document property is defined for all objects.

Summary

Returns all designator, parameter, pin, sheet entry, sheet symbol designator, and sheet symbol file name objects whose Owner property complies with the Query.

Syntax

OwnerName : String

Example Usage

OwnerName = 'U3'
Returns all designator, parameter, pin, sheet entry, sheet symbol designator, and sheet symbol file name objects whose Owner property is U3.

OwnerName Like 'U?*'
Returns all designator, parameter, pin, sheet entry, sheet symbol designator, and sheet symbol file name objects that have an Owner property whose associated string starts with U, and which also contains at least one more following character.

Notes

The Owner property is only defined for designator, parameter, pin, sheet entry, sheet symbol designator, and sheet symbol file name objects.

Summary

Returns all parameter objects whose Allow Database Synchronize property complies with the Query.

Syntax

ParameterAllowDatabaseSynchronize : Boolean_String

Example Usage

ParameterAllowDatabaseSynchronize = 'True'
Returns all parameter objects whose Allow Database Synchronize property is enabled.

ParameterAllowDatabaseSynchronize = 'False'
Returns all parameter objects whose Allow Database Synchronize property is disabled.

Notes

The Allow Database Synchronize property is only defined for parameter objects.

Summary

Returns all parameter objects whose Allow Library Synchronize property complies with the Query.

Syntax

ParameterAllowLibrarySynchronize : Boolean_String

Example Usage

ParameterAllowLibrarySynchronize = 'True'
Returns all parameter objects whose Allow Library Synchronize property is enabled.

ParameterAllowLibrarySynchronize = 'False'
Returns all parameter objects whose Allow Library Synchronize property is disabled.

Notes

The Allow Library Synchronize property is only defined for parameter objects.

Summary

Returns all parameter objects whose Autoposition property complies with the Query.

Syntax

ParameterAutoposition : Boolean_String

Example Usage

ParameterAutoposition = 'True'
Returns all parameter objects whose Autoposition property is enabled.

ParameterAutoposition = 'False'
Returns all parameter objects whose Autoposition property is disabled.

Notes

The Autoposition property is only defined for parameter objects.

Summary

Returns all parameter objects whose Parameter Name property complies with the Query.

Syntax

ParameterName : String

Example Usage

ParameterName = 'Comment'
Returns all parameter objects whose Parameter Name property is Comment.

ParameterName = 'Published'
Returns all parameter objects whose Parameter Name property is Published.

Summary

Returns all parameter set objects whose Parameter Set Style property complies with the Query.

Syntax

ParameterSetStyle = ParameterSetStyle_String
ParameterSetStyle <> ParameterSetStyle_String

ParameterSetStyle_String must be one of the following strings:

• 'Large'
• 'Tiny'

Example Usage

ParameterSetStyle = 'Large'
Returns all parameter set objects whose Parameter Set Style property is Large.

ParameterSetStyle <> 'Tiny'
Returns all objects except parameter set objects whose Parameter Set Style property is Tiny.

IsParameterSet && ParameterSetStyle <> 'Large'
Returns all parameter set objects except those whose Parameter Set Style property is Large.

Notes

• The single quote characters (') at the start and end of ParameterSetStyle_String are mandatory.
• The Parameter Set Style property is only defined for parameter set objects.

Summary

Returns all parameter set, pin, port, probe, and sheet symbol objects whose Parameters property complies with the Query.

Syntax

ParametersList : String

Example Usage

ParametersList = 'Manufacturer=Fox, Supplier=Digikey'
Returns all parameter set, pin, port, probe, and sheet symbol objects whose Parameters property is Manufacturer=Fox, Supplier=Digikey.

ParametersList Like '*Res*'
Returns all parameter set, pin, port, probe, and sheet symbol objects whose Parameters property includes Res.

Notes

The Parameters property is only defined for parameter set, pin, port, probe, and sheet symbol objects.

Summary

Returns all parameter objects whose Type property complies with the Query.

Syntax

ParameterType = ParameterType_String
ParameterType <> ParameterType_String

ParameterType_String must be one of the following strings:

• 'BOOLEAN'
• 'FLOAT'
• 'INTEGER'
• 'STRING'

Example Usage

ParameterType = 'STRING'
Returns all parameter objects whose Type property is STRING.

ParameterType <> 'INTEGER'
Returns all objects except parameter objects whose Type property is INTEGER.

IsParameter && ParameterType <> 'FLOAT'
Returns all parameter objects except those whose Type property is FLOAT.

Notes

• The single quote characters (') at the start and end of ParameterType_String are mandatory.
• The Type property is only defined for parameter objects.

Summary

Returns all parameter objects whose Value property complies with the Query.

Syntax

ParameterValue : String

Example Usage

ParameterValue = '100nF'
Returns all parameter objects whose Value property is 100nF.

ParameterValue Like '*nF'
Returns all parameter objects whose Value property ends with nF.

Notes

• The Value property is only defined for parameter objects.

Summary

This keyword is used in conjunction with the majority of the Membership Check keywords; it then signifies that each object which is returned by the associated Query is returned because of a property that is held by its parent object.

Syntax

This depends upon the Membership Check keyword that the Parent keyword is used in conjunction with, but it is always the first (and often the only) parameter to be specified for the Membership Check keyword concerned.

Example Usage

Object_ObjectKind(Parent) = 'Part' && Object_PartId(Parent) = ''
Returns all child objects of all single-part Part objects (all such part objects have a Current Part property of '').

Object_HasModel(Parent,'PCBLIB','DIP14',False) && Object_HasPin(Parent,'14','VCC')
Returns all child objects of all part objects that are linked to a Footprint Model which has a Name property of DIP14, when the part object also contains a pin object which has a Pin Designator property of 14 and a Name property of VCC.

Summary

Returns all part objects whose Part Comment property complies with the Query.

Syntax

PartComment : String

Example Usage

PartComment = '1488'
Returns all part objects whose Part Comment property is 1488.

Notes

The Part Comment property is only defined for part objects.

Summary

Returns all part objects whose Component Designator property complies with the Query.

Syntax

PartDesignator : String

Example Usage

PartDesignator = 'U4'
Returns all part objects whose Component Designator property is U4.

Notes

The Component Designator property is only defined for part objects.

Summary

Returns all part objects whose Display Mode property complies with the Query. Each part has a standard display mode, called Normal. In addition, 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.

Notes

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

Summary

Returns all part objects whose Current Part property complies with the Query.

Syntax

PartId : String

Example Usage

PartId = 'B'
Returns all part objects whose Current Part property is B.

IsPart && PartId <> 'A'
Returns all part objects except those whose Current Part property is A.

Notes

The Current Part property is only defined for part objects.

Summary

Returns all part objects whose Lock Part ID property complies with the Query.

Syntax

PartIDLocked : Boolean_String

Example Usage

PartIDLocked = 'True'
Returns all part objects whose Lock Part ID property is enabled.

PartIDLocked = 'False'
Returns all part objects whose Lock Part ID property is disabled.

Notes

The Lock Part ID property is only defined for part objects.

Summary

Returns all part objects whose Library property complies with the Query.

Syntax

PartLibrary : String

Example Usage

PartLibrary = 'Miscellaneous Devices.IntLib'
Returns all part objects whose Library property is Miscellaneous Devices.IntLib.

PartLibrary Like 'Miscellaneous*.IntLib'
Returns all part objects that have a Library property whose associated string starts with Miscellaneous and which ends with .IntLib.

Notes

The Library property is only defined for part objects.

Summary

Returns all part objects whose Symbol Reference property complies with the Query.

Syntax

PartLibReference : String

Example Usage

PartLibReference = 'LM833'
Returns all part objects whose Symbol Reference property is LM833.

Notes

The Symbol Reference property is only defined for part objects.

Summary

Returns all part objects whose Symbol Reference property complies with the Query.

Syntax

PartSymbolReference : String

Example Usage

PartSymbolReference = '2N7002'
Returns all part objects whose Symbol Reference property is 2N7002.

PartSymbolReference Like 'Cap*'
Returns all part objects whose Symbol Reference property begins with Cap.

Notes

The Symbol Reference property is only defined for part objects.

Summary

Returns all pin objects whose Pin Designator property complies with the Query.

Syntax

PinDesignator : String

Example Usage

PinDesignator = '1'
Returns all pin objects whose Pin Designator property is 1.

PinDesignator = 'AA'
Returns all pin objects whose Pin Designator property is AA.

PinDesignator Like 'Z?'
Returns all Pin objects that have a Pin Designator property whose associated string consists of two characters, with the first of those characters being Z.

Notes

The Pin Designator property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Designator Color property complies with the Query.

Syntax

PinDesignator_CustomColor : Numeric_String
PinDesignator_CustomColor : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the PinDesignator_CustomColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Pin Designator Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Pin Designator Color Div 65536
• Green = Pin Designator Color Div 256 Mod 256
• Red = Pin Designator Color Mod 256

Example Usage

PinDesignator_CustomColor = '0'
PinDesignator_CustomColor <> '' && PinDesignator_CustomColor = 0
Returns all pin objects whose Pin Designator Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

PinDesignator_CustomColor = '16711680'
PinDesignator_CustomColor > '' && PinDesignator_CustomColor = 16711680
Returns all pin objects whose Pin Designator Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

PinDesignator_CustomColor <> '16777215'
Returns all pin objects except those whose Pin Designator Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

IsPin && PinDesignator_CustomColor Div 65536 <= 192
Returns all pin objects whose Pin Designator Color property's Blue component has a value which is less than or equal to 192.

IsPin && PinDesignator_CustomColor Mod 256 Between 64 And 192
Returns all pin objects whose Pin Designator Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

Notes

The Pin Designator Color property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Designator Font property complies with the Query.

Syntax

PinDesignator_CustomFont : String

Example Usage

PinDesignator_CustomFont = 'Trebuchet MS, 10'
Returns all pin objects whose Pin Designator Font property is Trebuchet MS, 10.

PinDesignator_CustomFont Like 'Treb*'
Returns all pin objects whose Pin Designator Font property begins with Treb.

Notes

The Pin Designator Font property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Designator Margin property complies with the Query.

Syntax

PinDesignator_CustomPosition_Margin : String

Example Usage

PinDesignator_CustomPosition_Margin = '8'
Returns all pin objects whose Pin Designator Margin property is 8.

PinDesignator_CustomPosition_Margin Between '5' And '12'
Returns all pin objects whose Pin Designator Margin property is greater than, or equal to, 5, and less than, or equal to, 12.

Notes

The Pin Designator Margin property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Designator Orientation Anchor property complies with the Query.

Syntax

PinDesignator_CustomPosition_RotationAnchor = RotationAnchor_String
PinDesignator_CustomPosition_RotationAnchor <> RotationAnchor_String

RotationAnchor_String must be one of the following strings:

• 'Component'
• 'Pin'

Example Usage

PinDesignator_CustomPosition_RotationAnchor = 'Component'
Returns all pin objects whose Pin Designator Orientation Anchor property is Component.

PinDesignator_CustomPosition_RotationAnchor <> 'Pin'
Returns all objects except pin objects whose Pin Designator Orientation Anchor property is Pin.

IsPin && PinDesignator_CustomPosition_RotationAnchor <> 'Component'
Returns all pin objects except those whose Pin Designator Orientation Anchor property is Component.

Notes

• The single quote characters (') at the start and end of RotationAnchor_String are mandatory.
• The Pin Designator Orientation Anchor property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Designator Relative Orientation property complies with the Query.

Syntax

PinDesignator_CustomPosition_RotationRelative = RotationRelative_String
PinDesignator_CustomPosition_RotationRelative <> RotationRelative_String

RotationRelative_String must be one of the following strings:

• '0 Degrees'
• '90 Degrees'

Example Usage

PinDesignator_CustomPosition_RotationRelative = '0 Degrees'
Returns all pin objects whose Pin Designator Relative Orientation property is 0 Degrees.

PinDesignator_CustomPosition_RotationRelative <> '90 Degrees'
Returns all objects except pin objects whose Pin Designator Relative Orientation property is 90 Degrees.

IsPin && PinDesignator_CustomPosition_RotationRelative <> '0 Degrees'
Returns all pin objects except those whose Pin Designator Relative Orientation property is 0 Degrees.

Notes

• The single quote characters (') at the start and end of RotationRelative_String are mandatory.
• The Pin Designator Relative Orientation property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Designator Font Mode property complies with the Query.

Syntax

PinDesignator_FontMode = FontMode_String
PinDesignator_FontMode <> FontMode_String

FontMode_String must be one of the following strings:

• 'Custom'
• 'Default'

Example Usage

PinDesignator_FontMode = 'Custom'
Returns all pin objects whose Pin Designator Font Mode property is Custom.

PinDesignator_FontMode <> 'Default'
Returns all objects except pin objects whose Pin Designator Font Mode property is Default.

IsPin && PinDesignator_FontMode <> 'Custom'
Returns all pin objects except those whose Pin Designator Font Mode property is Custom.

Notes

• The single quote characters (') at the start and end of FontMode_String are mandatory.
• The Pin Designator Font Mode property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Designator Position Mode property complies with the Query.

Syntax

PinDesignator_PositionMode = PositionMode_String
PinDesignator_PositionMode <> PositionMode_String

PositionMode_String must be one of the following strings:

• 'Custom'
• 'Default'

Example Usage

PinDesignator_PositionMode = 'Custom'
Returns all pin objects whose Pin Designator Position Mode property is Custom.

PinDesignator_PositionMode <> 'Default'
Returns all objects except pin objects whose Pin Designator Position Mode property is Default.

IsPin && PinDesignator_PositionMode <> 'Custom'
Returns all pin objects except those whose Pin Designator Position Mode property is Custom.

Notes

• The single quote characters (') at the start and end of PositionMode_String are mandatory.
• The Pin Designator Position Mode property is only defined for pin objects.

Summary

Returns all pin objects whose Electrical Type property complies with the Query.

Syntax

PinElectrical = ElectricalType_String
PinElectrical <> ElectricalType_String

ElectricalType_String must be one of the strings from the following list:

• 'HiZ'
• 'Input'
• 'I/O'
• 'Open Collector'
• 'Open Emitter'
• 'Output'
• 'Passive'
• 'Power'

Example Usage

PinElectrical = 'Passive'
Returns all pin objects whose Electrical Type property is Passive.

PinElectrical <> 'HiZ'
Returns all objects except pin objects whose Electrical Type property is HiZ.

Notes

• The Electrical Type property is only defined for pin objects.
• The single quote characters (') at the start and end of ElectricalType_String are mandatory.

Summary

Returns all pin objects whose Hidden Net Name property complies with the Query.

Syntax

PinHiddenNetName : String

Example Usage

PinHiddenNetName = 'GND'
Returns all pin objects whose Hidden Net Name property is GND.

PinHiddenNetName Like '???'
Returns all pin objects that have a Hidden Net Name property whose associated string consists of any three characters.

Notes

The Hidden Net Name property is only defined for pin objects.

Summary

Returns all pin objects whose IEEE Symbol Inside property complies with the Query.

Syntax

PinIeeeSymbolInner = IeeeSymbolInner_String
PinIeeeSymbolInner <> IeeeSymbolInner_String

IeeeSymbolInner_String must be one of the following strings:

• 'High Current'
• 'HiZ'
• 'No Symbol'
• 'Open Collector'
• 'Open Collector Pull Up'
• 'Open Emitter'
• 'Open Emitter Pull Up'
• 'Open Output'
• 'Pulse'
• 'Postponed Output'
• 'Schmitt'
• 'Shift Left'

Example Usage

PinIeeeSymbolInner = 'HiZ'
Returns all pin objects whose IEEE Symbol Inside property is HiZ.

PinIeeeSymbolInner <> 'Pulse'
Returns all objects except pin objects whose IEEE Symbol Inside property is Pulse.

IsPin && PinIeeeSymbolInner <> 'Open Emitter'
Returns all pin objects except those whose IEEE Symbol Inside property is Open Emitter.

Notes

• The single quote characters (') at the start and end of IeeeSymbolInner_String are mandatory.
• The IEEE Symbol Inside property is only defined for pin objects.

Summary

Returns all pin objects whose IEEE Symbol Inside Edge property complies with the Query.

Syntax

PinIeeeSymbolInnerEdge = IeeeSymbolInnerEdge_String
PinIeeeSymbolInnerEdge <> IeeeSymbolInnerEdge_String

IeeeSymbolInnerEdge_String must be one of the following strings:

• 'Clock'
• 'No Symbol'

Example Usage

PinIeeeSymbolInnerEdge = 'Clock'
Returns all pin objects whose IEEE Symbol Inside Edge property is Clock.

PinIeeeSymbolInnerEdge <> 'No Symbol'
Returns all objects except pin objects whose IEEE Symbol Inside Edge property is No Symbol.

IsPin && PinIeeeSymbolInnerEdge <> 'Clock'
Returns all pin objects except those whose IEEE Symbol Inside Edge property is Clock.

Notes

1. The single quote characters (') at the start and end of IeeeSymbolInnerEdge_String are mandatory.
2. The IEEE Symbol Inside Edge property is only defined for pin objects.

Summary

Returns all pin objects whose IEEE Symbol Line Width property complies with the Query.

Syntax

PinIeeeSymbolLineWidth = IeeeSymbolLineWidth_String
PinIeeeSymbolLineWidth <> IeeeSymbolLineWidth_String

IeeeSymbolLineWidth_String must be one of the following strings:

• 'Large'
• 'Medium'
• 'Small'
• 'Smallest'

Example Usage

PinIeeeSymbolLineWidth = 'Small'
Returns all pin objects whose IEEE Symbol Line Width property is Small.

PinIeeeSymbolLineWidth <> 'Smallest'
Returns all objects except pin objects whose IEEE Symbol Line Width property is Smallest.

IsPin && PinIeeeSymbolLineWidth <> 'Medium'
Returns all pin objects except those whose IEEE Symbol Line Width property is Medium.

Notes

• The single quote characters (') at the start and end of IeeeSymbolLineWidth_String are mandatory.
• The IEEE Symbol Line Width property is only defined for pin objects.

Summary

Returns all pin objects whose IEEE Symbol Outside property complies with the Query.

Syntax

PinIeeeSymbolOuter = IeeeSymbolOuter_String
PinIeeeSymbolOuter <> IeeeSymbolOuter_String

IeeeSymbolOuter_String must be one of the following strings:

• 'Analog Signal In'
• 'Bidirectional Signal Flow'
• 'Digital Signal In'
• 'Left Right Signal Flow'
• 'No Symbol'
• 'Not Logic Connection'
• 'Right Left Signal Flow'

Example Usage

PinIeeeSymbolOuter = 'Digital Signal In'
Returns all pin objects whose IEEE Symbol Outside property is Digital Signal In.

PinIeeeSymbolOuter <> 'Bidirectional Signal Flow'
Returns all objects except pin objects whose IEEE Symbol Outside property is Bidirectional Signal Flow.

IsPin && PinIeeeSymbolOuter <> 'No Symbol'
Returns all pin objects except those whose IEEE Symbol Outside property is No Symbol.

Notes

• The single quote characters (') at the start and end of IeeeSymbolOuter_String are mandatory.
• The IEEE Symbol Outside property is only defined for pin objects.

Summary

Returns all pin objects whose IEEE Symbol Outside Edge property complies with the Query.

Syntax

PinIeeeSymbolOuterEdge = IeeeSymbolOuterEdge_String
PinIeeeSymbolOuterEdge <> IeeeSymbolOuterEdge_String

IeeeSymbolOuterEdge_String must be one of the following strings:

• 'Active Low Input'
• 'Active Low Output'
• 'Dot'
• 'No Symbol'

Example Usage

PinIeeeSymbolOuterEdge = 'Dot'
Returns all pin objects whose IEEE Symbol Outside Edge property is Dot.

PinIeeeSymbolOuterEdge <> 'Active Low Output'
Returns all objects except pin objects whose IEEE Symbol Outside Edge property is Active Low Output.

IsPin && PinIeeeSymbolOuterEdge <> 'No Symbol'
Returns all pin objects except those whose IEEE Symbol Outside Edge property is No Symbol.

Notes

• The single quote characters (') at the start and end of IeeeSymbolOuterEdge_String are mandatory.
• The IEEE Symbol Outside Edge property is only defined for pin objects.

Summary

Returns all pin objects whose Length property complies with the Query.

Syntax

PinLength : Numeric_String
PinLength : Number

Example Usage

PinLength = '30'
Returns all pin objects whose Length property is equal to 30.

PinLength Between '20' And '40'
Returns all pin objects whose Length property is greater than or equal to 20 and less than or equal to 40.

PinLength >= '10'
Returns all pin objects whose Length property is greater than or equal to 10.

IsPin && PinLength < 30
Returns all pin objects whose Length property is less than 30.

PinLength <> '40'
Returns all objects except pin objects whose Length property is equal to 40.

IsPin && PinLength <> 40
Returns all pin objects whose Length property is not equal to 40.

Notes

The Length property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Name Color property complies with the Query.

Syntax

PinName_CustomColor : Numeric_String
PinName_CustomColor : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the PinName_CustomColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Pin Name Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Pin Name Color Div 65536
• Green = Pin Name Color Div 256 Mod 256
• Red = Pin Name Color Mod 256

Example Usage

PinName_CustomColor = '0'
PinName_CustomColor <> '' && PinName_CustomColor = 0
Returns all pin objects whose Pin Name Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

PinName_CustomColor = '16711680'
PinName_CustomColor > '' && PinName_CustomColor = 16711680
Returns all pin objects whose Pin Name Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

PinName_CustomColor <> '16777215'
Returns all pin objects except those whose Pin Name Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

IsPin && PinName_CustomColor Div 65536 <= 192
Returns all pin objects whose Pin Name Color property's Blue component has a value which is less than or equal to 192.

IsPin && PinName_CustomColor Mod 256 Between 64 And 192
Returns all pin objects whose Pin Name Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

Notes

The Pin Name Color property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Name Font property complies with the Query.

Syntax

PinName_CustomFont : String

Example Usage

PinName_CustomFont = 'Trebuchet MS, 10'
Returns all pin objects whose Pin Name Font property is Trebuchet MS, 10.

PinName_CustomFont Like 'Treb*'
Returns all pin objects whose Pin Name Font property begins with Treb.

Notes

The Pin Name Font property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Name Margin property complies with the Query.

Syntax

PinName_CustomPosition_Margin : String

Example Usage

PinName_CustomPosition_Margin = '5'
Returns all pin objects whose Pin Name Margin property is 5.

PinName_CustomPosition_Margin Between '5' And '8'
Returns all pin objects whose Pin Name Margin property is greater than, or equal to, 5, and less than, or equal to, 8.

Notes

The Pin Name Margin property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Name Orientation Anchor property complies with the Query.

Syntax

PinName_CustomPosition_RotationAnchor = RotationAnchor_String
PinName_CustomPosition_RotationAnchor <> RotationAnchor_String

RotationAnchor_String must be one of the following strings:

• 'Component'
• 'Pin'

Example Usage

PinName_CustomPosition_RotationAnchor = 'Component'
Returns all pin objects whose Pin Name Orientation Anchor property is Component.

PinName_CustomPosition_RotationAnchor <> 'Pin'
Returns all objects except pin objects whose Pin Name Orientation Anchor property is Pin.

IsPin && PinName_CustomPosition_RotationAnchor <> 'Component'
Returns all pin objects except those whose Pin Name Orientation Anchor property is Component.

Notes

• The single quote characters (') at the start and end of RotationAnchor_String are mandatory.
• The Pin Name Orientation Anchor property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Name Relative Orientation property complies with the Query.

Syntax

PinName_CustomPosition_RotationRelative = RotationRelative_String
PinName_CustomPosition_RotationRelative <> RotationRelative_String

RotationRelative_String must be one of the following strings:

• '0 Degrees'
• '90 Degrees'

Example Usage

PinName_CustomPosition_RotationRelative = '0 Degrees'
Returns all pin objects whose Pin Name Relative Orientation property is 0 Degrees.

PinName_CustomPosition_RotationRelative <> '90 Degrees'
Returns all objects except pin objects whose Pin Name Relative Orientation property is 90 Degrees.

IsPin && PinName_CustomPosition_RotationRelative <> '0 Degrees'
Returns all pin objects except those whose Pin Name Relative Orientation property is 0 Degrees.

Notes

• The single quote characters (') at the start and end of RotationRelative_String are mandatory.
• The Pin Name Relative Orientation property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Name Font Mode property complies with the Query.

Syntax

PinName_FontMode = FontMode_String
PinName_FontMode <> FontMode_String

FontMode_String must be one of the following strings:

• 'Custom'
• 'Default'

Example Usage

PinName_FontMode = 'Custom'
Returns all pin objects whose Pin Name Font Mode property is Custom.

PinName_FontMode <> 'Default'
Returns all objects except pin objects whose Pin Name Font Mode property is Default.

IsPin && PinName_FontMode <> 'Custom'
Returns all pin objects except those whose Pin Name Font Mode property is Custom.

Notes

• The single quote characters (') at the start and end of FontMode_String are mandatory.
• The Pin Name Font Mode property is only defined for pin objects.

Summary

Returns all pin objects whose Pin Name Position Mode property complies with the Query.

Syntax

PinName_PositionMode = PositionMode_String
PinName_PositionMode <> PositionMode_String

PositionMode_String must be one of the following strings:

• 'Custom'
• 'Default'

Example Usage

PinName_PositionMode = 'Custom'
Returns all pin objects whose Pin Name Position Mode property is Custom.

PinName_PositionMode <> 'Default'
Returns all objects except pin objects whose Pin Name Position Mode property is Default.

IsPin && PinName_PositionMode <> 'Custom'
Returns all pin objects except those whose Pin Name Position Mode property is Custom.

Notes

• The single quote characters (') at the start and end of PositionMode_String are mandatory.
• The Pin Name Position Mode property is only defined for pin objects.

Summary

Returns all pin objects whose Pin/Pkg Length property complies with the Query.

Syntax

PinPackageLength : Numeric_String
PinPackageLength : Number

Example Usage

PinPackageLength = '30'
Returns all pin objects whose Pin/Pkg Length property is equal to 30.

PinPackageLength Between '20' And '40'
Returns all pin objects whose Pin/Pkg Length property is greater than or equal to 20 and less than or equal to 40.

PinPackageLength >= '10'
Returns all pin objects whose Pin/Pkg Length property is greater than or equal to 10.

IsPin && PinPackageLength < 30
Returns all pin objects whose Pin/Pkg Length property is less than 30.

PinPackageLength <> '40'
Returns all objects except pin objects whose Pin/Pkg Length property is equal to 40.

IsPin && PinPackageLength <> 40
Returns all pin objects whose Pin/Pkg Length property is not equal to 40.

Notes

The Pin/Pkg Length property is only defined for pin objects.

Summary

Returns all pin objects whose Propagation Delay property complies with the Query.

Syntax

PinPropagationDelay : String

Example Usage

PinPropagationDelay = '10ps'
Returns all pin objects whose Propagation Delay property is 10ps.

Note

The Propagation Delay property is only defined for pin objects.

Summary

Returns all pin objects whose Show Designator property complies with the Query.

Syntax

PinShowDesignator : Boolean_String

Example Usage

PinShowDesignator = 'True'
Returns all pin objects whose Show Designator property is enabled.

PinShowDesignator = 'False'
Returns all pin objects whose Show Designator property is disabled.

Notes

The Show Designator property is only defined for pin objects.

Summary

Returns all part objects whose Pins Locked property complies with the Query.

Syntax

PinsLocked : Boolean_String

Example Usage

PinsLocked = 'True'
Returns all part objects whose Pins Locked property is enabled.

PinsLocked = 'False'
Returns all part objects whose Pins Locked property is disabled.

Notes

The Pins Locked property is only defined for part objects.

Summary

Returns all pin objects whose Pin Swap Group property complies with the Query.

Syntax

PinSwapId_Pin : String

Example Usage

PinSwapId_Pin = '4'
Returns all pin objects whose Pin Swap Group property is 4.

PinSwapId_Pin Like 'D?'
Returns all pin objects whose Pin Swap Group property begins with D, followed by one additional character.

Notes

The Pin Swap Group property is only defined for pin objects.

Summary

Returns all port and sheet entry objects whose Arrow Style property complies with the Query.

Syntax

PortArrowStyle = PortArrowStyle_String
PortArrowStyle <> PortArrowStyle_String

PortArrowStyle_String must be one of the following strings:

• 'Bottom'
• 'Left'
• 'Left & Right'
• 'None (Horizontal)'
• 'None (Vertical)'
• 'Right'
• 'Top'
• 'Top & Bottom'

Example Usage

PortArrowStyle = 'Left'
Returns all port and sheet entry objects whose Arrow Style property is Left.

PortArrowStyle <> 'Right'
Returns all objects except port and sheet entry objects whose Arrow Style property is Right.

IsPort && PortArrowStyle <> 'Left & Right'
Returns all port objects except those whose Arrow Style property is Left & Right.

Notes

• The single quote characters (') at the start and end of PortArrowStyle_String are mandatory.
• The Arrow Style property is only defined for port and sheet entry objects.

Summary

Returns all port and sheet entry objects whose IO Type property complies with the Query.

Syntax

PortIOType = IOType_String
PortIOType <> IOType_String

IOType_String must be one of the strings from the following list:

• 'Bidirectional'
• 'Input'
• 'Output'
• 'Unspecified'

Example Usage

PortIOType = 'Bidirectional'
Returns all port and sheet entry objects whose IO Type property is Bidirectional.

PortIOType <> 'Output'
Returns all objects except port and sheet entry objects whose IO Type property is Output.

Notes

• The IO Type property is only defined for port and sheet entry objects.
• The single quote characters (') at the start and end of IOType_String are mandatory.

Summary

Returns all power port objects whose Power Object Style property complies with the Query.

Syntax

PowerObjectStyle = PowerObjectStyle_String
PowerObjectStyle <> PowerObjectStyle_String

PowerObjectStyle_String must be one of the strings from the following list:

• 'Arrow'
• 'Bar'
• 'Circle'
• 'Earth'
• 'GOST Arrow'
• 'GOST Bar'
• 'GOST Earth'
• 'GOST Power Ground'
• 'Power Ground'
• 'Signal Ground'
• 'Wave'

Example Usage

PowerObjectStyle = 'Circle'
Returns all power port objects whose Power Object Style property is Circle.

PowerObjectStyle <> 'Wave'
Returns all objects except power port objects whose Power Object Style property is Wave.

PowerObjectStyle <> '' && PowerObjectStyle <> 'Wave'
PowerObjectStyle > '' && PowerObjectStyle <> 'Wave'
IsPowerObject && PowerObjectStyle <> 'Wave'
Returns all power port objects whose Power Object Style property is not Wave.

Notes

• The Power Object Style property is only defined for power port objects.
• The single quote characters (') at the start and end of PowerObjectStyle_String are mandatory.

Summary

Returns all harness connector objects whose Primary Connection Position property complies with the Query.

Syntax

PrimaryConnectionPosition : Numeric_String
PrimaryConnectionPosition : Number

Example Usage

PrimaryConnectionPosition = '300'
Returns all harness connector objects whose Primary Connection Position property is 300.

PrimaryConnectionPosition Between '150' And '230'
Returns all harness connector objects whose Primary Connection Position property is greater than, or equal to, 150, and less than, or equal to, 230.

IsHarnessConnector && PrimaryConnectionPosition >= 250
Returns all harness connector objects whose Primary Connection Position property is greater than, or equal to, 250.

IsHarnessConnector && PrimaryConnectionPosition < 350
Returns all harness connector objects whose Primary Connection Position property is less than 350.

PrimaryConnectionPosition <> '300'
Returns all objects except harness connector objects whose Primary Connection Position property is 300.

Notes

The Primary Connection Position property is only defined for harness connector objects.

Summary

Returns all arc and ellipse objects whose Radius property complies with the Query.

Syntax

Radius : Numeric_String
Radius : Number

Example Usage

Radius = '300'
Returns all arc and ellipse objects whose Radius property is 300.

Radius Between '150' And '230'
Returns all arc and ellipse objects whose Radius property is greater than, or equal to, 150, and less than, or equal to, 230.

IsArc && Radius >= 250
Returns all arc objects whose Radius property is greater than, or equal to, 250.

Radius <> '300'
Returns all objects except arc and ellipse objects whose Radius property is 300.

Notes

The Radius property is only defined for arc and ellipse objects.

Summary

Returns all part and sheet symbol (managed sheet instance) objects whose Revision property complies with the Query. This is the revision of a Component Item or Schematic Sheet Item (Managed Sheet) that has been sourced and placed from a server.

Syntax

Revision : String

Example Usage

Revision = 'CMP-00001-A.1'
Returns all part and sheet symbol (managed sheet instance) objects whose Revision property is CMP-00001-A.1.

Revision Like '*0099B*'
Returns all part and sheet symbol (managed sheet instance) objects whose Revision property includes 0099B.

Notes

The Revision property is only defined for part and sheet symbol (managed sheet instance) objects.

Summary

Returns all round rectangle objects whose X Radius property complies with the Query.

Syntax

RoundRectangleCornerRadiusX : Numeric_String
RoundRectangleCornerRadiusX : Number

Example Usage

RoundRectangleCornerRadiusX = '300'
Returns all round rectangle objects whose X Radius property is 300.

RoundRectangleCornerRadiusX Between '150' And '230'
Returns all round rectangle objects whose X Radius property is greater than, or equal to, 150, and less than, or equal to, 230.

IsRoundRectangle && RoundRectangleCornerRadiusX >= 250
Returns all round rectangle objects whose X Radius property is greater than, or equal to, 250.

IsRoundRectangle && RoundRectangleCornerRadiusX < 350
Returns all round rectangle objects whose X Radius property is less than 350.

RoundRectangleCornerRadiusX <> '300'
Returns all objects except round rectangle objects whose X Radius property is 300.

Notes

The X Radius property is only defined for round rectangle objects.

Summary

Returns all round rectangle objects whose Y Radius property complies with the Query.

Syntax

RoundRectangleCornerRadiusY : Numeric_String
RoundRectangleCornerRadiusY : Number

Example Usage

RoundRectangleCornerRadiusY = '300'
Returns all round rectangle objects whose Y Radius property is 300.

RoundRectangleCornerRadiusY Between '150' And '230'
Returns all round rectangle objects whose Y Radius property is greater than, or equal to, 150, and less than, or equal to, 230.

IsRoundRectangle && RoundRectangleCornerRadiusY >= 250
Returns all round rectangle objects whose Y Radius property is greater than, or equal to, 250.

IsRoundRectangle && RoundRectangleCornerRadiusY < 350
Returns all round rectangle objects whose Y Radius property is less than 350.

RoundRectangleCornerRadiusY <> '300'
Returns all objects except round rectangle objects whose Y Radius property is 300.

Notes

The Y Radius property is only defined for round rectangle objects.

Summary

Returns all ellipse elliptiobjects whose Secondary Radius property complies with the Query.

Syntax

SecondaryRadius : Numeric_String
SecondaryRadius : Number

Example Usage

SecondaryRadius = '300'
Returns all ellipse objects whose Secondary Radius property is 300.

SecondaryRadius Between '150' And '230'
Returns all ellipse objects whose Secondary Radius property is greater than or equal to 150, and less than or equal to 230.

IsEllipse && SecondaryRadius >= 250
Returns all ellipse objects whose Secondary Radius property is greater than or equal to 250.

SecondaryRadius <> '300'
Returns all objects except ellipse objects whose Secondary Radius property is 300.

Notes

The Secondary Radius property is only defined for ellipse objects.

Summary

Returns all bus, polygon, polyline, signal harness, and wire objects whose Selected Vertex X property complies with the Query.

Syntax

SelectedVertex_X : String

Example Usage

SelectedVertex_X = '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose Selected Vertex X property is 1100.

SelectedVertex_X > '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose Selected Vertex X property is greater than 1100.

IsSignalHarness && SelectedVertex_X Between '1100' And '2500'
Returns all signal harness objects whose Selected Vertex X property is greater than, or equal to, 1100, and less than, or equal to, 2500.

Notes

The Selected Vertex X property is only defined for bus, polygon, polyline, signal harness, and wire objects.

Summary

Returns all bus, polygon, polyline, signal harness, and wire objects whose Selected Vertex Y property complies with the Query.

Syntax

SelectedVertex_Y : String

Example Usage

SelectedVertex_Y = '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose Selected Vertex Y property is 1100.

SelectedVertex_Y > '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose Selected Vertex Y property is greater than 1100.

IsSignalHarness && SelectedVertex_Y Between '1100' And '2500'
Returns all signal harness objects whose Selected Vertex Y property is greater than, or equal to, 1100, and less than, or equal to, 2500.

Notes

The Selected Vertex Y property is only defined for bus, polygon, polyline, signal harness, and wire objects.

Summary

Returns all bus, polygon, polyline, signal harness, and wire objects whose 2nd Selected Vertex X property complies with the Query.

Syntax

SelectedVertex2_X : String

Example Usage

SelectedVertex2_X = '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose 2nd Selected Vertex X property is 1100.

SelectedVertex2_X > '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose 2nd Selected Vertex X property is greater than 1100.

IsSignalHarness && SelectedVertex2_X Between '1100' And '2500'
Returns all signal harness objects whose 2nd Selected Vertex X property is greater than, or equal to, 1100, and less than, or equal to, 2500.

Notes

The 2nd Selected Vertex X property is only defined for bus, polygon, polyline, signal harness, and wire objects.

Summary

Returns all bus, polygon, polyline, signal harness, and wire objects whose 2nd Selected Vertex Y property complies with the Query.

Syntax

SelectedVertex2_Y : String

Example Usage

SelectedVertex2_Y = '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose 2nd Selected Vertex Y property is 1100.

SelectedVertex2_Y > '1100'
Returns all bus, polygon, polyline, signal harness, and wire objects whose 2nd Selected Vertex Y property is greater than 1100.

IsSignalHarness && SelectedVertex2_Y Between '1100' And '2500'
Returns all signal harness objects whose 2nd Selected Vertex Y property is greater than, or equal to, 1100, and less than, or equal to, 2500.

Notes

The 2nd Selected Vertex Y property is only defined for bus, polygon, polyline, signal harness, and wire objects.

Summary

Returns all harness entry and sheet entry objects whose Position property complies with the Query.

Syntax

Position : Numeric_String
Position : Number

Example Usage

Position = '300'
Returns all harness entry and sheet entry objects whose Position property is 300.

Position Between '100' And '300'
Returns all harness entry and sheet entry objects whose Position property is greater than, or equal to, 100, and less than, or equal to, 300.

IsHarnessEntry && Position >= 300
Returns all harness entry objects whose Position property is greater than, or equal to, 300.

IsSheetEntry && Position < 300
Returns all sheet entry objects whose Position property is less than 300.

Position <> '400'
Returns all objects except harness entry and sheet entry objects whose Position property is 400.

Notes

The Position property is only defined for harness entry and sheet entry objects.

Summary

Returns all harness entry and sheet entry objects whose Side property complies with the Query.

Syntax

SheetEntrySide = SheetEntrySide_String
SheetEntrySide <> SheetEntrySide_String

SheetEntrySide_String specifies on which side of the harness entry, or sheet symbol, the entry resides, and must be one of the following strings:

• 'Bottom'
• 'Left'
• 'Right'
• 'Top'

Example Usage

SheetEntrySide = 'Left'
Returns all harness entry and sheet entry objects whose Side property is Left.

SheetEntrySide <> 'Right'
Returns all objects except harness entry and sheet entry objects whose Side property is Right.

IsSheetEntry && SheetEntrySide <> 'Top'
Returns all sheet entry objects except those whose Side property is Top.

Notes

• The single quote characters (') at the start and end of SheetEntrySide_String are mandatory.
• The Side property is only defined for harness entry and sheet entry objects.

Summary

Returns all sheet symbol objects (sheet symbol, device sheet symbol, managed sheet instance symbol) whose Sheet File Name property complies with the Query.

Syntax

SheetFileName : String

Example Usage

SheetFileName = 'Microcontroller_STM32F101.SchDoc'
Returns all sheet symbol objects whose Sheet File Name property is Microcontroller_STM32F101.SchDoc.

SheetFileName Like '*Res*'
Returns all sheet symbol objects whose Sheet File Name property includes Res.

Notes

The Sheet File Name property is only defined for sheet symbol objects.

Summary

Returns all sheet symbol objects (sheet symbol, device sheet symbol, managed sheet instance symbol) whose Sheet Name property (i.e. the Sheet Symbol Designator) complies with the Query.

Syntax

SheetName : String

Example Usage

SheetName = 'Accelerometer'
Returns all sheet symbol objects whose Sheet Name property is Accelerometer.

SheetName Like '*Power*'
Returns all sheet symbol objects whose Sheet Name property includes Power.

Notes

The Sheet Name property is only defined for sheet symbol objects.

Summary

Returns all part objects whose Show Designator property complies with the Query.

Syntax

ShowDesignator : Boolean_String

Example Usage

ShowDesignator = 'True'
Returns all part objects whose Show Designator property is enabled.

ShowDesignator = 'False'
Returns all part objects whose Show Designator property is disabled.

Notes

The Show Designator property is only defined for part objects.

Summary

Returns all sheet symbol objects (sheet symbol, device sheet symbol, managed sheet instance symbol) whose Show Hidden Fields property complies with the Query.

Syntax

ShowHiddenFields : Boolean_String

Example Usage

ShowHiddenFields = 'True'
Returns all sheet symbol objects whose Show Hidden Fields property is enabled.

ShowHiddenFields = 'False'
Returns all sheet symbol objects whose Show Hidden Fields property is disabled.

Notes

The Show Hidden Fields property is only defined for sheet symbol objects.

Summary

Returns all part objects whose Show Hidden Pins property complies with the Query.

Syntax

ShowHiddenPins : Boolean_String

Example Usage

ShowHiddenPins = 'True'
Returns all part objects whose Show Hidden Pins property is enabled.

ShowHiddenPins = 'False'
Returns all part objects whose Show Hidden Pins property is disabled.

Notes

The Show Hidden Pins property is only defined for part objects.

Summary

Returns all parameter and pin objects whose Show Name property complies with the Query.

Syntax

ShowName : Boolean_String

Example Usage

ShowName = 'True'
Returns all parameter and pin objects whose Show Name property is enabled.

ShowName = 'False'
Returns all parameter and pin objects whose Show Name property is disabled.

Notes

The Show Name property is only defined for parameter and pin objects.

Summary

Returns all power port objects whose Show Net Name property complies with the Query.

Syntax

ShowNetName : Boolean_String

Example Usage

ShowNetName = 'True'
Returns all power port objects whose Show Net Name property is enabled.

ShowNetName = 'False'
Returns all power port objects whose Show Net Name property is disabled.

Notes

The Show Net Name property is only defined for power port objects.

Summary

Returns all ellipse, polygon, rectangle, round rectangle, sheet symbol, and text frame objects whose Solid property complies with the Query.

Syntax

Solid : Boolean_String

Example Usage

Solid = 'True'
Returns all ellipse, polygon, rectangle, round rectangle, sheet symbol, and text frame objects whose Solid property is enabled.

Solid = 'False'
Returns all ellipse, polygon, rectangle, round rectangle, sheet symbol, and text frame objects whose Solid property is disabled.

Notes

The Solid property is only defined for ellipse, polygon, rectangle, round rectangle, sheet symbol, and text frame objects.

Summary

Returns all arc objects whose Start Angle property complies with the Query.

Syntax

StartAngle : Numeric_String
StartAngle : Number

Example Usage

StartAngle = '120'
Returns all arc objects whose Start Angle property is 120.

StartAngle Between '50' And '130'
Returns all arc objects whose Start Angle property is greater than or equal to 50, and less than or equal to 130.

IsArc && StartAngle >= 150
Returns all arc objects whose Start Angle property is greater than or equal to 150.

StartAngle <> '10'
Returns all objects except arc objects whose Start Angle property is 10.

Notes

The Start Angle property is only defined for arc objects.

Summary

Returns all polyline objects whose Start Line Shape property complies with the Query.

Syntax

StartLineShape = StartLineShape_String
StartLineShape <> StartLineShape_String

StartLineShape_String specifies the shape at the start of the line and must be one of the following strings:

• 'Arrow'
• 'Circle'
• 'None'
• 'SolidArrow'
• 'SolidTail'
• 'Square'
• 'Tail'

Example Usage

StartLineShape = 'Arrow'
Returns all polyline objects whose Start Line Shape property is Arrow.

StartLineShape <> 'SolidArrow'
Returns all objects except polyline objects whose Start Line Shape property is SolidArrow.

Notes

• The single quote characters (') at the start and end of StartLineShape_String are mandatory.
• The Start Line Shape property is only defined for polyline objects.

Summary

Returns all designator, net label, off sheet connector, power port, sheet symbol designator, and text string objects whose Text property complies with the Query.

Syntax

StringText : String

Example Usage

StringText = 'GND'
Returns all designator, net label, off sheet connector, power port, sheet symbol designator, and text string objects whose Text property is GND.

StringText Like '???'
Returns all designator, net label, off sheet connector, power port, sheet symbol designator, and text string objects that have a Text property whose associated string consists of exactly three characters.

Notes

The Text property is only defined for designator, net label, off sheet connector, power port, sheet symbol designator, and text string objects.

Summary

Returns all No ERC objects whose Suppress Specific Violations property complies with the Query.

Syntax

SuppressSpecific : Boolean_String

Example Usage

SuppressSpecific = 'True'
Returns all No ERC objects whose Suppress Specific Violations property is enabled.

SuppressSpecific = 'False'
Returns all No ERC objects whose Suppress Specific Violations property is disabled.

Notes

The Suppress Specific Violations property is only defined for No ERC objects.

Summary

Returns all part objects whose Symbol Item property complies with the Query.

Syntax

SymbolItem : String

Example Usage

SymbolItem = 'SYM-00054'
Returns all part objects whose Symbol Item property is SYM-00054.

SymbolItem Like '*0019*'
Returns all part objects whose Symbol Item property includes 0019.

Notes

The Symbol Item property is only defined for part objects.

Summary

Returns all part objects whose Symbol Revision property complies with the Query.

Syntax

SymbolRevision : String

Example Usage

SymbolRevision = 'SYM-00054-1'
Returns all part objects whose Symbol Revision property is SYM-00054-1.

SymbolRevision Like '*-2'
Returns all part objects whose Symbol Revision property ends with -2 (i.e. return all parts that reference a second revision Schematic Symbol Item).

Notes

The Symbol Revision property is only defined for part objects.

Summary

Returns all IEEE symbol objects whose Scale property complies with the Query.

Syntax

SymbolScaleFactor : Numeric_String
SymbolScaleFactor : Number

Example Usage

SymbolScaleFactor = '1000000'
Returns all IEEE symbol objects whose Scale property is 1000000.

SymbolScaleFactor Between '300000' And '700000'
Returns all IEEE symbol objects whose Scale property is greater than, or equal to, 300000, and less than, or equal to, 700000.

IsSymbol && SymbolScaleFactor >= 400000
Returns all IEEE symbol objects whose Scale property is greater than, or equal to, 400000.

SymbolScaleFactor <> '1000000'
Returns all objects except IEEE symbol objects whose Scale property is 1000000.

Notes

The Scale property is only defined for IEEE symbol objects.

Summary

Returns all part objects whose Symbol Vault property complies with the Query. This is the server from which a Schematic Symbol Item - referenced by a placed part (Component Item) that has been sourced from a server - resides. Typically, this is the same server as the parent Component Item.

Syntax

SymbolVault : String

Example Usage

SymbolVault = 'Company Vault'
Returns all part objects whose Symbol Vault property is Company Vault.

Notes

The Symbol Vault property is only defined for part objects.

Summary

Returns all harness entry, note, port, sheet entry, and text frame objects whose Text Color property complies with the Query.

Syntax

TextColor : Numeric_String
TextColor : Number

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the TextColor keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Text Color property's Blue, Green, and Red components, by using the following constructs:

• Blue = Text Color Div 65536
• Green = Text Color Div 256 Mod 256
• Red = Text Color Mod 256

Example Usage

TextColor = '0'
TextColor <> '' && TextColor = 0
Returns all harness entry, note, port, sheet entry, and text frame objects whose Text Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

TextColor = '32896'
TextColor > '' && TextColor = 32896
Returns all harness entry, note, port, sheet entry, and text frame objects whose Text Color property is 32896 (which corresponds to values of Blue = 0, Green = 128, and Red = 128).

TextColor <> '16777215'
Returns all objects except harness entry, note, port, sheet entry, and text frame objects whose Text Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

IsPort Or IsTextFrame && TextColor <> 16777215
Returns all port, or text frame objects, whose Text Color property is not 16777215.

TextColor > '' && TextColor Div 65536 >= 96 && TextColor Div 256 Mod 256 Between 64 And 192 && TextColor Mod 256 <= 128
Returns all harness entry, note, port, sheet entry, and text frame objects whose Text Color property is such that the Blue component has a value which is greater than or equal to 96, the Green component has a value which is greater than or equal to 64 and less than or equal to 192, and the Red component has a value which is less than or equal to 128.

IsTextFrame && TextColor Div 65536 <= 192
Returns all text frame objects whose Text Color property's Blue component has a value which is less than or equal to 192.

IsPort && TextColor Mod 256 Between 64 And 192
Returns all port objects whose Text Color property's Red component has a value which is greater than or equal to 64 and less than or equal to 192.

Notes

The Text Color property is only defined for harness entry, note, port, sheet entry, and text frame objects.

Summary

Returns all note and text frame objects whose Clip To Area property complies with the Query.

Syntax

TextFrameClipToRect : Boolean_String

Example Usage

TextFrameClipToRect = 'True'
Returns all note and text frame objects whose Clip To Area property is enabled.

TextFrameClipToRect = 'False'
Returns all note and text frame objects whose Clip To Area property is disabled.

Notes

The Clip To Area property is only defined for note and text frame objects.

Summary

Returns all image and text frame objects whose Show Border property complies with the Query.

Syntax

TextFrameShowBorder : Boolean_String

Example Usage

TextFrameShowBorder = 'True'
Returns all image and text frame objects whose Show Border property is enabled.

TextFrameShowBorder = 'False'
Returns all image and text frame objects whose Show Border property is disabled.

Notes

The Show Border property is only defined for image and text frame objects.

Summary

Returns all note and text frame objects whose Word Wrap property complies with the Query.

Syntax

TextFrameWordWrap : Boolean_String

Example Usage

TextFrameWordWrap = 'True'
Returns all note and text frame objects whose Word Wrap property is enabled.

TextFrameWordWrap = 'False'
Returns all note and text frame objects whose Word Wrap property is disabled.

Notes

The Word Wrap property is only defined for note and text frame objects.

Summary

Returns all parameter objects whose Text Horizontal Anchor property complies with the Query.

Syntax

TextHorizontalAnchor = TextHorizontalAnchor_String
TextHorizontalAnchor <> TextHorizontalAnchor_String

TextHorizontalAnchor_String specifies the anchor point, and must be one of the following strings:

• 'Both'
• 'Left'
• 'None'
• 'Right'

Example Usage

TextHorizontalAnchor = 'Left'
Returns all parameter objects whose Text Horizontal Anchor property is Left.

TextHorizontalAnchor <> 'Right'
Returns all objects except parameter objects whose Text Horizontal Anchor property is Right.

IsParameter && TextHorizontalAnchor <> 'None'
Returns all parameter objects except those whose Text Horizontal Anchor property is None.

Notes

• The single quote characters (') at the start and end of TextHorizontalAnchor_String are mandatory.
• The Text Horizontal Anchor property is only defined for parameter objects.

Summary

Returns all parameter objects whose Text Vertical Anchor property complies with the Query.

Syntax

TextVerticalAnchor = TextVerticalAnchor_String
TextVerticalAnchor <> TextVerticalAnchor_String

TextVerticalAnchor_String specifies the anchor point, and must be one of the following strings:

• 'Both'
• 'Bottom'
• 'None'
• 'Top'

Example Usage

TextVerticalAnchor = 'Top'
Returns all parameter objects whose Text Vertical Anchor property is Top.

TextVerticalAnchor <> 'Bottom'
Returns all objects except parameter objects whose Text Vertical Anchor property is Bottom.

IsParameter && TextVerticalAnchor <> 'None'
Returns all parameter objects except those whose Text Vertical Anchor property is None.

Notes

• The single quote characters (') at the start and end of TextVerticalAnchor_String are mandatory.
• The Text Vertical Anchor property is only defined for parameter objects.

Summary

Returns all ellipse, note, polygon, rectangle, and text frame objects whose Transparent property complies with the Query.

Syntax

Transparent : Boolean_String

Example Usage

Transparent = 'True'
Returns all ellipse, note, polygon, rectangle, and text frame objects whose Transparent property is enabled.

Transparent = 'False'
Returns all ellipse, note, polygon, rectangle, and text frame objects whose Transparent property is disabled.

Notes

The Transparent property is only defined for ellipse, note, polygon, rectangle, and text frame objects.

Summary

Returns all text string objects whose URL property complies with the Query.

Syntax

URL : String

Example Usage

URL = 'live.altium.com'
Returns all text string objects whose URL property is live.altium.com.

URL Like '*altium*'
Returns all text string objects whose URL property includes altium.

Notes

The URL property is only defined for text string objects.

Summary

Returns all part objects whose Use Database Table Name property complies with the Query.

Syntax

UseDBTableName : Boolean_String

Example Usage

UseDBTableName = 'True'
Returns all part objects whose Use Database Table Name property is enabled.

UseDBTableName = 'False'
Returns all part objects whose Use Database Table Name property is disabled.

Notes

The Use Database Table Name property is only defined for part objects.

Summary

Returns all part objects whose Use Library Name property complies with the Query.

Syntax

UseLibraryName : Boolean_String

Example Usage

UseLibraryName = 'True'
Returns all part objects whose Use Library Name property is enabled.

UseLibraryName = 'False'
Returns all part objects whose Use Library Name property is disabled.

Notes

The Use Library Name property is only defined for part objects.

Summary

Returns all part and sheet symbol (managed sheet instance) objects whose Vault property complies with the Query. This is the server from which a Component Item or Schematic Sheet Item (Managed Sheet) has been sourced and placed.

Syntax

Vault : String

Example Usage

Vault = 'Company Vault'
Returns all part and sheet symbol (managed sheet instance) objects whose Vault property is Company Vault.

Notes

The Vault property is only defined for part and sheet symbol (managed sheet instance) objects.

Summary

Returns all designator, parameter, sheet file name, sheet name, and text string objects whose Vertical Justification property complies with the Query.

Syntax

VerticalJustification = VerticalJustification_String
VerticalJustification <> VerticalJustification_String

VerticalJustification_String specifies the text justification and must be one of the following strings:

• 'Bottom'
• 'Center'
• 'Top'

Example Usage

VerticalJustification = 'Top'
Returns all designator, parameter, sheet file name, sheet name, and text string objects whose Vertical Justification property is Top.

VerticalJustification <> 'Center'
Returns all objects except designator, parameter, sheet file name, sheet name, and text string objects whose Vertical Justification property is Center.

Notes

• The single quote characters (') at the start and end of VerticalJustification_String are mandatory.
• The Vertical Justification property is only defined for designator, parameter, sheet file name, sheet name, and text string objects.

Summary

Returns all port objects whose Width property complies with the Query.

Syntax

Width : Numeric_String
Width : Number

Example Usage

Width = '60'
Returns all port objects whose Width property is equal to 60.

Width Between '40' And '80'
Returns all port objects whose Width property is greater than or equal to 40 and less than or equal to 80.

Objectkind = 'Port' && Width >= 50
Returns all port objects whose Width property is greater than or equal to 50.

IsPort && Width < 70
Returns all port objects whose Width property is less than 70.

Width <> '40'
Returns all objects except port objects whose Width property is equal to 40.

IsPort && Width <> 40
Returns all port objects whose Width property is not equal to 40.

Notes

The Width property is only defined for port objects.