TCanvas.GetTextMetrics function

Declaration

function GetTextMetrics(out TM: TLCLTextMetric): Boolean; virtual

Arguments

Function result

Description

Calls RequiredState to check state flags for the canvas, and ensure that the Handle and the Font are valid. RequiredState raises an Exception if the Handle for the canvas is not valid.

Calls GetTextMetrics in the LCL interface to retrieve the ascender, descender, and height metrics for the canvas Handle. The values are assigned to members in the TM output argument.

The return value is True when text metrics were successfully retrieved from the widgetset.

See also

• TLCLTextMetric