FMX.Graphics.TCanvas.FillText

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure FillText(const ARect: TRectF; const AText: string; const WordWrap: Boolean; const AOpacity: Single;  const Flags: TFillTextFlags; const ATextAlign: TTextAlign; const AVTextAlign: TTextAlign = TTextAlign.Center); virtual;

C++

virtual void __fastcall FillText(const System::Types::TRectF &ARect, const System::UnicodeString AText, const bool WordWrap, const float AOpacity, const TFillTextFlags Flags, const Fmx::Types::TTextAlign ATextAlign, const Fmx::Types::TTextAlign AVTextAlign = (Fmx::Types::TTextAlign)(0x0));

Properties

Type Visibility Source Unit Parent
procedure
function
public
FMX.Graphics.pas
FMX.Graphics.hpp
FMX.Graphics TCanvas

Description

Displays a text string on a specified rectangle area of the current TCanvas.

FillText is implemented by the TCanvas descendants to display a text string with the specified alignment, current font, and brush specified by the Fill and Font properties. The text is displayed in a specified rectangle area of the current TCanvas.

ARect specifies the rectangle area where the text is displayed.

AText specifies the text to display.

WordWrap specifies the word wrapping option. If it is True, it indicates that words are broken across lines to avoid text overflowing the layout box. If it is set to False, it indicates that words are kept within the same line even when the text overflows the layout box.

AOpacity specifies the transparency of the Fill color. AOpacity takes values between 0 and 1. If AOpacity is 1, the text is completely opaque; if it is 0, the text is completely transparent. The values over 1 are treated as 1, and the ones under 0 are treated as 0.

Flags specifies the reading direction of AText. For more information, see FMX.Graphics.TFillTextFlag.

ATextAlign is the horizontal alignment of the text within ARect.

AVTextAlign is the vertical alignment of the text within ARect. AVTextAlign is optional. By default, it is set to Center.

See Also

Code Examples