gpeInsertEmptyRows

gpeInsertEmptyRows(
u_sandbox
t_direction
x_startRow
[ ?count n_count ]
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Inserts empty rows in the specified Modgen sandbox object in the specified direction, starting at the specified row.

Arguments

u_sandbox	Specifies the Modgen sandbox object in which empty rows must be inserted.
t_direction	Specifies the direction in which the additional rows must be inserted relative to the start row. Valid options are top and bottom.
x_startRow	Specifies the reference row for inserting new rows. New rows are inserted above or below the reference row. The row indexes start at 0.
?count n_count	Specifies the number of rows to be inserted. The default value is 1.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

t	Empty rows were inserted as specified.
nil	The command was unsuccessful.

Examples

Inserts 5 empty rows below the last row.

sbox = [create and populate a sandbox]

gpeInsertEmptyRows(sbox "top" difference(gpeGetGridRowCount(sbox) 1) ?count 5)

Inserts 5 empty rows above the first row.

gpeInsertEmptyRows(sbox "bottom" 0 ?count 5)

Inserts 1 empty row above the fourth row, between the rows indexed as 2 and 3.

;; (index 3 is the 4th row)

gpeInsertEmptyRows(sbox "bottom" 3)

Inserts 1 empty row below the third row, between the rows indexed as 2 and 3.

;; (index 2 is the 3rd row)

gpeInsertEmptyRows(sbox "top" 2)

Inserts 1 empty row above the fourth row.

gpeInsertEmptyRows(sbox "bottom" 3)

Inserts 1 empty row above the fourth row, but suppresses the error messages.

gpeInsertEmptyRows(sbox "bottom" 3 ?verbose nil)

Return to top