パッケージmx.controls.textClasses
public class TextRange
継承TextRange Inheritance Object

TextRange クラスは、Label、Text、TextArea、TextEditor、および RichTextEditor コントロール内のテキストを一定の範囲で選択し、フォーマットするプロパティを提供します。

関連項目

mx.controls.Label
mx.controls.RichTextEditor
mx.controls.Text
mx.controls.TextArea
mx.controls.TextInput
flash.text.TextFormatAlign


パブリックプロパティ
 プロパティ定義
  beginIndex : int
コントロールのテキストフィールド内の 0 ベースインデックスで、範囲内の最初の文字を示します。
TextRange
  bullet : Boolean
範囲内のテキストが箇条書きかどうかを示します。
TextRange
  color : Object
範囲内のテキストの色です。
TextRange
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  endIndex : int
コントロールのテキストフィールドの位置で、範囲内の最後の文字の直後の位置を示す 0 から始まるインデックスです。最後の文字の 1 から始まるインデックスに相当します。
TextRange
  fontFamily : String
範囲内のテキストのフォント名です。
TextRange
  fontSize : int
範囲内のテキストのポイントサイズです。
TextRange
  fontStyle : String
"italic" または "normal" で範囲内のフォントのスタイルを示します。
TextRange
  fontWeight : String
"bold" または "normal" で範囲内のフォントの太さを示します。
TextRange
  htmlText : String
範囲の HTML テキスト形式のコンテンツです。
TextRange
  kerning : Boolean
カーニングが有効か (true) 無効か (false) を示すブール値です。
TextRange
  letterSpacing : Number
各文字間に表示される追加のピクセル数です。
TextRange
  modifiesSelection : Boolean
[read-only] TextRange が現在選択されているテキストを変更するかどうかを指定します。
TextRange
  owner : UIComponent
テキストを含むコントロールです。
TextRange
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  text : String
範囲のプレーンテキストコンテンツです。
TextRange
  textAlign : String
範囲内のテキストの整列です。
TextRange
  textDecoration : String
"underline" または "normal" で範囲内のフォントの装飾を示します。
TextRange
  url : String
範囲内のハイパーリンクの URL です。
TextRange
パブリック Methods
 メソッド定義
  
TextRange(owner:UIComponent, modifiesSelection:Boolean = false, beginIndex:int = -1, endIndex:int = -1)
フォーマット情報を含むテキストコントロールのコンテンツのサブセットを表す TextRange オブジェクトを新規に作成します。
TextRange
 Inherited
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロパティの詳細
beginIndexプロパティ
beginIndex:int  [read-write]

コントロールのテキストフィールド内の 0 ベースインデックスで、範囲内の最初の文字を示します。テキストの 5 番目の文字が範囲内の最初の文字の場合、このプロパティの値は 4 になります。

実装
    public function get beginIndex():int
    public function set beginIndex(value:int):void
bulletプロパティ 
bullet:Boolean  [read-write]

範囲内のテキストが箇条書きかどうかを示します。範囲内のテキストの一部のみが箇条書きの場合、値は false です。

実装
    public function get bullet():Boolean
    public function set bullet(value:Boolean):void
colorプロパティ 
color:Object  [read-write]

範囲内のテキストの色です。有効なカラー識別子を使用して値を設定できます。このプロパティは数値を返します。範囲内に複数の色がある場合、値は null です。

実装
    public function get color():Object
    public function set color(value:Object):void
endIndexプロパティ 
endIndex:int  [read-write]

コントロールのテキストフィールドの位置で、範囲内の最後の文字の直後の位置を示す 0 から始まるインデックスです。最後の文字の 1 から始まるインデックスに相当します。テキストの 5 番目の文字が範囲内の最後の文字の場合、このプロパティの値は 5 になります。

実装
    public function get endIndex():int
    public function set endIndex(value:int):void
fontFamilyプロパティ 
fontFamily:String  [read-write]

範囲内のテキストのフォント名です。範囲内に複数のフォントがある場合、値は null です。

実装
    public function get fontFamily():String
    public function set fontFamily(value:String):void
fontSizeプロパティ 
fontSize:int  [read-write]

範囲内のテキストのポイントサイズです。範囲内のテキストに複数のサイズがある場合、値は 0 です。

実装
    public function get fontSize():int
    public function set fontSize(value:int):void
fontStyleプロパティ 
fontStyle:String  [read-write]

"italic" または "normal" で範囲内のフォントのスタイルを示します。このプロパティをこれ以外のストリングに指定すると、"normal" になります。範囲内のテキストに複数のスタイルがある場合、値は null です。

実装
    public function get fontStyle():String
    public function set fontStyle(value:String):void
fontWeightプロパティ 
fontWeight:String  [read-write]

"bold" または "normal" で範囲内のフォントの太さを示します。このプロパティをこれ以外のストリングに指定すると、"normal" になります。範囲内のテキストに複数の太さがある場合、値は null です。

実装
    public function get fontWeight():String
    public function set fontWeight(value:String):void
htmlTextプロパティ 
htmlText:String  [read-write]

範囲の HTML テキスト形式のコンテンツです。このプロパティは、範囲で使用されるすべての HTML マークアップを返します。これには、htmlText プロパティを使用して指定した HTML だけでなく、Flex によって適用されているフォーマットのマークアップも含まれます。したがって、このプロパティは、コントロールに表示されるテキストの完全な HTML 表現を示します。

実装
    public function get htmlText():String
    public function set htmlText(value:String):void
kerningプロパティ 
kerning:Boolean  [read-write]

カーニングが有効か (true) 無効か (false) を示すブール値です。カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。大きなフォントの見出しを使用する場合など、必要な場合にのみ使用する必要があります。カーニングは、埋め込みフォントに対してのみサポートされています。Verdana や、Courier New などの等幅フォントなど、特定のフォントではカーニングはサポートされていません。

デフォルト値false.

実装
    public function get kerning():Boolean
    public function set kerning(value:Boolean):void
letterSpacingプロパティ 
letterSpacing:Number  [read-write]

各文字間に表示される追加のピクセル数です。正の値を指定すると文字間隔が通常より広くなり、負の値を指定すると文字間隔が通常より狭くなります。

デフォルト値0.

実装
    public function get letterSpacing():Number
    public function set letterSpacing(value:Number):void
modifiesSelectionプロパティ 
modifiesSelection:Boolean  [read-only]

TextRange が現在選択されているテキストを変更するかどうかを指定します。コンストラクタによって設定されます。

実装
    public function get modifiesSelection():Boolean
ownerプロパティ 
owner:UIComponent  [read-write]

テキストを含むコントロールです。owner コントロールには textField プロパティが必要です。RichTextEditor コントロールの場合は textArea プロパティが必要です。RichTextEditor コントロール内のテキストのオーナーは RichTextEditor コントロールであり、TextArea サブコントロールではありません。初期値はコンストラクタによって設定されます。

実装
    public function get owner():UIComponent
    public function set owner(value:UIComponent):void
textプロパティ 
text:String  [read-write]

範囲のプレーンテキストコンテンツです。

実装
    public function get text():String
    public function set text(value:String):void
textAlignプロパティ 
textAlign:String  [read-write]

範囲内のテキストの整列です。flash.text.TextFormatAlign 定数で有効な値を指定します。他の値に設定すると、このプロパティは無効になります。範囲内のテキストに複数の整列がある場合、値は null です。

実装
    public function get textAlign():String
    public function set textAlign(value:String):void

関連項目

textDecorationプロパティ 
textDecoration:String  [read-write]

"underline" または "normal" で範囲内のフォントの装飾を示します。このプロパティをこれ以外のストリングに指定すると、"normal" になります。範囲内のテキストに複数の装飾が設定されている場合、値は null です。

実装
    public function get textDecoration():String
    public function set textDecoration(value:String):void
urlプロパティ 
url:String  [read-write]

範囲内のハイパーリンクの URL です。範囲内にリンクが含まれない場合、値は空のストリングです。範囲内に複数のリンクが含まれる場合、値は null です。

実装
    public function get url():String
    public function set url(value:String):void
コンストラクタの詳細
TextRange()コンストラクタ
public 関数 TextRange(owner:UIComponent, modifiesSelection:Boolean = false, beginIndex:int = -1, endIndex:int = -1)

フォーマット情報を含むテキストコントロールのコンテンツのサブセットを表す TextRange オブジェクトを新規に作成します。

パラメータ
owner:UIComponent — テキストを含むコントロールです。コントロールは、textField プロパティを持つ必要があります。または、RichTextEditor コントロールのように、textArea プロパティを持つ必要があります。
 
modifiesSelection:Boolean (default = false) — 範囲内のテキストを選択するかどうかを指定します。このパラメータを true に設定し、コントロール内のテキストに対応する開始インデックスと終了インデックスを指定しないと、現在のテキスト範囲の開始および終了インデックスが使用されます。このパラメータが true で、beginIndex パラメータと endIndex パラメータを省略し、選択範囲がない場合は、TextRange オブジェクトは空です。
 
beginIndex:int (default = -1) — 範囲内の最初の文字を示す 0 ベースのインデックス値です。modifiesSelection パラメータが false であるときに、このパラメータを省略するか、負の値を指定すると、範囲の開始位置は、テキストの最初の文字になります。
 
endIndex:int (default = -1) — 範囲内の最後の文字の直後の位置を示す 0 ベースのインデックス値です。modifiesSelection パラメータが false であるときに、このパラメータを省略する、負の値を指定する、またはテキストの終点を越える値を指定する、のいずれかを行うと、範囲の終了位置は、テキストの最後の文字になります。