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

schHiCreateSheet

schHiCreateSheet(
[ ?number n_number ]
[ ?size t_size ]
[ ?type t_type ] 
)
=> t

Description

Creates a sheet for a multisheet schematic. Usable only when editing schematics.

If you do not supply all arguments, a form appears and prompts you to specify the appropriate values.

If you want to create a multisheet schematic from a nonmultisheet schematic, you are asked to confirm the conversion. The current schematic becomes the first sheet in the index, the created sheet becomes the second sheet, and an index is created. All appropriate properties in the index and on the sheet are updated.

Arguments

?number n_number

Number of the sheet to create. If the value is less than zero or specified as nil, the schematic editor generates a number based on the value of the last number in the multisheet schematic.

?size t_size

Size of the sheet to create; must be enclosed in quotation marks. If none is specified, the schematic editor creates a new sheet without a border. If nil is specified, the schematic editor designates the sheet size from a property on the index or it defaults to a standard size if the property does not exist.
Valid Values: A, B, C, D, E, F, A Book, none

?type t_type

Type of border; must be enclosed in quotation marks. A continue sheet border contains less information than the standard sheet border. If none is specified for t_size, t_type is ignored. If no type is specified, a basic sheet border is created.
Valid Values: basic, continue

Value Returned

Always returns t.

Examples

Creates sheet number three, with a C-sized continuation border, which becomes the current cellview.

schHiCreateSheet( 3 "C" "continue" )

Return to top
 ⠀
X