Class

DBKit.EditButton

Description

Allows the user to edit the current row of the database table assigned to it.

When the button is pressed, the current row enters edit mode and the button's caption changes from EditCaption to DoneCaption. Pressing the button again saves the row and restores the caption.

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

Properties

Name	Type	Read-Only	Shared
DoneCaption	String
EditCaption	String

Methods

Name	Parameters	Returns	Shared
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.EditButton.DoneCaption

DoneCaption As String

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

The default is "Done".

DBKit.EditButton.EditCaption

EditCaption As String

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

The default is "Edit".

Method descriptions

DBKit.EditButton.TableName

TableName() As String

Returns the name of the database table for this control: the table name of the control's layout.

Event descriptions

DBKit.EditButton.Error

Error() As String

A DatabaseException occurred when the control attempted to edit or save 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.EditButton.RowChanged

RowChanged(row As DBKit.Row)

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

DBKit.EditButton.RowCreated

RowCreated(row As DBKit.Row)

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

DBKit.EditButton.RowDeleted

RowDeleted(row As DBKit.Row)

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

DBKit.EditButton.RowEditing

RowEditing(row As DBKit.Row)

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

DBKit.EditButton.RowLoaded

RowLoaded(row As DBKit.Row)

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

DBKit.EditButton.RowNotSelected

RowNotSelected

There is no row currently selected.

DBKit.EditButton.RowSaved

RowSaved(row As DBKit.Row)

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

DBKit.EditButton.RowSaving

RowSaving(row As DBKit.Row)

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

DBKit.EditButton.RowUndone

RowUndone(row As DBKit.Row)

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

Notes

Editing Table rows

The button edits the layout's current row. Editing the selected row of a Table that displays rows from a related many table is not supported.

Compatibility

Project Types	Desktop, Web
Operating Systems	All