TextSnapshot - Adobe ActionScript® 3 (AS3 ) API 参考

包	flash.text
类	public class TextSnapshot
继承	TextSnapshot Object

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9, Flash Lite 4

TextSnapshot 对象可用于处理影片剪辑中的静态文本。例如，您可以使用 TextSnapshot 对象用高于动态文本所允许的精度对文本进行布局，但仍以只读方式访问该文本。

您不必使用构造函数即可创建 TextSnapshot 对象；它由 flash.display.DisplayObjectContainer.textSnapshot 属性返回。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		charCount : int [只读] TextSnapshot 对象中的字符数。	TextSnapshot
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int 搜索指定的 TextSnapshot 对象，并返回在 beginIndex 位置或其后找到的 textToFind 的第一个匹配项的位置。	TextSnapshot
		getSelected(beginIndex:int, endIndex:int):Boolean 返回一个布尔值，该值指定 TextSnapshot 对象是否包含指定范围内的所选文本。	TextSnapshot
		getSelectedText(includeLineEndings:Boolean = false):String 返回一个字符串，其中包含对应的 setSelected() 方法指定的所有字符。	TextSnapshot
		getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String 返回一个字符串，其中包含 beginIndex 和 endIndex 参数指定的所有字符。	TextSnapshot
		getTextRunInfo(beginIndex:int, endIndex:int):Array 返回包含关于文本运行信息的对象的数组。	TextSnapshot
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number 用于确定 TextSnapshot 对象中哪个字符位于包含 TextSnapshot 对象中文本的影片剪辑的指定的 x, y 坐标上或位于该坐标的附近。	TextSnapshot
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		setSelectColor(hexColor:uint = 0xFFFF00):void 指定当突出显示使用 setSelected() 方法选择的字符时要使用的颜色。	TextSnapshot
		setSelected(beginIndex:int, endIndex:int, select:Boolean):void 指定 TextSnapshot 对象中要选择或取消选择的字符范围。	TextSnapshot
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object

属性详细信息

charCount

属性

charCount:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9, Flash Lite 4

TextSnapshot 对象中的字符数。

实现
public function get charCount():int

相关 API 元素

flash.text.TextSnapshot.getText()

方法详细信息

findText

()

方法

public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9, Flash Lite 4

搜索指定的 TextSnapshot 对象，并返回在 beginIndex 位置或其后找到的 textToFind 的第一个匹配项的位置。如果未找到 textToFind，则该方法返回 -1。

参数

	`beginIndex:int` — 指定起始点以搜索指定文本。

	`textToFind:String` — 指定要搜索的文本。如果指定的是字符串文本，而不是 String 类型的变量，请用引号将字符串括起来。

	`caseSensitive:Boolean` — 指定文本是否必须与 `textToFind` 中的字符串大小写相匹配。

int — 指定文本的第一个匹配项从零开始的索引位置或 -1。

相关 API 元素

flash.text.TextSnapshot.getText()

getSelected

()

方法

public function getSelected(beginIndex:int, endIndex:int):Boolean

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9, Flash Lite 4

返回一个布尔值，该值指定 TextSnapshot 对象是否包含指定范围内的所选文本。

要搜索全部字符，请将值 0 传递给 start，并将 charCount（或任何非常大的数字）传递给 end。要搜索一个字符，请传递给 end 参数一个比 start 参数大 1 的值。

参数

	`beginIndex:int` — 表示要检查的第一个字符的位置。`beginIndex` 的有效值为 `0` 到 `TextSnapshot.charCount - 1`。如果 `beginIndex` 是一个负值，则使用 `0`。

	`endIndex:int` — 比要检查的最后一个字符的索引大 1 的一个值。`endIndex` 的有效值为 `0` 到 `charCount`。由 `endIndex` 参数索引的字符未包括在已提取的字符串中。如果省略此参数，则使用 `charCount`。如果此值小于等于 `beginIndex` 的值，则使用 `beginIndex + 1`。

Boolean — 一个布尔值，表示对应的 setSelected() 方法是否已选择了给定范围内的至少一个字符，如果选择了字符，则为 true；否则为 false。

getSelectedText

()

方法

public function getSelectedText(includeLineEndings:Boolean = false):String

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9., Flash Lite 4

返回一个字符串，其中包含对应的 setSelected() 方法指定的所有字符。如果没有指定任何字符（由 setSelected() 方法指定），则返回一个空字符串。

如果将 true 传递给 includeLineEndings，则换行符将插入到返回字符串中，因此该返回字符串可能比输入范围长。如果 includeLineEndings 为 false 或被省略，则该方法返回没有添加任何字符的选定文本。

参数

includeLineEndings:Boolean (default = false) — 一个可选的布尔值，用于指定是否将换行符插入到返回字符串中的合适位置。默认值为 false。

String — 一个字符串，其中包含对应的 setSelected() 命令指定的所有字符。

getText

()

方法

public function getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9., Flash Lite 4

返回一个字符串，其中包含 beginIndex 和 endIndex 参数指定的所有字符。如果没有选择任何字符，则返回一个空字符串。

要返回全部字符，请将值 0 传递给 beginIndex，并将 charCount（或任何非常大的数字）传递给 endIndex。要返回单个字符，请将值 beginIndex + 1 传递给 endIndex。

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

参数

	`beginIndex:int` — 表示要包括在返回字符串中的第一个字符的位置。`beginIndex` 的有效值为 `0` 到 `charCount - 1`。如果 `beginIndex` 是一个负值，则使用 `0`。

	`endIndex:int` — 比要检查的最后一个字符的索引大 1 的一个值。`endIndex` 的有效值为 `0` 到 `charCount`。由 `endIndex` 参数索引的字符未包括在已提取的字符串中。如果省略此参数，则使用 `charCount`。如果此值小于等于 `beginIndex` 的值，则使用 `beginIndex + 1`。

	`includeLineEndings:Boolean` (default = `false`) — 一个可选的布尔值，指定是将换行符插入到返回的字符串中 (`true`)，还是不插入到返回的字符串中 (`false`)。默认值为 `false`。

String — 一个包含指定范围内字符的字符串，如果在指定范围内未找到任何字符，则为一个空字符串。

getTextRunInfo

()

方法

public function getTextRunInfo(beginIndex:int, endIndex:int):Array

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9, Flash Lite 4

返回包含关于文本运行信息的对象的数组。每个对象都与两个方法参数指定的字符范围中的一个字符相对应。

注意：对于大范围的文本，使用 getTextRunInfo() 方法可以返回一个较大的对象。Adobe 建议限制由 beginIndex 和 endIndex 参数定义的文本范围。

参数

	`beginIndex:int` — TextSnapshot 对象中字符范围内第一个字符的索引值。

	`endIndex:int` — TextSnapshot 对象中字符范围内最后一个字符的索引值。

Array — 一个对象数组，其中的每个对象都包含有关由 beginIndex 和 endIndex 参数指定的字符范围中特定字符的信息。每个对象都包含以下 11 种属性：

indexInRun：字符相对于整个字符串（而不是相对于所选运行文本）的从零开始的整数索引。
selected：一个布尔值，表示是否选中字符。如果选中，则该值为 true；否则为 false。
font：字符的字体名称。
color：字符的 Alpha 和颜色的合并值。前两个十六进制数字表示 Alpha 值，其余数字表示颜色值。
height：字符的高度，以像素为单位。
matrix_a、matrix_b、matrix_c、matrix_d、matrix_tx 和 matrix_ty：矩阵的值，该矩阵对字符定义几何转换。通常，立式文本始终具有形式为 [1 0 0 1 x y] 的矩阵，其中 x 和 y 是字符在父级影片剪辑内的位置，与文本的高度无关。该矩阵位于父级影片剪辑坐标系统中，并且不包括对影片剪辑本身（或其父级）的任何转换。
corner0x、corner0y、corner1x、corner1y、corner2x、corner2y、corner3x 和 corner3y：字符边框的各个角，以父级影片剪辑的坐标系统为基础。这些值仅在字符使用的字体嵌入到 SWF 文件时可用。

相关 API 元素

Matrix 类

hitTestTextNearPos

()

方法

public function hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9., Flash Lite 4

用于确定 TextSnapshot 对象中哪个字符位于包含 TextSnapshot 对象中文本的影片剪辑的指定的 x, y 坐标上或位于该坐标的附近。

如果省略 maxDistance 或为其传递值 0，则由 x, y 坐标指定的位置必须位于 TextSnapshot 对象的边框内。

此方法仅适用于包括字符度量信息的字体；但是，默认情况下，Flash 创作工具不包含静态文本字段的这种信息。因此，该方法可能会返回 -1 而不是索引值。为了确保返回索引值，您可以强制使 Flash 创作工具包括字体的字符度量信息。为此，请添加一个使用此字体的动态文本字段，为该动态文本字段选择“字符选项”，然后指定至少为一个字符嵌入该字体轮廓。（这与所指定的字符以及是否在静态文本字段中使用这些字符没有关系。）

参数

	`x:Number` — 一个数字，表示包含文本的影片剪辑的 `x` 坐标。

	`y:Number` — 一个数字，表示包含文本的影片剪辑的 `y` 坐标。

	`maxDistance:Number` (default = `0`) — 一个可选数字，表示距 `x`, `y`（搜索其可查找文本）的最远距离。此距离是从每个字符的中心点开始测量的。默认值为 `0`。

Number — 一个数字，表示最接近指定 x, y 坐标的字符的索引值。如果未找到任何字符，或者字体不包含字符度量信息，则返回 -1。

setSelectColor

()

方法

public function setSelectColor(hexColor:uint = 0xFFFF00):void

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9., Flash Lite 4

指定当突出显示使用 setSelected() 方法选择的字符时要使用的颜色。该颜色始终是不透明的；您不能指定透明值。

参数

hexColor:uint (default = 0xFFFF00) — 用于字符（这些字符已被对应的 setSelected() 命令选中）旁边边框的颜色，以十六进制格式 (0xRRGGBB) 表示。

相关 API 元素

flash.text.TextSnapshot.setSelected()

setSelected

()

方法

public function setSelected(beginIndex:int, endIndex:int, select:Boolean):void

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9., Flash Lite 4

指定 TextSnapshot 对象中要选择或取消选择的字符范围。被选中的字符的后面绘制有一个带颜色的矩形，与字符的边框匹配。边框的颜色由 setSelectColor() 定义。

要选择或取消选择所有字符，请将值 0 传递给 beginIndex，并将 charCount（或任何一个非常大的数字）传递给 endIndex。要指定单个字符，请将值 start + 1 传递给 endIndex。

因为在选择时，字符是单个地进行标记的，所以您可以多次调用此方法以选择多个字符；也就是说，使用此方法不会取消选择已由此方法设置的其他字符。

只针对包含字符度量信息的字体显示表明选中的彩色矩形；默认情况下，Flash 不包含静态文本字段的这种信息。在某些情况下，此行为意味着选中的文本在屏幕上不会显示为已选中。为了确保所有选中的文本都显示为已选中，您可以强制使 Flash 创作工具包括字体的字符度量信息。为此，请添加一个使用此字体的动态文本字段，为该动态文本字段选择“字符选项”，然后指定至少为一个字符嵌入该字体轮廓。这与所指定的字符以及是否在所述静态文本字段中使用这些字符没有关系。

参数

	`beginIndex:int` — 表示要选择的第一个字符的位置。`beginIndex` 的有效值为 `0` 到 `charCount - 1`。如果 `beginIndex` 是一个负值，则使用 `0`。

	`endIndex:int` — 一个整数，它等于要检查的最后一个字符的索引加 1。`end` 的有效值为 `0` 到 `charCount`。由 `end` 参数索引的字符未包括在已提取的字符串中。如果省略此参数，则使用 `TextSnapshot.charCount`。如果 `beginIndex` 的值小于等于 `endIndex` 的值，则使用 `beginIndex + 1`。

	`select:Boolean` — 一个布尔值，指定是应该选择文本 (`true`)，还是应该取消选择文本 (`false`)。

法律声明 | 在线隐私策略

TextSnapshot - AS3

包x

语言元素

附录

包 flash.text

charCount

findText

getSelected

getSelectedText

getText

getTextRunInfo

hitTestTextNearPos

setSelectColor

setSelected