Class

DBKit.EditingButton

Description

Provides buttons that allow the user to edit the current row of a database table, delete the current row, undo changes to the current row, and create new rows.

Which buttons appear is controlled by the EditRow, DeleteRow, UndoRowChanges, and NewRow properties.

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

Properties

Name	Type	Read-Only	Shared
DeleteRelatedRows	Boolean
DeleteRow	Boolean
DoneCaption	String
EditCaption	String
EditRow	Boolean
NewRow	Boolean
TableName	String
UndoRowChanges	Boolean

Methods

Name	Parameters	Returns	Shared
TableName		String

Events

Name	Parameters	Returns
Error	buttonName As String	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.EditingButton.DeleteRelatedRows

DeleteRelatedRows As Boolean

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

The default is False.

DBKit.EditingButton.DeleteRow

DeleteRow As Boolean

If True, the control includes a button that deletes the current row.

The default is False.

DBKit.EditingButton.DoneCaption

DoneCaption As String

The caption displayed on the Edit button while the current row is being edited.

The default is "Done".

DBKit.EditingButton.EditCaption

EditCaption As String

The caption displayed on the Edit button when the current row is not being edited.

The default is "Edit".

DBKit.EditingButton.EditRow

EditRow As Boolean

If True, the control includes a button that edits the current row.

The default is False.

DBKit.EditingButton.NewRow

NewRow As Boolean

If True, the control includes a button that creates a new row.

The default is False.

DBKit.EditingButton.TableName

TableName As String

The name of the database table this control operates on.

DBKit.EditingButton.UndoRowChanges

UndoRowChanges As Boolean

If True, the control includes a button that undoes the changes made to the current row.

The default is False.

Method descriptions

DBKit.EditingButton.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.EditingButton.Error

Error(buttonName As String) As String

A DatabaseException occurred as a result of the user pressing the button whose name is passed to this event.

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.EditingButton.RowChanged

RowChanged(row As DBKit.Row)

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

DBKit.EditingButton.RowCreated

RowCreated(row As DBKit.Row)

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

DBKit.EditingButton.RowDeleted

RowDeleted(row As DBKit.Row)

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

DBKit.EditingButton.RowEditing

RowEditing(row As DBKit.Row)

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

DBKit.EditingButton.RowLoaded

RowLoaded(row As DBKit.Row)

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

DBKit.EditingButton.RowNotSelected

RowNotSelected

There is no row currently selected.

DBKit.EditingButton.RowSaved

RowSaved(row As DBKit.Row)

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

DBKit.EditingButton.RowSaving

RowSaving(row As DBKit.Row)

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

DBKit.EditingButton.RowUndone

RowUndone(row As DBKit.Row)

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

Notes

Working with Table rows

When the button's TableName matches the TableName of a Table on the layout, the delete and new buttons act on the Table's rows. Edit and undo for a Table displaying rows from a related many table are not supported.

Compatibility

Project Types	Desktop, Web
Operating Systems	All