Class

DBKit.TextArea

Description

Can display and edit the column value of the current row of the database table to which it has been assigned.

It displays and edits the column value as multi-line text.

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

Properties

Name	Type	Read-Only
ColumnName	String
DisplayName	String
InvalidValueMessage	String
Mandatory	Boolean

Methods

Name	Parameters	Returns
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.TextArea.ColumnName

ColumnName As String

The name of the database column whose value this control displays and edits.

If blank, the control's name is used as the column name. The name may be qualified with a table name (for example "tablename.columnname") when the control shows a column from a related table.

DBKit.TextArea.DisplayName

DisplayName As String

A user-friendly name for the control, shown to the user in place of the column name (for example in the InvalidValueMessage).

DBKit.TextArea.InvalidValueMessage

InvalidValueMessage As String

The message displayed when the control is mandatory but has no value. Use <$1> as a placeholder for the control's display name.

The default is "<$1> must have a value."

DBKit.TextArea.Mandatory

Mandatory As Boolean

If True, the control must have a value before the row can be saved. When a row is saved while a mandatory control is empty, the InvalidValueMessage is displayed and the save is cancelled.

Method descriptions

DBKit.TextArea.TableName

TableName() As String

Returns the name of the database table the control's column belongs to. If the ColumnName is qualified with a table name (for example "tablename.columnname"), that table name is returned; otherwise the table is resolved from the control's layout.

Event descriptions

DBKit.TextArea.RowChanged

RowChanged(row As DBKit.Row)

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

DBKit.TextArea.RowCreated

RowCreated(row As DBKit.Row)

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

DBKit.TextArea.RowDeleted

RowDeleted(row As DBKit.Row)

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

DBKit.TextArea.RowEditing

RowEditing(row As DBKit.Row)

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

DBKit.TextArea.RowLoaded

RowLoaded(row As DBKit.Row)

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

DBKit.TextArea.RowNotSelected

RowNotSelected

There is no row currently selected.

DBKit.TextArea.RowSaved

RowSaved(row As DBKit.Row)

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

DBKit.TextArea.RowSaving

RowSaving(row As DBKit.Row)

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

DBKit.TextArea.RowUndone

RowUndone(row As DBKit.Row)

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

Notes

Read-only instead of disabled

When a row is displayed but not being edited, the control remains enabled but is read-only. It is only disabled when no row is selected.

Localization

Localize the control's user-facing text (InvalidValueMessage) the standard Xojo way: assign a dynamic constant to each property and provide translations for as many languages as you need, or localize the property values directly.

Compatibility

Project Types	Desktop
Operating Systems	All