TextSnapshot.getText()

可用性

创作:Flash MX 2004。

回放:为 Flash Player 6 或更高版本发布的 SWF 文件,在 Flash Player 7 或更高版本中播放。

用法

mySnapshot.getText(from, to [, includeLineEndings ] )

参数

from 一个整数,指示要包括在返回的字符串中的 my_snap 第一个字符的位置。from 的有效值为 0 到 TextSnapshot.getCount() - 1。如果 from 为负值,则使用 0。 

to 一个整数,为 1+ 要检查的 my_snap 中最后一个字符的索引。to 的有效值为 0 到
TextSnapshot.getCount()。提取出来的字符串中不包括由 to 参数索引指定的字符。如果省略了此参数,则使用 TextSnapshot.getCount()。如果此值小于或等于 from 的值,则使用 from+1

includeLineEndings 一个可选布尔值,该值指定是否在返回的字符串中的适当位置插入换行符。默认值为 false

返回

一个包含指定范围中字符的字符串,如果指定范围中未找到任何字符,则为空字符串。

说明

方法;返回一个字符串,该字符串包含 fromto 参数指定的所有字符。如果未选择任何字符,则返回空字符串。

若要返回所有字符,则为 from 传递值 0,为 to 传递 TextSnapshot.getCount()(或任何一个非常大的数字)。若要返回单个字符,则为 to 传递值 from+1

如果为 includeLineEndings 传递值 true,则在返回的字符串中认为适当的位置插入换行符。在这种情况下,返回字符串可能比输入范围要长。如果 includeLineEndingsfalse 或被省略,则返回所选的文本,不添加任何字符。

另请参见

TextSnapshot.getSelectedText()