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

leHiDescend

leHiDescend( 
[ w_windowId ] 
[ t_mode ]
) 
=> t / nil

Description

Lets you push down one level into the design hierarchy. You can preselect the instance to descend into. If no instances are selected, you are prompted to select an instance. If you do not specify w_windowId, the layout editor uses the current window.

If the master cell of the selected instance has more than one cellview available, the function must determine which cellview to descend into. If the Prompt For View Name field is not set, or if there is only one view available, you descend into the cellview that has been instantiated. If more than one view is available, and the Prompt For View Name field is set, a form is displayed containing a cyclic field with all the possible view names listed. You can then select the cellview to descend into.

When the t_mode argument is not specified, automatically selects the edit mode to use when descending into the hierarchy. If the current cellview is opened in edit mode, the new cellview is opened in edit mode; if the new cellview cannot be opened in edit mode, it is opened in read mode. If the current cellview is opened in read mode, the new cellview is opened in read mode.

Arguments

w_windowId

ID for the specified window; defaults to current window.

t_mode

Optional text string specifying the mode in which to open the selected instance. When "nil", the instance is opened in the same mode as its parent. When "read", the instance is opened in read mode. When "edit", the instance is opened in edit mode if its parent is open in edit mode; otherwise, a window pops up stating that the instance cannot be opened in edit mode and advising that you open it in read mode.
Valid Values: edit, read, nil.

Value Returned

t

The instance was opened successfully.

nil

The instance was not opened successfully.

Return to top
 ⠀
X