Skip to content

OnClearRow - cWebGrid

Triggered when the user performs a clear on a grid

Type: Event
Return Data Type: Boolean

Parameters

Parameter Type Description
sCurrentRowID String This is the row ID of the currently focused grid row

Syntax

Function OnClearRow String sCurrentRowID Returns Boolean

Description

The OnClearRow event is triggered when the user performs a clear on a grid or tries to change rows with pbAutoSave set to False. Implement this event to perform a custom clear action.

In a data-aware grid (pbDataAware = True), OnClearRow is triggered before the DataDictionary clear operation. If OnClearRow returns False, then the data dictionary clear operation is not performed.

In a non-data-aware grid (pbDataAware = False), use OnClearRow as your programming hook to perform the desired clear row action.

Return Value

Return False to cancel the clear action, otherwise return True. By default, this event returns True.