Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

pteSetAllValidity

pteSetAllValidity(
[ ?mode { Display | Selection | Propagate } ]
[ ?only { t | nil } ]
[ ?panel { Layers | Objects | Grids } ]
[ ?window w_windowId ]
)
=> t / nil

Description

Sets as valid the specified items in the specified Palette panel.

Arguments

?mode

Scope of execution of the command.

Valid values:

  • Display: All items displayed in the specified Palette panel are set as valid. If the parent and child items in the Objects and Grids panels are in a desynchronized state, only the parent items are set as valid.
  • Selection: Only the items selected in the specified Palette panel are set as valid.
    The Selection option is applicable when multi-select mode is selected in Palette Options form or it is enabled using the environment variable, pteMultiSelectionMode. This lets you select multiple LPPs in the Layers panel using the CTRL + LMB or Shift + LMB after an initial LMB click on an LPP. The Selection mode in the active command applies to the selected LPPs Layers panel.
  • Propagate: Both parent and child items in the specified Palette panel are set as valid. Use this mode only if the parent and child items in the Objects and Grids panels are in a desynchronized state.

?only

If set to t, only the items corresponding to the specified mode are set as valid.

?panel

Name of the Palette panel.
Valid values: Layers, Objects, and Grids
Default: The panel that is currently active. If none of the panels is active, the command is run on the Layers panel.

?window w_windowId

ID of the window containing the Palette that you want to update.
Valid values: ID of any open window
Default: Current window

Value Returned

t

The specified items were set as valid.

nil

The command was unsuccessful.

Examples

pteSetAllValidity(?panel "Layers")
pteSetAllValidity(?only t)
pteSetAllValidity(?mode "Display")
pteSetAllValidity(?window window(2))
pteSetAllValidity(?mode "Display" ?only t ?panel "Layers" ?window window(2))

Return to top
 ⠀
X