Class

DBKit.NumberLabel

DBKit.NumberLabel


Description

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

It displays numeric values.

The value is formatted according to the control's Type, ThousandsSeparator and DecimalPlaces.

Only the members declared by DBKit.NumberLabel itself are described here. The members it inherits from DBKit.Label are also listed below and are documented on the DBKit.Label page.

Properties

Name

Type

Read-Only

DecimalPlaces

Integer

DefaultValue

Double

Format

String

Number

Double

ThousandsSeparator

Boolean

Type

NumberTypes

ColumnName

String

DisplayName

String

InvalidValueMessage

String

Mandatory

Boolean

Text

String

Methods

Name

Parameters

Returns

NumericTypeFormat

String

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

Enumerations

DBKit.NumberLabel.NumberTypes

NumberTypes

The type of number displayed by the control.

Types

Number

Currency

Percentage

Custom

Number displays the value as a plain number. Currency displays the value as currency. Percentage displays the value as a percentage. Custom displays the value using a custom format.

Property descriptions


DBKit.NumberLabel.DecimalPlaces

DecimalPlaces As Integer

The number of decimal places displayed for the value.


DBKit.NumberLabel.DefaultValue

DefaultValue As Double

The default value of the field.


DBKit.NumberLabel.Format

Format As String

A custom format string used to display the value when Type is set to Custom.


DBKit.NumberLabel.Number

Number As Double

The numeric value displayed by the control. Assign a value to display it formatted according to the control's Type, ThousandsSeparator and DecimalPlaces.


DBKit.NumberLabel.ThousandsSeparator

ThousandsSeparator As Boolean

If True, the value is displayed with thousands separators.


DBKit.NumberLabel.Type

Type As NumberTypes

The type of number displayed by the control.

Method descriptions


DBKit.NumberLabel.NumericTypeFormat

NumericTypeFormat() As String

The format string used to display the value, derived from Type, ThousandsSeparator and DecimalPlaces.

Notes

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, Web

Operating Systems

All

See also

DBKit.Label parent class; DBKit.Row class.