User Guide

ManualsBrandsMacromedia ManualsOtherFLASH MX 2004-ACTIONSCRIPT LANGUAGE REFERENCE

881

882

883

884

885

886

887

888

889

890

890 Chapter 2: ActionScript Language Reference

TextField.hscroll

Availability

Flash Player 6.

Usage

my_txt.hscroll:Number

Returns

An integer.

Description

Property; indicates the current horizontal scrolling position. If the hscroll property is 0, the text

is not horizontally scrolled.

For more information on scrolling text, see “Creating scrolling text” in Using ActionScript in Flash.

The units of horizontal scrolling are pixels, while the units of vertical scrolling are lines.

Horizontal scrolling is measured in pixels because most fonts you typically use are proportionally

spaced; meaning, the characters can have different widths. Flash performs vertical scrolling by line

because users usually want to see a line of text in its entirety, as opposed to seeing a partial line.

Even if there are multiple fonts on a line, the height of the line adjusts to fit the largest font in use.

Note: The hscroll property is zero-based—not one-based like the vertical scrolling property

TextField.scroll.

Example

The following example scrolls the my_txt text field horizontally using two buttons called

scrollLeft_btn and scrollRight_btn. The amount of scroll displays in a text field called

scroll_txt. Add the following ActionScript to your FLA or AS file:

this.createTextField("scroll_txt", this.getNextHighestDepth(), 10, 10, 160,

20);

this.createTextField("my_txt", this.getNextHighestDepth(), 10, 30, 160, 22);

my_txt.border = true;

my_txt.multiline = false;

my_txt.wordWrap = false;

my_txt.text = "Lorem ipsum dolor sit amet, consectetuer adipiscing...";

scrollLeft_btn.onRelease = function() {

my_txt.hscroll -= 10;

scroll_txt.text = my_txt.hscroll+" of "+my_txt.maxhscroll;

};

scrollRight_btn.onRelease = function() {

my_txt.hscroll += 10;

scroll_txt.text = my_txt.hscroll+" of "+my_txt.maxhscroll;

};