Schematic Object Type Checks Query Language Keywords in Altium Designer | Altium Designer 23 Technical Documentation

Created: May 8, 2023 | Updated: May 8, 2023

Applies to Altium Designer version: 23

Parent page: Schematic Capture Query Functions

The Object Type Checks schematic query functions shown in the Query Helper dialog

This reference page details the query language keywords from the Object Type Checks category available in schematic and schematic library documents in Altium Designer. For help on a specific query keyword, use the following collapsible sections or highlight (or click inside) any given keyword - in the Query Helper, or a Filter panel - and press F1 to access its section right away.

IsArc

Summary

Returns arc objects.

Syntax

IsArc : Boolean

Example Usage

IsArc
IsArc = True
Returns all arc objects.

Not IsArc
IsArc = False
Returns all objects except arc objects.

IsBezier

Summary

Returns Bezier objects.

Syntax

IsBezier : Boolean

Example Usage

IsBezier
IsBezier = True
Returns all Bezier objects.

Not IsBezier
IsBezier = False
Returns all objects except Bezier objects.

IsBlanket

Summary

Returns blanket objects.

Syntax

IsBlanket : Boolean/Boolean_String

Example Usage

IsBlanket
IsBlanket = True
IsBlanket = 'True'
Returns all blanket objects.

Not IsBlanket
IsBlanket = False IsBlanket = 'False'
Returns all objects except blanket objects.

IsBus

Summary

Returns bus objects.

Syntax

IsBus : Boolean

Example Usage

IsBus
IsBus = True
Returns all bus objects.

Not IsBus
IsBus = False
Returns all objects except bus objects.

IsBusEntry

Summary

Returns bus entry objects.

Syntax

IsBusEntry : Boolean

Example Usage

IsBusEntry
IsBusEntry = True
Returns all bus entry objects.

Not IsBusEntry
IsBusEntry = False
Returns all objects except bus entry objects.

IsComment

Summary

Returns parameter objects whose Parameter Name property is Comment – these are children of part objects.

Syntax

IsComment : Boolean

Example Usage

IsComment
IsComment = True
Returns all parameter objects whose Parameter Name property is Comment.

Not IsComment
IsComment = False
Returns all objects except parameter objects whose Parameter Name property is Comment.

IsCompileMask

Summary

Returns compile mask objects.

Syntax

IsCompileMask : Boolean/Boolean_String

Example Usage

IsCompileMask
IsCompileMask = True
IsCompileMask = 'True'
Returns all compile mask objects.

Not IsCompileMask
IsCompileMask = False IsCompileMask = 'False'
Returns all objects except compile mask objects.

IsDesignator

Summary

Returns designator objects – these are children of part objects.

Syntax

IsDesignator : Boolean

Example Usage

IsDesignator
IsDesignator = True
Returns all designator objects.

Not IsDesignator
IsDesignator = False
Returns all objects except designator objects.

IsEllipse

Summary

Returns ellipse objects.

Syntax

IsEllipse : Boolean

Example Usage

IsEllipse
IsEllipse = True
Returns all ellipse objects.

Not IsEllipse
IsEllipse = False
Returns all objects except ellipse objects.

IsEllipticalArc

Summary

Returns elliptical arc objects.

Syntax

IsEllipticalArc : Boolean

Example Usage

IsEllipticalArc
IsEllipticalArc = True
Returns all elliptical arc objects.

Not IsEllipticalArc
IsEllipticalArc = False
Returns all objects except elliptical arc objects.

IsHarnessConnector

Summary

Returns harness connector objects.

Syntax

IsHarnessConnector : Boolean/Boolean_String

Example Usage

IsHarnessConnector
IsHarnessConnector = True
IsHarnessConnector = 'True'
Returns all harness connector objects.

Not IsHarnessConnector
IsHarnessConnector = False IsHarnessConnector = 'False'
Returns all objects except harness connector objects.

IsHarnessConnectorType

Summary

Returns harness connector type objects.

Syntax

IsHarnessConnectorType : Boolean/Boolean_String

Example Usage

IsHarnessConnectorType
IsHarnessConnectorType = True
IsHarnessConnectorType = 'True'
Returns all harness connector type objects.

Not IsHarnessConnectorType
IsHarnessConnectorType = False IsHarnessConnectorType = 'False'
Returns all objects except harness connector type objects.

IsHarnessEntry

Summary

Returns harness entry objects.

Syntax

IsHarnessEntry : Boolean/Boolean_String

Example Usage

IsHarnessEntry
IsHarnessEntry = True
IsHarnessEntry = 'True'
Returns all harness entry objects.

Not IsHarnessEntry
IsHarnessEntry = False IsHarnessEntry = 'False'
Returns all objects except harness entry objects.

IsHyperlink

Summary

Returns hyperlink objects.

Hyperlink objects are deprecated. This type of object cannot be placed in new designs but are accessible if placed in documents created and saved in previous versions of Altium Designer.

Syntax

IsHyperlink : Boolean/Boolean_String

Example Usage

IsHyperlink
IsHyperlink = True
IsHyperlink = 'True'
Returns all hyperlink objects.

Not IsHyperlink
IsHyperlink = False IsHyperlink = 'False'
Returns all objects except hyperlink objects.

IsImage

Summary

Returns image objects.

Syntax

IsImage : Boolean

Example Usage

IsImage
IsImage = True
Returns all image objects.

Not IsImage
IsImage = False
Returns all objects except image objects.

IsJunction

Summary

Returns manual junction objects.

Manual junction objects are deprecated. This type of object cannot be placed in new designs but are accessible if placed in documents created and saved in previous versions of Altium Designer.

Syntax

IsJunction : Boolean

Example Usage

IsJunction
IsJunction = True
Returns all manual junction objects.

Not IsJunction
IsJunction = False
Returns all objects except manual junction objects.

IsLabel

Summary

Returns text string objects.

Syntax

IsLabel : Boolean

Example Usage

IsLabel
IsLabel = True
Returns all text string objects.

Not IsLabel
IsLabel = False
Returns all objects except text string objects.

IsNetLabel

Summary

Returns net label objects.

Syntax

IsNetLabel : Boolean

Example Usage

IsNetLabel
IsNetLabel = True
Returns all net label objects.

Not IsNetLabel
IsNetLabel = False
Returns all objects except net label objects.

IsNoERC

Summary

Returns No ERC objects.

Syntax

IsNoERC : Boolean/Boolean_String

Example Usage

IsNoERC
IsNoERC = True
IsNoERC = 'True'
Returns all No ERC objects.

Not IsNoERC
IsNoERC = False IsNoERC = 'False'
Returns all objects except No ERC objects.

IsNote

Summary

Returns note objects.

Syntax

IsNote : Boolean

Example Usage

IsNote
IsNote = True
Returns all note objects.

Not IsNote
IsNote = False
Returns all objects except note objects.

IsOffSheetConnector

Summary

Returns offsheet connector objects.

Syntax

IsOffSheetConnector : Boolean/Boolean_String

Example Usage

IsOffSheetConnector
IsOffSheetConnector = True
IsOffSheetConnector = 'True'
Returns all offsheet connector objects.

Not IsOffSheetConnector
IsOffSheetConnector = False IsOffSheetConnector = 'False'
Returns all objects except offsheet connector objects.

IsParameter

Summary

Returns parameter objects.

Syntax

IsParameter : Boolean

Example Usage

IsParameter
IsParameter = True
Returns all parameter objects.

Not IsParameter
IsParameter = False
Returns all objects except parameter objects.

IsParameterSet

Summary

Returns parameter set objects.

Syntax

IsParameterSet : Boolean/Boolean_String

Example Usage

IsParameterSet
IsParameterSet = True
IsParameterSet = 'True'
Returns all parameter set objects.

Not IsParameterSet
IsParameterSet = False IsParameterSet = 'False'
Returns all objects except parameter set objects.

IsPart

Summary

Returns part objects.

Syntax

IsPart : Boolean

Example Usage

IsPart
IsPart = True
Returns all part objects.

Not IsPart
IsPart = False
Returns all objects except part objects.

Notes

This function is an alias for the IsSchComponent function.

IsPie

Summary

Returns pie chart objects.

Pie chart objects are deprecated. This type of object cannot be placed in new designs but are accessible if placed in documents created and saved in previous versions of Altium Designer.

Syntax

IsPie : Boolean

Example Usage

IsPie
IsPie = True
Returns all pie chart objects.

Not IsPie
IsPie = False
Returns all objects except pie chart objects.

IsPin

Summary

Returns pin objects.

Syntax

IsPin : Boolean

Example Usage

IsPin
IsPin = True
Returns all pin objects.

Not IsPin
IsPin = False
Returns all objects except pin objects.

IsPolygon

Summary

Returns polygon objects.

Syntax

IsPolygon : Boolean

Example Usage

IsPolygon
IsPolygon = True
Returns all polygon objects.

Not IsPolygon
IsPolygon = False
Returns all objects except polygon objects.

IsPolyline

Summary

Returns line objects.

Syntax

IsPolyline : Boolean

Example Usage

IsPolyline
IsPolyline = True
Returns all line objects.

Not IsPolyline
IsPolyline = False
Returns all objects except line objects.

IsPort

Summary

Returns port objects.

Syntax

IsPort : Boolean

Example Usage

IsPort
IsPort = True
Returns all port objects.

Not IsPort
IsPort = False
Returns all objects except port objects.

IsPowerObject

Summary

Returns power port objects.

Syntax

IsPowerObject : Boolean

Example Usage

IsPowerObject
IsPowerObject = True
Returns all power port objects.

Not IsPowerObject
IsPowerObject = False
Returns all objects except power port objects.

IsProbe

Summary

Returns probe objects (probe and instrument probe design directives).

Syntax

IsProbe : Boolean/Boolean_String

Example Usage

IsProbe
IsProbe = True
IsProbe = 'True'
Returns all probe objects.

Not IsProbe
IsProbe = False IsProbe = 'False'
Returns all objects except probe objects.

IsRectangle

Summary

Returns rectangle objects.

Syntax

IsRectangle : Boolean

Example Usage

IsRectangle
IsRectangle = True
Returns all rectangle objects.

Not IsRectangle
IsRectangle = False
Returns all objects except rectangle objects.

IsRoundRectangle

Summary

Returns round rectangle objects.

Syntax

IsRoundRectangle : Boolean

Example Usage

IsRoundRectangle
IsRoundRectangle = True
Returns all round rectangle objects.

Not IsRoundRectangle
IsRoundRectangle = False
Returns all objects except round rectangle objects.

IsSchComponent

Summary

Returns part objects.

Syntax

IsSchComponent : Boolean

Example Usage

IsSchComponent
IsSchComponent = True
Returns all part objects.

Not IsSchComponent
IsSchComponent = False
Returns all objects except part objects.

Notes

This function is an alias for the IsPart function.

IsSelected

Summary

Returns all objects that are currently selected in the design space.

Syntax

IsSelected : Boolean

Example Usage

IsSelected
IsSelected = True
Returns all objects that are currently selected in the design space.

Not IsSelected
IsSelected = False
Returns all objects except objects that are currently selected in the design space.

IsSheetEntry

Summary

Returns sheet entry objects.

Syntax

IsSheetEntry : Boolean/Boolean_String

Example Usage

IsSheetEntry
IsSheetEntry = True
IsSheetEntry = 'True'
Returns all sheet entry objects.

Not IsSheetEntry
IsSheetEntry = False IsSheetEntry = 'False'
Returns all objects except sheet entry objects.

IsSheetFileName

Summary

Returns sheet file name objects, associated with sheet symbols, device sheet symbols, and managed sheet instance symbols.

Syntax

IsSheetFileName : Boolean/Boolean_String

Example Usage

IsSheetFileName
IsSheetFileName = True
IsSheetFileName = 'True'
Returns all sheet file name objects.

Not IsSheetFileName
IsSheetFileName = False IsSheetFileName = 'False'
Returns all objects except sheet file name objects.

IsSheetName

Summary

Returns sheet name objects, associated with sheet symbols, device sheet symbols, and managed sheet instance symbols.

Syntax

IsSheetName : Boolean/Boolean_String

Example Usage

IsSheetName
IsSheetName = True
IsSheetName = 'True'
Returns all sheet name objects.

Not IsSheetName
IsSheetName = False IsSheetName = 'False'
Returns all objects except sheet name objects.

IsSheetSymbol

Summary

Returns sheet symbol objects (sheet symbols, device sheet symbols, and managed sheet instance symbols).

Syntax

IsSheetSymbol : Boolean/Boolean_String

Example Usage

IsSheetSymbol
IsSheetSymbol = True
IsSheetSymbol = 'True'
Returns all sheet symbol objects.

Not IsSheetSymbol
IsSheetSymbol = False IsSheetSymbol = 'False'
Returns all objects except sheet symbol objects.

IsSignalHarness

Summary

Returns signal harness objects.

Syntax

IsSignalHarness : Boolean/Boolean_String

Example Usage

IsSignalHarness
IsSignalHarness = True
IsSignalHarness = 'True'
Returns all signal harness objects.

Not IsSignalHarness
IsSignalHarness = False IsSignalHarness = 'False'
Returns all objects except signal harness objects.

IsSymbol

Summary

Returns IEEE symbol objects.

Syntax

IsSymbol : Boolean

Example Usage

IsSymbol
IsSymbol = True
Returns all IEEE symbol objects.

Not IsSymbol
IsSymbol = False
Returns all objects except IEEE symbol objects.

IsTextFrame

Summary

Returns text frame objects.

Syntax

IsTextFrame : Boolean

Example Usage

IsTextFrame
IsTextFrame = True
Returns all text frame objects.

Not IsTextFrame
IsTextFrame = False
Returns all objects except text frame objects.

IsWire

Summary

Returns wire objects.

Syntax

IsWire : Boolean

Example Usage

IsWire
IsWire = True
Returns all wire objects.

Not IsWire
IsWire = False
Returns all objects except wire objects.