Class

DBKit.DeleteButton

Description

Deletes the current row of the database table assigned to the button.

When the button is pressed, the user is asked to confirm the deletion before the current row is deleted.

Only the members declared by DBKit.DeleteButton itself are described here; for the inherited members, see the parent classes.

Properties

Name	Type	Read-Only
DeleteRelatedRows	Boolean
TableName	String

Methods

Name	Parameters	Returns
TableName		String

Events

Name	Parameters	Returns
Error		String
RowChanged	row As DBKit.Row
RowCreated	row As DBKit.Row
RowDeleted	row As DBKit.Row
RowEditing	row As DBKit.Row
RowLoaded	row As DBKit.Row
RowNotSelected
RowSaved	row As DBKit.Row
RowSaving	row As DBKit.Row
RowUndone	row As DBKit.Row

Property descriptions

DBKit.DeleteButton.DeleteRelatedRows

DeleteRelatedRows As Boolean

If True, the rows related to the deleted row are deleted as well.

The default is False.

DBKit.DeleteButton.TableName

TableName As String

The name of the database table whose current row this button deletes.

Method descriptions

DBKit.DeleteButton.TableName

TableName() As String

Returns the name of the database table for this control: the TableName property if set, otherwise the table name of the control's layout.

Event descriptions

DBKit.DeleteButton.Error

Error() As String

A DatabaseException occurred when the control attempted to delete the current row.

Implement this event to display your own error message instead of DBKit's default message. Return the message to display, or return an empty string to display no message at all. If you do not implement this event, DBKit displays a default error message.

DBKit.DeleteButton.RowChanged

RowChanged(row As DBKit.Row)

The current row (passed to the event) has been changed.

DBKit.DeleteButton.RowCreated

RowCreated(row As DBKit.Row)

A new row (passed to the event) was just created and is now the current row.

DBKit.DeleteButton.RowDeleted

RowDeleted(row As DBKit.Row)

The current row (passed to the event) has been deleted.

DBKit.DeleteButton.RowEditing

RowEditing(row As DBKit.Row)

The current row (passed to the event) is being edited by the user.

DBKit.DeleteButton.RowLoaded

RowLoaded(row As DBKit.Row)

The current row (passed to the event) has been loaded.

DBKit.DeleteButton.RowNotSelected

RowNotSelected

There is no row currently selected.

DBKit.DeleteButton.RowSaved

RowSaved(row As DBKit.Row)

The current row (passed to the event) has been saved.

DBKit.DeleteButton.RowSaving

RowSaving(row As DBKit.Row)

The current row (passed to this event) is about to be saved.

DBKit.DeleteButton.RowUndone

RowUndone(row As DBKit.Row)

The changes made to the current row (passed to this event) have been undone.

Notes

Deleting Table rows

When the button's TableName matches the TableName of a Table on the layout, pressing the button deletes the Table's selected row instead of the layout's current row.

Compatibility

Project Types	Desktop, Web
Operating Systems	All