Livecode Wiki
Advertisement

Reports the width needed by an object to display its full contents without scrolling.

Syntax:

get the formattedWidth of [<chunk> of] <field>

Examples:

if the formattedWidth of this card > the width of this card then beep

Use the formattedWidth property to adjust an object's size according to the space needed to display its contents.

If you specify a card or group, the formattedWidth reports the width of a rectangle that includes all objects in that card or group whose visible property is true.

If you specify an image or player, the formattedWidth property reports the original unscaled width of the image or movie.

If you specify a field, the formattedWidth reports the width required by the field's text. If the field's dontWrap property is set to true, the formattedWidth reports the total width of the text in the field. If the dontWrap is false, the formattedWidth reports the minimum width required to keep the current line breaks.

If you specify an object in a group, the value reported is the formattedWidth that object requires for the current card, so if you want to get the formattedWidth of a field's text on a certain card, you must go to that card first.

The formattedWidth of a field is the amount of horizontal space the field's text requires, taking line breaks into account and including left and right margins.

The formattedWidth of a chunk in a field is the amount of horizontal space that portion of the field's text requires, taking line breaks into account but disregarding margins.

See also: textHeightSum (function), field (object), stack (object), dontWrap (property), visible (property), thumbSize (property), margins (property)

Advertisement