Sign in Join
FPDoc Onlineexperiment

TCanvas.TextOut procedure

Member of TCanvaspublicIn unit Graphics

Writes text at the specified position on the canvas.

Declaration

pascal
procedure TextOut(X: Integer; Y: Integer; const Text: string); virtual
 ; reintroduce

Arguments

X

Horizontal canvas coordinate where the text is written.

Y

Vertical canvas coordinate where the text is written.

Text

Values written in the text output operation.

Description

Writes the value in Text at the given X, Y coordinates on the canvas.

Calls Changing to signal the OnChanging event handler (when assigned). Calls RequiredState to ensure that handles for the canvas, Font, and Brush are valid.

Properties in TextStyle are converted and combined into the numeric flag used to format the Text, including Opaque and RightToLeft. Uses ExtUTF8Out to write to the device context using the position and style flags needed.

The Pen is positioned at the end of the Text when the output operation is completed. The vertical canvas coordinate is not altered in the method. In other words, TextOut does not handle multi-line text or word wrapping of the value in Text.

TextOut calls Changed to signal the OnChange event handler (when assigned).

See also

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