DimensionTextFormat

Parent page: PCB Query Functions - Fields

Summary

Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property complies with the Query.

Syntax

DimensionTextFormat = TextFormat_String
DimensionTextFormat <> TextFormat_String

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

• 'None'

Example Usage

DimensionTextFormat = 'None'
Returns all angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property is None (i.e. no values and units are displayed).

DimensionTextFormat <> 'None'
Returns all objects except angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects whose Dimension Format property is None (i.e. will return those applicable dimension objects whose format is set to show the value only, the value and units, or the value and units (with the latter in brackets)).

Tips

1. The single quote characters (') at the start and end of TextFormat_String are mandatory.
2. The Dimension Format property is only defined for angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects.
3. The child objects of angular dimension, baseline dimension, datum dimension, linear diameter dimension, linear dimension, radial diameter dimension, and radial dimension objects returned by the Query, are not returned.