Sign in Join
FPDoc Onlineexperiment

TFieldGetTextEvent procedure type

In unit DB

Event handler to get field content.

Declaration

pascal
TFieldGetTextEvent = procedure(Sender: TField; var aText: string; 
 DisplayText: Boolean) of object

Arguments

Sender

Field instance whose text should be returned.

aText

The result of the event handler should be returned in this parameter.

DisplayText

Is the result used for display purposes ?

Description

TFieldGetTextEvent is the prototype for the OnGetText event handler. It should be used when the text of a field requires special formatting. The event handler should return the contents of the field in formatted form in the AText parameter. The DisplayText is True if the text is used for displaying purposes or is False if it will be used for editing purposes.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.