Product Documentation
Virtuoso Schematic Editor SKILL Functions Reference
Product Version IC23.1, November 2023

schHiCopy

schHiCopy( 
[ ?formFlag g_formFlag ]
[ ?rows x_numrows ]
[ ?columns x_numcols ]
[ ?useSelSet t_useSelSet ] 
)
=> t

Description

Copies objects and data such as object properties. Objects can be copied between different schematic cellviews. Usable when editing schematics or symbols.

If the selected set contains multiple objects, you are prompted to click a reference point.

If the schematic cellview object selection set (schSelSet) contains partially selected objects, these objects will be excluded from the selection set to be copied.

Arguments

?formFlag g_formFlag

Specifies whether or not to bring up the options form. A t displays the options form. A nil copies any selected object using default values set on the form.

?rows x_numrows

Number of rows to generate. Range is limited by the system.
If x_numrows is greater than 1, you are prompted to select a destination for the first copy in the second row. The schematic editor calculates the offsets for placing the remaining elements of the array. The resultant objects are copies of the original and are not stored as an array. x_numrows resets to 1 when you complete the copy.
Default: 1

?columns x_numcols

Number of columns to generate. Range is limited by the system. If x_numcols is greater than 1, you are prompted to click at a location for the second copy in the first row. The schematic editor calculates the offsets for placing the remaining elements of the array. The resultant objects are copies of the original and are not stored as an array. x_numcols resets to 1 when you complete the copy.
Default: 1

?useSelSet t_useSelSet

Specifies whether to copy the entire selected set or only the object you select with the mouse; must be enclosed in quotation marks. If you set this argument to noSelSet, any previously selected objects are ignored and the function is nonmodal. If you set the argument to useSelSet, any previously selected objects are used and the function is nonmodal; otherwise, the function is modal and prompts you for objects to copy.
Valid Values: useSelSet, noSelSet
Default: useSelSet

Value Returned

Always returns t.

Examples

Makes six copies of objects you select and calculates the placement of each object according to your selected destination point of the first copy in the second row and the second copy in the first row. The nil value does not bring up the options form but uses the current field values.

schHiCopy( ?formFlag nil ?rows 2 ?columns 3 )
Displays the options form you use to specify the values for your copy.
schHiCopy( ?formFlag t )
Ignores the selected set and prompts you to select the object to copy.
schHiCopy( ?formFlag nil ?rows 1 ?columns 1 ?useSelSet "noSelSet" )

Return to top
 ⠀
X