schSetTextDisplayBBox

schSetTextDisplayBBox( 
d_tdId 
d_instId 
)
=> t / nil

Description

Sets or updates the value of a bounding box that encloses a given textDisplay object. A text display object displays the string or value based on derived information; for example, the current value of a property. Accordingly, the software must update the bounding box that encloses the text display object when the derived string or value changes.

Arguments

d_tdId	ID of the text display object. A text display object has all the characteristics of a label, such as `fontStyle`, `fontHeight`, and `overBar`.
d_instId	ID of an instance when d_tdId is within the symbol cellview of the instance. You should set this argument to `nil` when d_tdId is in the current schematic.

Value Returned

`t`	Set or updated the value of a bounding box that encloses a given `textDisplay` object.
`nil`	Value setting or update was unsuccessful.

Examples

Sets the bounding box of the text display object as defined by tdId.

schSetTextDisplayBBox( tdId nil )

Sets the bounding box of the text display object as defined by both tdId and instId.

schSetTextDisplayBBox( tdId instId )

Return to top

Virtuoso Schematic Editor SKILL Functions ReferenceProduct Version IC23.1, November 2023