FontOperationTextLayoutBoundsOnCanvas

Type

operator

Summary

Measure text when drawn to a canvas.

Syntax

the [ layout ] bounds of text <mText> on <mCanvas>

Description

The layout bounds of the text, constructed from the ascent and descent values of the font, and the width of the text string.

note

The layout bounds is used to position blocks of text relative to each other, so the text may overlap these bounds.

Parameters

Name	Type	Description
mText		An expression which evaluates to a string.
mCanvas		An expression which evaluates to a canvas.

Examples

// Set the canvas font
set the font of this canvas to font "Arial" at size 18

variable tBounds as Rectangle
put the bounds of text "Sample text" on this canvas into tBounds

Value

Name	Type	Description
return		The bounding box of mText when drawn at point 0,0 with the current font of mCanvas. Returns the bounds as a rectangle.