Class

# DBKit.Toolbar

<div class="rst-class">

forsearch

</div>

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 <span class="title-ref">DBKit.Toolbar</span> itself are described here; for the inherited members, see `the parent class<dbkit.toolbar.seealso>`.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                     | Type                               | Read-Only | Shared |
|----------------------------------------------------------|------------------------------------|-----------|--------|
| `BackButton<dbkit.toolbar.backbutton>`                   | `Boolean</api/data_types/boolean>` |           |        |
| `BackButtonCaption<dbkit.toolbar.backbuttoncaption>`     | `String</api/data_types/string>`   |           |        |
| `DeleteButton<dbkit.toolbar.deletebutton>`               | `Boolean</api/data_types/boolean>` |           |        |
| `DeleteButtonCaption<dbkit.toolbar.deletebuttoncaption>` | `String</api/data_types/string>`   |           |        |
| `DeleteRelatedRows<dbkit.toolbar.deleterelatedrows>`     | `Boolean</api/data_types/boolean>` |           |        |
| `DoneButtonCaption<dbkit.toolbar.donebuttoncaption>`     | `String</api/data_types/string>`   |           |        |
| `EditButton<dbkit.toolbar.editbutton>`                   | `Boolean</api/data_types/boolean>` |           |        |
| `EditButtonCaption<dbkit.toolbar.editbuttoncaption>`     | `String</api/data_types/string>`   |           |        |
| `NewButton<dbkit.toolbar.newbutton>`                     | `Boolean</api/data_types/boolean>` |           |        |
| `NewButtonCaption<dbkit.toolbar.newbuttoncaption>`       | `String</api/data_types/string>`   |           |        |
| `UndoButton<dbkit.toolbar.undobutton>`                   | `Boolean</api/data_types/boolean>` |           |        |
| `UndoButtonCaption<dbkit.toolbar.undobuttoncaption>`     | `String</api/data_types/string>`   |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                     | Parameters | Returns                          | Shared |
|------------------------------------------|------------|----------------------------------|--------|
| `Constructor<dbkit.toolbar.constructor>` |            |                                  |        |
| `TableName<dbkit.toolbar.tablename>`     |            | `String</api/data_types/string>` |        |

## Events

<div class="rst-class">

table-centered_column_4

</div>

| Name                                           | Parameters                                   | Returns |
|------------------------------------------------|----------------------------------------------|---------|
| `RowChanged<dbkit.toolbar.rowchanged>`         | row As `DBKit.Row</api/databases/dbkit/row>` |         |
| `RowCreated<dbkit.toolbar.rowcreated>`         | row As `DBKit.Row</api/databases/dbkit/row>` |         |
| `RowDeleted<dbkit.toolbar.rowdeleted>`         | row As `DBKit.Row</api/databases/dbkit/row>` |         |
| `RowEditing<dbkit.toolbar.rowediting>`         | row As `DBKit.Row</api/databases/dbkit/row>` |         |
| `RowLoaded<dbkit.toolbar.rowloaded>`           | row As `DBKit.Row</api/databases/dbkit/row>` |         |
| `RowNotSelected<dbkit.toolbar.rownotselected>` |                                              |         |
| `RowSaved<dbkit.toolbar.rowsaved>`             | row As `DBKit.Row</api/databases/dbkit/row>` |         |
| `RowSaving<dbkit.toolbar.rowsaving>`           | row As `DBKit.Row</api/databases/dbkit/row>` |         |
| `RowUndone<dbkit.toolbar.rowundone>`           | row As `DBKit.Row</api/databases/dbkit/row>` |         |

## Property descriptions

<div id="dbkit.toolbar.backbutton">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.BackButton

**BackButton** As `Boolean</api/data_types/boolean>`

> If `True</api/language/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</api/language/false>`.
>
> <div class="important">
>
> <div class="title">
>
> Important
>
> </div>
>
> This property is only available in web projects.
>
> </div>

<div id="dbkit.toolbar.backbuttoncaption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.BackButtonCaption

**BackButtonCaption** As `String</api/data_types/string>`

> The caption for the Back toolbar button.
>
> The default is "Back".

<div id="dbkit.toolbar.deletebutton">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.DeleteButton

**DeleteButton** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, a Delete button is added to the toolbar. Pressing it asks for confirmation and deletes the current row.
>
> The default is `False</api/language/false>`.

<div id="dbkit.toolbar.deletebuttoncaption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.DeleteButtonCaption

**DeleteButtonCaption** As `String</api/data_types/string>`

> The caption for the Delete toolbar button.
>
> The default is "Delete".

<div id="dbkit.toolbar.deleterelatedrows">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.DeleteRelatedRows

**DeleteRelatedRows** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, deleting a row also deletes its related rows.
>
> The default is `True</api/language/true>`.

<div id="dbkit.toolbar.donebuttoncaption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.DoneButtonCaption

**DoneButtonCaption** As `String</api/data_types/string>`

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

<div id="dbkit.toolbar.editbutton">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.EditButton

**EditButton** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, an Edit button is added to the toolbar. Pressing it puts the current row into edit mode.
>
> The default is `False</api/language/false>`.

<div id="dbkit.toolbar.editbuttoncaption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.EditButtonCaption

**EditButtonCaption** As `String</api/data_types/string>`

> The caption for the Edit toolbar button.
>
> The default is "Edit".

<div id="dbkit.toolbar.newbutton">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.NewButton

**NewButton** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, a New button is added to the toolbar. Pressing it creates a new row.
>
> The default is `False</api/language/false>`.

<div id="dbkit.toolbar.newbuttoncaption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.NewButtonCaption

**NewButtonCaption** As `String</api/data_types/string>`

> The caption for the New toolbar button.
>
> The default is "New".

<div id="dbkit.toolbar.undobutton">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.UndoButton

**UndoButton** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, an Undo button is added to the toolbar. Pressing it undoes the changes made to the current row.
>
> The default is `False</api/language/false>`.

<div id="dbkit.toolbar.undobuttoncaption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.UndoButtonCaption

**UndoButtonCaption** As `String</api/data_types/string>`

> The caption for the Undo toolbar button.
>
> The default is "Undo".

## Method descriptions

<div id="dbkit.toolbar.constructor">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.Constructor

**Constructor**()

> Called when the toolbar is created. The Delete, New, Undo, and Edit buttons are added automatically according to the `DeleteButton<dbkit.toolbar.deletebutton>`, `NewButton<dbkit.toolbar.newbutton>`, `UndoButton<dbkit.toolbar.undobutton>`, and `EditButton<dbkit.toolbar.editbutton>` properties.

<div id="dbkit.toolbar.tablename">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.TableName

**TableName**() As `String</api/data_types/string>`

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

## Event descriptions

<div id="dbkit.toolbar.rowchanged">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowChanged

**RowChanged**(row As `DBKit.Row</api/databases/dbkit/row>`)

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

<div id="dbkit.toolbar.rowcreated">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowCreated

**RowCreated**(row As `DBKit.Row</api/databases/dbkit/row>`)

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

<div id="dbkit.toolbar.rowdeleted">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowDeleted

**RowDeleted**(row As `DBKit.Row</api/databases/dbkit/row>`)

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

<div id="dbkit.toolbar.rowediting">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowEditing

**RowEditing**(row As `DBKit.Row</api/databases/dbkit/row>`)

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

<div id="dbkit.toolbar.rowloaded">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowLoaded

**RowLoaded**(row As `DBKit.Row</api/databases/dbkit/row>`)

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

<div id="dbkit.toolbar.rownotselected">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowNotSelected

**RowNotSelected**

> There is no row currently selected.

<div id="dbkit.toolbar.rowsaved">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowSaved

**RowSaved**(row As `DBKit.Row</api/databases/dbkit/row>`)

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

<div id="dbkit.toolbar.rowsaving">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowSaving

**RowSaving**(row As `DBKit.Row</api/databases/dbkit/row>`)

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

<div id="dbkit.toolbar.rowundone">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

DBKit.Toolbar.RowUndone

**RowUndone**(row As `DBKit.Row</api/databases/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     |

<div id="dbkit.toolbar.seealso">

<div class="seealso">

`DesktopToolbar</api/user_interface/desktop/desktoptoolbar>` parent class; `DBKit.Row</api/databases/dbkit/row>` class.

</div>

</div>