flash.text.TextSnapshot (ActionScript 3.0)

	プロパティ	定義元
		charCount : int [read-only] TextSnapshot オブジェクト内の文字数です。	TextSnapshot
		constructor : Object 特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	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 オブジェクト内のどの文字が、そのテキストを含むムービークリップの指定 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
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

プロパティの詳細

charCount

プロパティ

charCount:int [read-only]

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9

TextSnapshot オブジェクト内の文字数です。

実装
public function get charCount():int

関連項目

flash.text.TextSnapshot.getText()

メソッドの詳細

findText

()

メソッド

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

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9

指定された TextSnapshot オブジェクト内を検索し、textToFind の位置について、最初または beginIndex の後に見つかった位置を返します。textToFind が見つからなかった場合は、-1 を返します。

パラメータ

	`beginIndex:int` — 指定されたテキストを検索する開始ポイントを指定します。

	`textToFind:String` — 検索対象のテキストを指定します。ストリング型の変数ではなく、ストリング自体を指定する場合は、その文字列を引用符で囲む必要があります。

	`caseSensitive:Boolean` — `textToFind` で検索する際に大文字と小文字を区別するかどうかを指定します。

戻り値

int — 指定されたテキストが最初に見つかった位置を示す 0 から始まるインデックス位置または -1 です。

関連項目

flash.text.TextSnapshot.getText()

getSelected

()

メソッド

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

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9

選択されたテキストが TextSnapshot オブジェクトの指定範囲に存在するかどうかを表すブール値を返します。

すべての文字を検索するには、0 を start に指定し、charCount (または十分に大きな数値) を end に指定します。1 つの文字だけを検索する場合は、end パラメータに対して、start パラメータに 1 を加えた値を指定します。

パラメータ

	`beginIndex:int` — 検査を開始する文字の位置を示します。`beginIndex` に指定できる値は、`0` ～ `TextSnapshot.charCount - 1` です。`beginIndex` が負の値の場合、`0` が使用されます。

	`endIndex:int` — 検査する最後の文字のインデックスに 1 を加えた値です。`endIndex` に指定できる値は、`0` ～ `charCount` です。`endIndex` パラメータで指定されたインデックス位置の文字は、抽出されるストリングには含まれません。このパラメータを省略すると、`charCount` が使用されます。この値が `beginIndex` に指定された値と同じか小さい場合、`beginIndex + 1` が使用されます。

戻り値

Boolean — 指定された範囲の少なくとも 1 文字が、対応する setSelected() メソッドで選択されているかどうかを示すブール値です。選択されている場合は true、選択されていない場合は false です。

getSelectedText

()

メソッド

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

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9.

対応する setSelected() メソッドで指定されたすべての文字を含むストリングを返します。setSelected() メソッドで文字が指定されない場合は、空のストリングが返されます。

true を includeLineEndings に指定した場合は、返されるストリングに改行文字 (newline) が挿入され、返されるストリングは入力範囲よりも長くなる場合があります。includeLineEndings に false を指定した場合、または省略した場合は、何の文字も追加されずに選択されたテキストが返されます。

パラメータ

includeLineEndings:Boolean (default = false) — ブール値です。戻り値のストリングの適切な箇所に、改行文字 (newline) を挿入するかどうかを指定します。このパラメータはオプションです。デフォルト値は false です。

戻り値

String — 対応する setSelected() コマンドで指定されたすべての文字を含むストリングです。

getText

()

メソッド

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

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9.

beginIndex パラメータと endIndex パラメータで指定されたすべての文字を含むストリングを返します。文字が選択されていない場合は、空のストリングが返されます。

すべての文字を取得するには、0 を beginIndex に指定し、charCount (または十分に大きな数値) を endIndex に指定します。1 つの文字だけを返す場合は、beginIndex + 1 を endIndex に指定します。

true を includeLineEndings に指定した場合は、返されたストリングの適当な位置に改行文字 (newline) が挿入されます。この場合、返されるストリングは、入力範囲よりも長くなる場合があります。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`) — ブール値です。戻り値のストリングに改行文字 (newline) を挿入するか (`true`)、または挿入しないか (`false`) を指定します。このパラメータはオプションです。デフォルト値は `false` です。

戻り値

String — 指定された範囲の文字を含むストリング。指定された範囲に文字が存在しない場合は空のストリングです。

getTextRunInfo

()

メソッド

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

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9

連続したテキストに関する情報を含むオブジェクトの配列を返します。各オブジェクトは、2 つのメソッドパラメータで指定した文字範囲内の 1 つの文字に対応します。

メモ : 大きな範囲のテキストに対して getTextRunInfo() メソッドを使用すると、大きなオブジェクトを返すことができます。beginIndex パラメータおよび endIndex パラメータで定義するテキスト範囲を制限することをお勧めします。

パラメータ

	`beginIndex:int` — TextSnapshot オブジェクト内の文字範囲内の最初の文字を示すインデックス値です。

	`endIndex:int` — TextSnapshot オブジェクト内の文字範囲内の最後の文字を示すインデックス値です。

戻り値

Array — beginIndex パラメータおよび endIndex パラメータで指定された文字の範囲内の特定の文字に関する情報が含まれる個々のオブジェクトで構成されたオブジェクトの配列です。各オブジェクトには、次の 11 個のプロパティがあります。

indexInRun : その文字のインデックス。選択されているテキスト範囲ではなく、ストリング全体を基準とした 0 から始まる整数のインデックスです。
selected : 文字が選択されるかどうかを示すブール値。選択される場合は true、選択されない場合は false です。
font : その文字のフォント名です。
color : その文字のカラーとアルファ (透明度) の値の組み合わせです。16 進数の最初の 2 桁はアルファ値を表し、残りの桁はカラー値を表します。
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 ファイルに埋め込まれている場合にのみ使用できます。

関連項目

Matrix クラス

hitTestTextNearPos

()

メソッド

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

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9.

TextSnapshot オブジェクト内のどの文字が、TextSnapshot オブジェクトのテキストを含むムービークリップの指定座標 x、y 上またはその付近に存在するかを評価します。

0 を maxDistance に指定する場合、またはその指定を省略する場合、x、y 座標で指定される位置は、TextSnapshot オブジェクトの境界ボックス内にある必要があります。

このメソッドは、文字メトリック情報を含むフォントを使用する場合にのみ正常に機能します。ただし、デフォルトでは、Flash オーサリングツールの静止テキストフィールドにこの情報は含まれません。したがって、インデックス値の代わりに -1 が返されます。インデックス値が返されるように、Flash オーサリングツールで強制的にフォントの文字メトリック情報を含めることができます。これを行うには、そのフォントを使用するダイナミックテキストフィールドを追加して、そのダイナミックテキストフィールドの [文字オプション] を選択し、フォントのアウトラインの埋め込みを 1 つ以上の文字に対して指定します。埋め込みをどの文字に指定するか、対象となる静止テキストフィールドでその文字が使用されているかは関係ありません。

パラメータ

	`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

Player のバージョン :

Flash Player 9.

setSelected() メソッドで選択された文字を強調表示するときに使用する色を指定します。常に不透明色が使用されます。透明度値を指定することはできません。

パラメータ

hexColor:uint (default = 0xFFFF00) — 対応する setSelected() コマンドで選択された文字の境界に使用する色です。16 進数形式 (0xRRGGBB) で指定します。

関連項目

flash.text.TextSnapshot.setSelected()

setSelected

()

メソッド

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

言語バージョン :

ActionScript 3.0

Player のバージョン :

Flash Player 9.

選択または選択解除する TextSnapshot オブジェクトの文字範囲を指定します。選択された文字は、文字の境界ボックスに合わせて背景色付きの矩形で描画されます。境界ボックスの色は、setSelectColor() で定義されます。

すべての文字を選択または選択解除するには、0 を beginIndex に指定し、charCount (または十分に大きな数値) を endIndex に指定します。1 つの文字だけを指定する場合は、start + 1 を endIndex に指定します。

文字の選択状態は個々にマーキングされるため、このメソッドを何回か呼び出すことで、複数の文字を選択できます。つまり、このメソッドを使用しても、既にこのメソッドで選択されている他の文字は選択解除されません。

選択範囲を示す色付きの矩形は、文字メトリック情報を含むフォントに対してのみ表示されます。デフォルトでは、静止テキストフィールドにはこの情報は含まれません。これが原因で、選択されたテキストが画面に選択状態で表示されない場合があります。選択されたテキスト全体が選択状態で表示されるように、Flash オーサリングツールで強制的にフォントの文字メトリック情報を含めることができます。これを行うには、そのフォントを使用するダイナミックテキストフィールドを追加して、そのダイナミックテキストフィールドの [文字オプション] を選択し、フォントのアウトラインの埋め込みを 1 つ以上の文字に対して指定します。どの文字を指定しても、静止テキストフィールドでその文字が使用されていてもかまいません。

パラメータ

	`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` です。

現在のページ: http://livedocs.adobe.com/flash/9.0_jp/ActionScriptLangRefV3/flash/text/TextSnapshot.html

ActionScript 3.0 コンポーネントリファレンスガイド		すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレームフレームなし
TextSnapshot	プロパティ \| メソッド

パッケージ	flash.text
クラス	public class TextSnapshot
継承	TextSnapshot Object