| パッケージ | flash.text |
| クラス | public class TextSnapshot |
| 継承 | TextSnapshot  Object |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
TextSnapshot オブジェクトはコンストラクターを使用して作成するのではなく、flash.display.DisplayObjectContainer.textSnapshot プロパティで取得します。
関連する API エレメント
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
| charCount : int [読み取り専用]
TextSnapshot オブジェクト内の文字数です。 | TextSnapshot | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| メソッド | 定義元 | ||
|---|---|---|---|
指定された TextSnapshot オブジェクト内を検索し、最初に（または beginIndex の後に）見つかった textToFind の位置を返します。 | TextSnapshot | ||
選択されたテキストが TextSnapshot オブジェクトの指定範囲に存在するかどうかを表すブール値を返します。 | TextSnapshot | ||
対応する setSelected() メソッドで指定されたすべての文字を含むストリングを返します。 | TextSnapshot | ||
beginIndex パラメーターと endIndex パラメーターで指定されたすべての文字を含むストリングを返します。 | TextSnapshot | ||
連続したテキストに関する情報を含むオブジェクトの配列を返します。 | TextSnapshot | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
TextSnapshot オブジェクト内のどの文字が、そのテキストを含むムービークリップの指定 x、y 座標上またはその付近に存在するかを評価できます。 | TextSnapshot | ||
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
setSelected() メソッドで選択された文字を強調表示するときに使用する色を指定します。 | TextSnapshot | ||
選択または選択解除する TextSnapshot オブジェクトの文字範囲を指定します。 | TextSnapshot | ||
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
charCount | プロパティ |
findText | () | メソッド |
public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
指定された TextSnapshot オブジェクト内を検索し、textToFind の位置について、最初または beginIndex の後に見つかった位置を返します。textToFind が見つからなかった場合は、-1 を返します。
パラメーター
beginIndex:int — 指定されたテキストを検索する開始ポイントを指定します。
| |
textToFind:String — 検索対象のテキストを指定します。String 型の変数ではなく、ストリングリテラルを指定する場合は、その文字列を引用符で囲む必要があります。
| |
caseSensitive:Boolean — textToFind で検索する際に大文字と小文字を区別するかどうかを指定します。
|
int — 指定されたテキストが最初に見つかった位置を示す、0 から始まるインデックス位置、または -1 です。
|
関連する API エレメント
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 に指定します。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 です。
|
関連する API エレメント
getSelectedText | () | メソッド |
public function getSelectedText(includeLineEndings:Boolean = false):String| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0, Flash Player 9., Flash Lite 4 |
対応する setSelected() メソッドで指定されたすべての文字を含むストリングを返します。setSelected() メソッドで文字が指定されない場合は、空のストリングが返されます。
true を includeLineEndings に指定した場合は、返されるストリングに改行文字（newline）が挿入され、返されるストリングは入力範囲よりも長くなる場合があります。includeLineEndings に false を指定した場合、または省略した場合は、何の文字も追加されずに選択されたテキストが返されます。
パラメーター
includeLineEndings:Boolean (default = false)false です。
|
String — 対応する setSelected() コマンドで指定されたすべての文字を含むストリングです。
|
関連する API エレメント
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 に指定します。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)true）、または挿入しないか（false）を指定します。このパラメーターはオプションです。デフォルト値は false です。
|
String — 指定された範囲の文字を含むストリング。指定された範囲に文字が存在しない場合は空のストリングです。
|
関連する API エレメント
getTextRunInfo | () | メソッド |
public function getTextRunInfo(beginIndex:int, endIndex:int):Array| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0, Flash Player 9, Flash Lite 4 |
連続したテキストに関する情報を含むオブジェクトの配列を返します。各オブジェクトは、2 つのメソッドパラメーターで指定した文字範囲内の 1 つの文字に対応します。
注意：大きな範囲のテキストに対して getTextRunInfo() メソッドを使用すると、大きなオブジェクトを返すことができます。beginIndex パラメーターおよび endIndex パラメーターで定義するテキスト範囲を制限することをお勧めします。
パラメーター
beginIndex:int — TextSnapshot オブジェクト内の文字範囲内の最初の文字を示すインデックス値です。
| |
endIndex:int — TextSnapshot オブジェクト内の文字範囲内の最後の文字を示すインデックス値です。
|
Array — beginIndex パラメーターおよび endIndex パラメーターで指定された文字の範囲内の特定の文字に関する情報が含まれる個々のオブジェクトで構成されたオブジェクトの配列です。各オブジェクトには、次の 11 個のプロパティがあります。
|
関連する API エレメント
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 上またはその付近に存在するかを評価します。
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 を返します。
|
関連する API エレメント
setSelectColor | () | メソッド |
public function setSelectColor(hexColor:uint = 0xFFFF00):void| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | AIR 1.0, Flash Player 9., Flash Lite 4 |
setSelected() メソッドで選択された文字を強調表示するときに使用する色を指定します。色は常に不透明になります。透明度値を指定することはできません。
このメソッドは、文字メトリック情報を含むフォントを使用する場合にのみ正常に機能します。ただし、デフォルトでは、Flash オーサリングツールの静止テキストフィールドにこの情報は含まれません。したがって、インデックス値の代わりに -1 が返されます。インデックス値が返されるように、Flash オーサリングツールで強制的にフォントの文字メトリック情報を含めることができます。これを行うには、そのフォントを使用するダイナミックテキストフィールドを追加して、そのダイナミックテキストフィールドの「文字オプション」を選択し、フォントのアウトラインの埋め込みを 1 つ以上の文字に対して指定します。どの文字を指定しても問題ありません。また、静止テキストフィールドでその文字が使用されていてもかまいません。
パラメーター
hexColor:uint (default = 0xFFFF00)setSelected() コマンドで選択された文字の境界に使用する色です。16 進数形式（0xRRGGBB）で指定します。
|
関連する API エレメント
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 に指定します。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 です。
|
関連する API エレメント
Tue Jun 12 2018, 10:34 AM Z