schHiDeleteSheet

schHiDeleteSheet(
[ ?startSheet n_startSheet ]
[ ?endSheet n_endSheet ]
)
=> t

Description

Deletes a sheet or range of sheets from a multisheet schematic. Usable only when editing an index of a multisheet schematic. This function cannot be undone.

If you do not specify a start sheet number, the options form appears. If the end sheet value is equal to the start sheet, only one sheet is deleted. You are prompted to confirm the deletion before proceeding because the action cannot be undone.

Arguments

?startSheet n_startSheet
	First sheet number to delete. If you do not specify the end sheet, only the current sheet is deleted.
?endSheet n_endSheet	Last sheet number to delete.

Value Returned

Always returns t.

Examples

Deletes the fourth sheet. You are prompted to confirm the deletion.

schHiDeleteSheet( 4 )

Deletes the third, fourth, fifth, and sixth sheets. You are prompted to confirm the deletion.

schHiDeleteSheet( 3 6 )

Return to top