schCreateSheet

schCreateSheet( 
d_cvId 
x_number 
t_borderLibrary 
t_borderCell 
t_borderView 
)
=> d_sheetInstId / nil

Description

Creates a new sheet for a multisheet schematic.

The schematic is generated based on the cell name of the index with the sheet number appended; for example, sheet003. A multisheet symbol is created with the msymbol view and an instance is placed in the index schematic.

If the source is not a multisheet schematic, it is converted into a multisheet schematic. An index is created, and the source becomes the specified sheet number in the multisheet design.

If the numbered sheet already exists, the new sheet is inserted before the existing sheet. The remaining sheets are renumbered. Also, if the sheet number is less than or equal to zero, a sheet number is generated based on the value of the last sheet number in the multisheet schematic.

When you specify the library, cell, and view of a sheet border master, a border instance is added to the new multisheet schematic.

Arguments

d_cvId	Cellview ID of the source editable schematic, which must be an index schematic or a nonsheet schematic cellview.
x_number	Number of the new sheet.
t_borderLibrary	Name of the library containing the sheet border master. If specified as an empty string or nil, the new sheet is created without a sheet border. Also used to specify the library containing the sheetSymbol to use when creating the sheet instance in the index schematic that represents the new sheet. If specified as an empty string or nil, each library in your cds.lib file is searched until a sheetSymbol cell that has an msymbol view is found.
t_borderCell	Cell name of the sheet border master. If specified as an empty string or as nil, the new sheet is created without a sheet border; must be enclosed in quotation marks.
t_borderView	View name of the sheet border master. If specified as an empty string or as nil, the new sheet is created without a sheet border; must be enclosed in quotation marks.

Value Returned

d_sheetInstId	The instance ID of the new sheet instance in the index schematic.
nil	Sheet creation was unsuccessful.

Examples

Creates sheet number 4, with an A-sized sheet border from the US_8ths library in the multisheet schematic defined by the given index schematic.

sheetInstId = schCreateSheet( indexId 4 "US_8ths" "Asize" "symbol" )

Converts an ordinary schematic into sheet 1 of a multisheet schematic and creates an index schematic with the same name as the original schematic. Searches each library specified in your cds.lib file until a sheetSymbol is found to create an instance representing the new sheet in the index schematic.

sheetInstId = schCreateSheet( cvId 1 "" "" "" )

Converts an ordinary schematic into sheet 2 of a multisheet schematic and creates an index schematic with the same name as the original schematic. A D-sized border is added to the converted schematic.

sheetInstId = schCreateSheet( cvId 2 "US_8ths" "Dsize" "symbol" )

Creates sheet number 4, without a sheet border, in the multisheet schematic defined by the given index schematic. Uses the sheetSymbol from the US_8ths library to create an instance representing the new sheet in the index schematic.

sheetInstId = schCreateSheet( indexID 4 "US_8th" "" "")

Return to top