Vcl.Graphics.TCustomCanvas.TextFlags

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property TextFlags: Longint read FTextFlags write FTextFlags;

C++

__property int TextFlags = {read=FTextFlags, write=FTextFlags, nodefault};

Properties

Type Visibility Source Unit Parent
property public
Vcl.Graphics.pas
Vcl.Graphics.hpp
Vcl.Graphics TCustomCanvas

Description

Specifies how text is written to the canvas.

Use TextFlags to influence the way text is drawn when calling the TextOut or TextRect method. TextFlags is an integer made by combining any of the following constants:



Constant Meaning

ETO_CLIPPED

Only the text that fits within a specified rectangle is displayed. This flag is automatically added when calling the TextRect method. When writing text using the TextOut method, this flag has no effect because the drawing boundaries are determined by the TextExtent property.

ETO_OPAQUE

The text is drawn with an opaque background color. Using this flag improves performance but does not allow images behind the text rectangle to display.

ETO_RTLREADING

Text strings are displayed from right to left. This is available only with Mideast versions of Windows, where text is written from right to left. Often this is used in combination with a CanvasOrientation property of coRightToLeft.

ETO_GLYPH_INDEX

The text is an array of character placement codes that are parsed directly by the Windows GDI. Glyph indexing only applies to TrueType fonts, but the flag can be used with other fonts to indicate that the GDI should process the text string directly without language processing. See the Windows GDI documentation for more details.

ETO_IGNORELANGUAGE

This is an undocumented Microsoft flag. Check the updates of the Microsoft documentation, where the information will be provided.

ETO_NUMERICSLOCAL

All numbers in the text are displayed using digits specific to the current locale.

ETO_NUMERICSLATIN

All numbers in the text are displayed using European digits.

ETO_PDY

This flag is only relevant when using the Windows API ExtTextOut. When this is set, the array pointed to by lpDx contains pairs of values. The first value of each pair is, as usual, the distance between origins of adjacent character cells, but the second value is the displacement along the vertical direction of the font.



See Also