Request_Delete - cCJGrid

Attempts to delete the current row

Syntax

Procedure Request_Delete

Call Example

Send Request_Delete

Description

Request_Delete attempts to delete the current row (SelectedRow). If the row is an existing row, a row delete is attempted by calling DeleteSelectedRow. If the row is a new row, it is removed by calling RemoveNewSelectedRow.

For various reasons, this operation may not succeed. This operation may be cancelled via user verification or the delete operation may not be allowed. If the operation fails or is cancelled, the global Err indicator is set to True; else Err will be False.

If the delete succeeds, the row below the deleted row will become the SelectedRow, unless the deleted row was the last row, in which case the row above becomes the SelectedRow.

If the grid is non-data aware (cCJGrid / cCJGridDataSource), a delete will remove the row datasource's array. If the grid is data aware (cDbCJGrid / cDbCJGridDataSource), the datasource will use the DataDictionary to perform the delete, which will result in the record being removed from the datasource and from the backend database.

Normally, Request_Delete is bound to the kDelete_Record (Shift+F2) accelerator key.

See DeleteSelectedRow for more about the row deletion process.