formattedHeight

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

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

get the formattedHeight of object

# Examples

set the height of field 1 to the formattedHeight of field 1 put the formattedHeight of the clickLine into selectedHeight get the formattedHeight of word 1 to 17 of field "Info"

# Description

Use the formattedHeight property to determine how much vertical space an object needs. For example, if your stack has a field whose contents change for each card, use the field formattedHeight property in an openCard handler to resize the field for its contents on each card.

If you specify a card or group, the formattedHeight reports the height 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 formattedHeight property reports the original un-scaled height of the image or movie.

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

The formattedHeight of a field is the amount of vertical space the field text requires, taking line breaks into account and including top and bottom margins.

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

# Tags

ui,

# See

- **keyword:** integer, image, field, card - **property:** formattedTop, visible, thumbSize, fixedLineHeight, margins - **command:** revChangeWindowSize, group - **function:** textHeightSum - **glossary:** object, property, handler, current card, chunk - **object:** stack, field