Vcl.Graphics.TCanvas.TextExtent

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function TextExtent(const Text: string): TSize; override;

C++

virtual System::Types::TSize __fastcall TextExtent(const System::UnicodeString Text);

Properties

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

Description

Returns the width and height, in pixels, of a string rendered in the current font.

Use TextExtent to determine the space a string will occupy in the image. Other elements in the image such as lines, boxes, or additional lines of text can be positioned to accommodate the size of the text. TextExtent returns the width and height of the rectangle that bounds the text on the canvas.

To check only the height, call TextHeight. To check only the width, call TextWidth.

See Also