Class

DBKit.Toolbar

Description

Can display buttons that allow the user to delete, edit, undo changes and create new rows.

The buttons act on the current row of the layout's table.

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

Properties

Name	Type	Read-Only
BackButton	Boolean
BackButtonCaption	String
DeleteButton	Boolean
DeleteButtonCaption	String
DeleteRelatedRows	Boolean
DoneButtonCaption	String
EditButton	Boolean
EditButtonCaption	String
NewButton	Boolean
NewButtonCaption	String
UndoButton	Boolean
UndoButtonCaption	String

Methods

Name	Parameters	Returns
Constructor
TableName		String

Events

Name	Parameters	Returns
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.Toolbar.BackButton

BackButton As Boolean

If True, a Back button is added to the toolbar. Pressing it closes the current page. It is edit-aware: the button is disabled while a row is being edited.

The default is False.

Important

This property is only available in web projects.

DBKit.Toolbar.BackButtonCaption

BackButtonCaption As String

The caption for the Back toolbar button.

The default is "Back".

DBKit.Toolbar.DeleteButton

DeleteButton As Boolean

If True, a Delete button is added to the toolbar. Pressing it asks for confirmation and deletes the current row.

The default is False.

DBKit.Toolbar.DeleteButtonCaption

DeleteButtonCaption As String

The caption for the Delete toolbar button.

The default is "Delete".

DBKit.Toolbar.DeleteRelatedRows

DeleteRelatedRows As Boolean

If True, deleting a row also deletes its related rows.

The default is True.

DBKit.Toolbar.DoneButtonCaption

DoneButtonCaption As String

The caption shown on the Edit toolbar button while a row is being edited or is newly created.

The default is "Done".

DBKit.Toolbar.EditButton

EditButton As Boolean

If True, an Edit button is added to the toolbar. Pressing it puts the current row into edit mode.

The default is False.

DBKit.Toolbar.EditButtonCaption

EditButtonCaption As String

The caption for the Edit toolbar button.

The default is "Edit".

DBKit.Toolbar.NewButton

NewButton As Boolean

If True, a New button is added to the toolbar. Pressing it creates a new row.

The default is False.

DBKit.Toolbar.NewButtonCaption

NewButtonCaption As String

The caption for the New toolbar button.

The default is "New".

DBKit.Toolbar.UndoButton

UndoButton As Boolean

If True, an Undo button is added to the toolbar. Pressing it undoes the changes made to the current row.

The default is False.

DBKit.Toolbar.UndoButtonCaption

UndoButtonCaption As String

The caption for the Undo toolbar button.

The default is "Undo".

Method descriptions

DBKit.Toolbar.Constructor

Constructor()

Called when the toolbar is created. The Delete, New, Undo, and Edit buttons are added automatically according to the DeleteButton, NewButton, UndoButton, and EditButton properties.

DBKit.Toolbar.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.Toolbar.RowChanged

RowChanged(row As DBKit.Row)

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

DBKit.Toolbar.RowCreated

RowCreated(row As DBKit.Row)

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

DBKit.Toolbar.RowDeleted

RowDeleted(row As DBKit.Row)

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

DBKit.Toolbar.RowEditing

RowEditing(row As DBKit.Row)

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

DBKit.Toolbar.RowLoaded

RowLoaded(row As DBKit.Row)

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

DBKit.Toolbar.RowNotSelected

RowNotSelected

There is no row currently selected.

DBKit.Toolbar.RowSaved

RowSaved(row As DBKit.Row)

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

DBKit.Toolbar.RowSaving

RowSaving(row As DBKit.Row)

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

DBKit.Toolbar.RowUndone

RowUndone(row As DBKit.Row)

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

Notes

Dark mode

DBKit.Toolbar supports dark mode. Dark mode icons are included in the Icons folder, so make sure you copy them into your project. The example windows show how to refresh the toolbar button icons in the Paint event.

Compatibility

Project Types	Desktop
Operating Systems	All