beautypg.com

Text.gettextstring() – Adobe Extending Flash Professional CS5 User Manual

Page 464

background image

442

EXTENDING FLASH PROFESSIONAL

Text object

Last updated 5/2/2011

Example
The following example gets the font size of the currently selected text field and shows it:

var TheTextSize = fl.getDocumentDOM().selection[0].getTextAttr("size");

fl.trace(TheTextSize);

The following example gets the text fill color of the selected text field:

var TheFill = fl.getDocumentDOM().selection[0].getTextAttr("fillColor");

fl.trace(TheFill);

The following example gets the size of the third character:

var Char3 = fl.getDocumentDOM().selection[0].getTextAttr("size", 2);

fl.trace(Char3);

The following example gets the color of the selected text field from the third through the eighth character:

fl.getDocumentDOM().selection[0].getTextAttr("fillColor", 2, 8);

text.getTextString()

Availability
Flash MX 2004.

Usage

text.getTextString([startIndex [, endIndex]])

Parameters

startIndex

An integer that specifies the index (zero-based) of the first character. This parameter is optional.

endIndex

An integer that specifies the end of the range of text, which starts from startIndex and goes up to, but does

not include, endIndex. This parameter is optional.

Returns
A string of the text in the specified range.

Description
Method; retrieves the specified range of text. If you omit the optional parameters startIndex and endIndex, the whole
text string is returned. If you specify only startIndex, the method returns the string starting at the index location and
ending at the end of the field. If you specify both startIndex and endIndex, the method returns the string starting from
startIndex and goes up to, but does not include, endIndex.

Example
The following example gets the character(s) from the fifth character through the end of the selected text field:

var myText = fl.getDocumentDOM().selection[0].getTextString(4);

fl.trace(myText);

The following example gets the fourth through the ninth characters starting in the selected text field:

var myText = fl.getDocumentDOM().selection[0].getTextString(3, 9);

fl.trace(myText);

This manual is related to the following products: