ui.igTextEditor

igTextEditor コントロールは、テキスト ユーザー入力の処理をサポートします。オプションには、null テキスト、プレーン テキスト、パスワード、および複数行モードの指定があります。この API のクラス、オプション、イベント、メソッドおよびテーマに関する詳細は、上記の関連するタブを参照してください。
igTextEditor コントロールの API の詳細については、基本の igEditor コントロールの API マニュアルを参照してください。
以下のコード スニペットは、igTextEditor コントロールを初期化する方法を示します。
この API を使用して作業を開始するための情報はここをクリックしてください。igTextEditor コントロールに必要なスクリプトとテーマを参照する方法については、Ignite UI の JavaScript リソースの使用および Ignite UI のスタイリングとテーマをご覧ください。コード サンプル
<!doctype html> <html> <head> <!-- Infragistics Combined CSS --> <link href= "css/themes/infragistics/infragistics.theme.css" rel= "stylesheet" type= "text/css" /> <link href= "css/structure/infragistics.css" rel= "stylesheet" type= "text/css" /> <!-- jQuery Core --> <script src= "js/jquery.js" type= "text/javascript" ></script> <!-- jQuery UI --> <script src= "js/jquery-ui.js" type= "text/javascript" ></script> <!-- Infragistics Combined Scripts --> <script src= "js/infragistics.core.js" type= "text/javascript" ></script> <script src= "js/infragistics.lob.js" type= "text/javascript" ></script> <script type= "text/javascript" > $( function () { $( "#textEditor" ).igTextEditor({ width: 160, placeHolder: "Enter Text" }); }); </script> </head> <body> <input id= "textEditor" /> </body> </html> |
関連サンプル
関連トピック
依存関係
-
allowNullValue
継承- タイプ:
- bool
- デフォルト:
- false
null 値を回避する機能を取得または設定します。
このオプションが false で、エディターに値がない場合、値は空の文字列になります。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
allowNullValue :
false
});
//Get
var
allowNullValue = $(
".selector"
).igTextEditor(
"option"
,
"allowNullValue"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"allowNullValue"
,
false
);
-
buttonType
- タイプ:
- enumeration
- デフォルト:
- none
スピン、クリア、およびドロップダウン ボタンの表示状態を取得します。このオプションは、初期化時にのみ設定できます。「dropdown,spin」または「spin,clear」などの組み合わせもサポートされています。
メンバー
- dropdown
- タイプ:string
- リストを開く/閉じるボタンはエディターの右側に配置されます。
- clear
- タイプ:string
- 値をクリアするボタンはエディターの右側に配置されます。
- spin
- タイプ:string
- スピン ボタンはエディターの右側に配置されます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
buttonType :
"dropdown"
});
//Get
var
button = $(
".selector"
).igTextEditor(
"option"
,
"buttonType"
);
//Initialize multiple buttons
$(
".selector"
).igTextEditor({
buttonType :
"dropdown,clear"
});
-
disabled
継承- タイプ:
- bool
- デフォルト:
- false
入力の disabled 属性を取得または設定します。True に設定される場合、入力が無効で、すべてのボタンおよび操作が無効です。エディターのフォームの送信で値が送信されません。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
disabled :
false
});
//Get
var
disabled = $(
".selector"
).igTextEditor(
"option"
,
"disabled"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"disabled"
,
true
);
-
dropDownAnimationDuration
- タイプ:
- number
- デフォルト:
- 300
ドロップダウン リストの表示/非表示アニメーションの期間 (ミリ秒) を取得または設定します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
dropDownAnimationDuration: 500
});
//Get
var
animationShowDuration= $(
".selector"
).igTextEditor(
"option"
,
"dropDownAnimationDuration"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"dropDownAnimationDuration"
, 500);
-
dropDownAttachedToBody
- タイプ:
- bool
- デフォルト:
- false
ドロップダウン リスト要素がドキュメントの本体またはエディター コンテナー要素に添付されるかどうかを取得します。
オプションが false に設定される場合、エディターはドロップダウン リスト要素をエディター コンテナーに添付します。
オプションが true に設定される場合、エディターはドロップダウン リストを本体の子として添付します。
注: このオプションはランタイムで設定できません。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
dropDownAttachedToBody :
true
});
//Get
var
attachedToBody = $(
".selector"
).igTextEditor(
"option"
,
"dropDownAttachedToBody"
);
-
dropDownOnReadOnly
- タイプ:
- bool
- デフォルト:
- false
エディターをドロップダウン リストのみとして使用を制限する機能を取得します。True に設定すると、エディターのテキストは編集できません。
注:リスト項目がない場合もエディターは読み取り専用です。
注: このオプションはランタイムで設定できません。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
dropDownOnReadOnly :
true
});
//Get
var
readOnly = $(
".selector"
).igTextEditor(
"option"
,
"dropDownOnReadOnly"
);
-
dropDownOrientation
- タイプ:
- enumeration
- デフォルト:
- auto
リストが開いたときにドロップダウン リストの開く方法を取得または設定します。オプションが auto に設定される場合、エディターがドロップダウン リストをエディターの下に開きます。スペースがない場合、リストをエディターの上に開きます。両方の方向でスペースがない場合、リストはエディターの下に開かれます。自動オプションを設定した場合、コンポーネントは下に十分なスペースがあるか計算します。もしない場合、コンポーネントの上のスペースを確認し、上下とも十分なスペースがない場合、ドロップダウンを開きます。
メンバー
- auto
- タイプ:string
- オプションが auto に設定される場合、エディターがドロップダウン リストをエディターの下に開きます。 スペースがない場合、リストをエディターの上に開きます。 両方の方向でスペースがない場合、リストはエディターの下に開かれます。
- bottom
- タイプ:string
- ドロップダウン リストがエディターの下に開きます。
- top
- タイプ:string
- ドロップダウン リストがエディターの上に開きます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
dropDownOrientation :
"top"
});
//Get
var
orientation = $(
".selector"
).igTextEditor(
"option"
,
"dropDownOrientation"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"dropDownOrientation"
,
"bottom"
);
-
excludeKeys
- タイプ:
- string
- デフォルト:
- null
キーボードの入力および貼り付けにより特定の文字の入力を回避する機能を取得または設定します。
注:
"excludeKeys" および "includeKeys" オプションの両方が使用される場合、"excludeKeys" に優先があり、includeKeys オプションは使用されていません。
文字は大文字で設定する必要があります。
大文字と小文字を区別することはサポートされていません。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
excludeKeys:
"AaBC"
});
//Get
var
excludedKeys= $(
".selector"
).igTextEditor(
"option"
,
"excludeKeys"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"excludeKeys"
,
"ABC"
);
-
height
継承- タイプ:
- enumeration
- デフォルト:
- null
コントロールの高さを取得または設定します。
メンバー
- null
- タイプ:object
- 他の高さが定義されていない場合、エディターは親コンテナーに収まります。
- string
- 高さをピクセル (px) またはパーセンテージ (%) に設定できます。
- number
- 高さをピクセル単位の数値で設定できます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
height : 25
});
//Get
var
height = $(
".selector"
).igTextEditor(
"option"
,
"height"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"height"
, 25);
-
includeKeys
- タイプ:
- string
- デフォルト:
- null
キーボードからおよび貼り付けによって特定の文字だけを入力フィールドに入力できるようにする機能を取得または設定します。
注:
"excludeKeys" および "includeKeys" オプションの両方が使用される場合、"excludeKeys" に優先があり、includeKeys オプションは使用されていません。
文字は大文字で設定する必要があります。
大文字と小文字を区別することはサポートされていません。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
includeKeys:
"AaBC"
});
//Get
var
includedKeys= $(
".selector"
).igTextEditor(
"option"
,
"includeKeys"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"includeKeys"
,
"ABC"
);
-
inputName
継承- タイプ:
- string
- デフォルト:
- null
値入力の名前属性を取得または設定します。入力はサーバーへ値を送信するために使用されます。ターゲット要素が入力で名前要素があり、開発者が inputName オプションに設定した場合、このオプションは値入力を上書きし要素の属性を削除します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
inputName :
"textField"
});
//Get
var
inputName = $(
".selector"
).igTextEditor(
"option"
,
"inputName"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"inputName"
,
"textField"
);
-
isLimitedToListValues
- タイプ:
- bool
- デフォルト:
- false
エディターが項目のリストからの値のみを許可するかどうかを取得または設定します。一致は大文字と小文字を区別しません。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
isLimitedToListValues :
true
});
//Get
var
limited = $(
".selector"
).igTextEditor(
"option"
,
"isLimitedToListValues"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"isLimitedToListValues"
,
false
);
-
language
継承- タイプ:
- string
- デフォルト:
- "en"
ウィジェットのロケール言語設定を取得または設定します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
language:
"ja"
});
// Get
var
language = $(
".selector"
).igTextEditor(
"option"
,
"language"
);
// Set
$(
".selector"
).igTextEditor(
"option"
,
"language"
,
"ja"
);
-
listItemHoverDuration
- タイプ:
- number
- デフォルト:
- 0
ドロップダウンのリスト項目のホバー/ホバー解除アニメーションの期間を取得または設定します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
listItemHoverDuration : 100
});
//Get
var
hoverDuration = $(
".selector"
).igTextEditor(
"option"
,
"listItemHoverDuration"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"listItemHoverDuration"
, 100);
-
listItems
- タイプ:
- array
- デフォルト:
- null
- 要素タイプ:
ドロップダウン リストのソースとして使用される項目リストを取得または設定します。
リスト内の項目は文字列型が可能です。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
listItems : [
"item 1"
,
"item 2"
,
"item 3"
]
});
//Get
var
items = $(
".selector"
).igTextEditor(
"option"
,
"listItems"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"listItems"
, [
"item 1"
,
"item 2"
,
"item 3"
]);
-
listWidth
- タイプ:
- number
- デフォルト:
- 0
ドロップダウン リストのカスタムの幅 (ピクセル単位) を取得または設定します。値がゼロまたは負の場合、エディターの幅がドロップダウンの幅に設定されます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
listWidth : 200
});
//Get
var
width = $(
".selector"
).igTextEditor(
"option"
,
"listWidth"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"listWidth"
, 200);
-
locale
継承- タイプ:
- object
- デフォルト:
- null
ウィジェットのロケール設定を取得または設定します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
locale: {}
});
// Get
var
locale = $(
".selector"
).igTextEditor(
"option"
,
"locale"
);
// Set
$(
".selector"
).igTextEditor(
"option"
,
"locale"
, {});
-
maxLength
- タイプ:
- number
- デフォルト:
- null
ユーザーが入力できるテキストの最大長を取得または設定します。
負の値または 0 はこの動作を無効にします。ランタイムに設定される場合、エディターはオプションを現在の値に適用しません。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
maxLength : 25
});
//Get
var
textLength = $(
".selector"
).igTextEditor(
"option"
,
"maxLength"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"maxLength"
, 25);
-
nullValue
継承- タイプ:
- enumeration
- デフォルト:
- null
エディター値が null 値になることが可能かどうかを取得または設定します。デフォルトの場合、入力の値は null に設定され、入力が空文字列を保持します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
nullValue :
null
});
//Get
var
nullValue = $(
".selector"
).igTextEditor(
"option"
,
"nullValue"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"nullValue"
,
null
);
-
placeHolder
- タイプ:
- string
- デフォルト:
- null
エディターがフォーカスを持たず、エディター内の "value" が null または空の文字列ときのエディターに表示されるテキストを取得または設定します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
placeHolder :
"Enter Value"
});
//Get
var
placeHolder = $(
".selector"
).igTextEditor(
"option"
,
"placeHolder"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"placeHolder"
,
"Enter Value"
);
-
preventSubmitOnEnter
- タイプ:
- bool
- デフォルト:
- false
Enter キーの押下でフォーム送信を回避する機能を取得または設定します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
preventSubmitOnEnter:
true
});
//Get
var
preventSubmitOnEnter = $(
".selector"
).igTextEditor(
"option"
,
"preventSubmitOnEnter"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"preventSubmitOnEnter"
,
true
);
-
readOnly
継承- タイプ:
- bool
- デフォルト:
- false
入力の readonly 属性を取得または設定します。True に設定される場合、入力が読み取り専用で、すべてのボタンおよび操作が無効です。エディターのフォームの送信で値が送信されます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
readOnly :
true
});
//Get
var
readOnly = $(
".selector"
).igTextEditor(
"option"
,
"readOnly"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"readOnly"
,
true
);
-
regional
継承- タイプ:
- enumeration
- デフォルト:
- defaults
ウィジェットの領域設定を取得または設定します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
regional:
"ja"
});
// Get
var
regional = $(
".selector"
).igTextEditor(
"option"
,
"regional"
);
// Set
$(
".selector"
).igTextEditor(
"option"
,
"regional"
,
"ja"
);
-
revertIfNotValid
- タイプ:
- bool
- デフォルト:
- true
ぼかしまたは Enter キーの押しで値が無効な場合、エディターが値を以前の有効な値を元に戻す機能を取得または設定します。オプションが false に設定される場合、エディターはクリア機能を呼び出します。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
revertIfNotValid :
false
});
//Get
var
revertIfNotValid = $(
".selector"
).igTextEditor(
"option"
,
"revertIfNotValid"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"revertIfNotValid"
,
false
);
-
selectionOnFocus
- タイプ:
- enumeration
- デフォルト:
- selectAll
エディターがフォーカスを取得したときの動作を取得または設定します。デフォルト値は selectAll です。
メンバー
- selectAll
- タイプ:string
- このオプションを設定すると、編集モードに入ったときにエディターのすべてのテキストを選択します。
- atStart
- タイプ:string
- このオプションを設定すると、編集モードに入ったときにエディターのテキストの初めにカーソルを移動します。
- atEnd
- タイプ:string
- このオプションを設定すると、編集モードに入ったときにエディターのテキストの最後にカーソルを移動します。
- browserDefault
- タイプ:string
- このオプションの設定に追加のロジックはありませんが、ブラウザーのデフォルトの動作で処理されます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
selectionOnFocus:
"atStart"
});
//Get
var
selectionOnFocus= $(
".selector"
).igTextEditor(
"option"
,
"selectionOnFocus"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"selectionOnFocus"
,
"selectAll"
);
-
spinWrapAround
- タイプ:
- bool
- デフォルト:
- false
ドロップダウン リストの選択された項目をリストの端から反対の端まで自動的に移動する機能を取得または設定します。最後の項目に達してスピン ダウンが実行されると、最初の項目が選択されます (逆の場合も同じ) 。ドロップダウン リストがない場合、このオプションは効果がありません。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
spinWrapAround :
true
});
//Get
var
spinAround = $(
".selector"
).igTextEditor(
"option"
,
"spinWrapAround"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"spinWrapAround"
,
true
);
-
suppressKeyboard
- タイプ:
- bool
- デフォルト:
- false
ドロップダウンがクリック/タップされたときにオンスクリーン キーボード (デバイスで利用可能な場合) を表示するかどうかを取得または設定します。このオプションは最初のフォーカスを回避するか、ドロップダウン ボタンがクリックまたはタップされたときにフォーカスを解除します。
注: このオプションはデバイスの検出を実行しないため、有効な場合に動作が常にアクティブになります。
注: ドロップダウンを開いている場合ドロップダウン ボタンを使用してのみ閉じることができます。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
suppressKeyboard :
true
});
//Get
var
readOnly = $(
".selector"
).igTextEditor(
"option"
,
"suppressKeyboard"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"suppressKeyboard"
,
true
);
-
suppressNotifications
- タイプ:
- bool
- デフォルト:
- false
エディターのビルトイン基本検証シナリオで、必須リスト選択、値ラッピング、スピン制限などのデフォルトの通知を有効/無効にします。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
suppressNotifications :
true
});
//Get
var
suppressNotifications = $(
".selector"
).igTextEditor(
"option"
,
"suppressNotifications"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"suppressNotifications"
,
true
);
-
tabIndex
継承- タイプ:
- number
- デフォルト:
- null
エディター入力の tabIndex 属性を取得または設定します。
コード サンプル
//Initialize
$(
'.selector'
).igTextEditor({
tabIndex: 1
});
//Get
var
tabIndex = $(
".selector"
).igTextEditor(
"option"
,
"tabIndex"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"tabIndex"
, 1);
-
textAlign
- タイプ:
- enumeration
- デフォルト:
- left
エディター内のテキストの水平配置を取得または設定します。そのオプションが設定されない場合、'numeric'、'currency'、および 'percent' エディターの 'right' のデフォルト値が使用されます。
メンバー
- left
- タイプ:string
- 入力したテキストは左揃えになります。
- right
- タイプ:string
- 入力したテキストは右揃えになります。
- center
- タイプ:string
- 入力したテキストは中央揃えになります。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
textAlign :
"center"
});
//Get
var
align = $(
".selector"
).igTextEditor(
"option"
,
"textAlign"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"textAlign"
,
"center"
);
-
textMode
- タイプ:
- enumeration
- デフォルト:
- text
単一行テキスト エディター、パスワード エディター、複数行エディターなど、エディターのテキスト モードを取得します。このオプションは、初期化時にのみ影響します。ベースとなる要素 (セレクター) が TEXTAREA の場合、それを入力フィールドとして使用します。
メンバー
- text
- タイプ:string
- INPUT 要素に基づく単一行テキスト エディターが作成されます。
- password
- タイプ:string
- タイプ パスワードで作成される INPUT 要素に基づくエディターが作成されます。
- multiline
- タイプ:string
- TEXTAREA 要素に基づく複数行エディターが作成されます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
textMode :
"password"
});
//Get
var
mode = $(
".selector"
).igTextEditor(
"option"
,
"textMode"
);
-
toLower
- タイプ:
- bool
- デフォルト:
- false
True の場合は、入力された文字列を小文字に変換し、False の場合は、文字列をそのままにしておく機能を取得または設定します。このオプションは、キーボード入力と貼り付けを使用する場合のみ効果があります。注: オプションがランタイムに設定される場合、エディターは現在の値を変更しません。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
toLower :
true
});
//Get
var
toLower = $(
".selector"
).igTextEditor(
"option"
,
"toLower"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"toLower"
,
true
);
-
toUpper
- タイプ:
- bool
- デフォルト:
- false
True の場合は、入力された文字列を大文字に変換し、False の場合は、文字列をそのままにしておく機能を取得または設定します。このオプションは、キーボード入力と貼り付けを使用する場合のみ効果があります。注: オプションがランタイムに設定される場合、エディターは現在の値を変更しません。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
toUpper :
true
});
//Get
var
toUpper = $(
".selector"
).igTextEditor(
"option"
,
"toUpper"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"toUpper"
,
true
);
-
validatorOptions
継承- タイプ:
- object
- デフォルト:
- null
igValidator ウィジェットによってサポートされるオプションを取得または設定します。
注: エラーをトリガーした際に igValidator の検証ルールは最小値/長さおよび最大値/長さを別々に適用します。エディターの対応するオプションは、定義された入力規則に反する値の入力を防止します。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
validatorOptions : {
successMessage:
"Success"
,
required:
true
,
onchange:
true
,
notificationOptions: { mode:
"popover"
}
}
});
//Get
var
validateOptions = $(
".selector"
).igTextEditor(
"option"
,
"validatorOptions"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"validatorOptions"
, {onblur:
true
, onchange:
true
});
-
value
継承- タイプ:
- object
- デフォルト:
- null
エディター内の値を取得または設定します。エディターのタイプおよび各エディター タイプの dataMode オプションに基づいたオプションを取得または設定する効果。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
value :
"Some text"
});
//Get
var
value = $(
".selector"
).igTextEditor(
"option"
,
"value"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"value"
,
"Some text"
);
-
visibleItemsCount
- タイプ:
- number
- デフォルト:
- 5
ドロップダウン リストが開いたときに表示される項目の数を取得します。
注:
リスト項目の数が設定される値より小さい場合、このオプションは上書きされます。その場合、ドロップダウンはすべての項目を表示します。
注: このオプションはランタイムで設定できません。コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
visibleItemsCount : 5
});
//Get
var
visibleItemsCount = $(
".selector"
).igTextEditor(
"option"
,
"visibleItemsCount"
);
-
width
継承- タイプ:
- enumeration
- デフォルト:
- null
コントロールの幅を取得または設定します。
メンバー
- null
- タイプ:object
- 他の幅が定義されていない場合、データに合わせて引き伸ばされます。
- string
- ウィジェットの幅をピクセル (px) またはパーセンテージ (%) に設定できます。
- number
- ウィジェットの幅は数値としてピクセルで設定できます。
コード サンプル
//Initialize
$(
".selector"
).igTextEditor({
width : 200
});
//Get
var
width = $(
".selector"
).igTextEditor(
"option"
,
"width"
);
//Set
$(
".selector"
).igTextEditor(
"option"
,
"width"
, 200);
Ignite UI コントロール イベントの詳細については、
Ignite UI でイベントを使用するを参照してください。
-
blur
継承- キャンセル可能:
- false
エディターの入力フィールドがフォーカスを失うときに発生します。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorblur"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
blur:
function
(evt, ui) {
...
}
});
-
dropDownItemSelected
- キャンセル可能:
- false
ドロップダウン リストの項目が選択された後に発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditordropdownitemselected"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
dropDownItemSelected:
function
(evt, ui) {
...
}
});
-
dropDownItemSelecting
- キャンセル可能:
- true
ドロップダウン リストの項目が選択されているときに発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditordropdownitemselecting"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
dropDownItemSelecting:
function
(evt, ui) {
...
}
});
-
dropDownListClosed
- キャンセル可能:
- false
ドロップダウン リストが閉じた後に発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditordropdownlistclosed"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
dropDownListClosed:
function
(evt, ui) {
...
}
});
-
dropDownListClosing
- キャンセル可能:
- true
ドロップダウン リストが閉じているときに発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditordropdownlistclosing"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
dropDownListClosing:
function
(evt, ui) {
...
}
});
-
dropDownListOpened
- キャンセル可能:
- true
ドロップダウン リストが開いた後に発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditordropdownlistopened"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
dropDownListOpened:
function
(evt, ui) {
...
}
});
-
dropDownListOpening
- キャンセル可能:
- true
ドロップダウン リストが開いているときに発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditordropdownlistopening"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
dropDownListOpening:
function
(evt, ui) {
...
}
});
-
focus
継承- キャンセル可能:
- false
エディターの入力フィールドがフォーカスを受けるときに発生します。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorfocus"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
focus:
function
(evt, ui) {
...
}
});
-
keydown
継承- キャンセル可能:
- true
keydown イベントで発生されます。
キー操作をキャンセルするには、False を返します。コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorkeydown"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
keydown:
function
(evt, ui) {
...
}
});
-
keypress
継承- キャンセル可能:
- true
keypress イベントで発生されます。
キー操作をキャンセルするには、False を返します。コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorkeypress"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
keypress:
function
(evt, ui) {
...
}
});
-
keyup
継承- キャンセル可能:
- false
keyup イベントで発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorkeyup"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
keyup:
function
(evt, ui) {
...
}
});
-
mousedown
継承- キャンセル可能:
- true
mousedown イベントで発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditormousedown"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
mousedown:
function
(evt, ui) {
...
}
});
-
mousemove
継承- キャンセル可能:
- false
ドロップダウン リストを含むエディターの任意の部分での mousemove に対して発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditormousemove"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
mousemove:
function
(evt, ui) {
...
}
});
-
mouseout
継承- キャンセル可能:
- false
ドロップダウン リストを含むエディターの任意の部分での mouseleave に対して発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditormouseout"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
mouseout:
function
(evt, ui) {
...
}
});
-
mouseover
継承- キャンセル可能:
- false
ドロップダウン リストを含むエディターの任意の部分での mouseover に対して発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditormouseover"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
mouseover:
function
(evt, ui) {
...
}
});
-
mouseup
継承- キャンセル可能:
- false
mouseup イベントで発生されます。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditormouseup"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
mouseup:
function
(evt, ui) {
...
}
});
-
rendered
継承- キャンセル可能:
- false
エディターのレンダリングが完了した後に発生します。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorrendered"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
rendered:
function
(evt, ui) {
...
}
});
-
rendering
継承- キャンセル可能:
- true
エディターのレンダリングが完了する前に発生します。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorrendering"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
rendering:
function
(evt, ui) {
...
}
});
-
textChanged
- キャンセル可能:
- false
エディターのテキストが変更された後に発生します。keyUp イベントが発生するときに発生できます。
または、クリアボタンがクリックされたときまたはリストの項目がせんたくされたときに発生できます。コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditortextchanged"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
textChanged:
function
(evt, ui) {
...
}
});
-
valueChanged
継承- キャンセル可能:
- false
エディター値が変更された後に発生します。フォーカスの消失またはスピン イベントに対して発生します。
コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorvaluechanged"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
valueChanged:
function
(evt, ui) {
...
}
});
-
valueChanging
継承- キャンセル可能:
- true
エディターの値を変更する前に発生します。
変更をキャンセルするには、False を返します。
フォーカスの消失またはスピン イベントに対して発生します。コード サンプル
//Bind after initialization
$(
".selector"
).on(
"igtexteditorvaluechanging"
,
function
(evt, ui) {
...
});
//Initialize
$(
".selector"
).igTextEditor({
valueChanging:
function
(evt, ui) {
...
}
});
-
changeGlobalLanguage
継承- .igTextEditor( "changeGlobalLanguage" );
ウィジェットの言語をグローバルの言語に変更します。グローバルの言語は $.ig.util.language の値です。
コード サンプル
$(
".selector"
).igTextEditor(
"changeGlobalLanguage"
);
-
changeGlobalRegional
継承- .igTextEditor( "changeGlobalRegional" );
ウィジェットの地域設定をグローバルの地域設定に変更します。グローバルの地域設定は $.ig.util.regional にあります。
コード サンプル
$(
".selector"
).igTextEditor(
"changeGlobalRegional"
);
-
changeLocale
- .igTextEditor( "changeLocale" );
ウィジェット要素のすべてのロケールを options.language に指定される言語に変更します。
注: このメソッドは珍しいシナリオのみで使用されます。language または locale オプションのセッターを参照してください。コード サンプル
$(
".selector"
).igTextEditor(
"changeLocale"
);
-
clearButton
- .igTextEditor( "clearButton" );
- 返却型:
- jquery
- 返却型の説明:
- jQuery オブジェクトへの参照を返します。
エディターのクリア ボタン UI 要素への参照を返します。
returnType="$"。jquery オブジェクトへの参照を返します。コード サンプル
var
button = $(
".selector"
).igTextEditor(
"clearButton"
);
-
destroy
継承- .igTextEditor( "destroy" );
ウィジェットを破棄します。
コード サンプル
$(
".selector"
).igTextEditor(
"destroy"
);
-
displayValue
- .igTextEditor( "displayValue" );
- 返却型:
- string
- 返却型の説明:
- エディターの表示テキスト。
エディターに表示するテキストを取得します。
コード サンプル
$(
".selector"
).igTextEditor(
"displayValue"
);
-
dropDownButton
- .igTextEditor( "dropDownButton" );
- 返却型:
- jquery
- 返却型の説明:
- jQuery オブジェクトへの参照を返します。
エディターのクリア ボタン UI 要素への参照を返します。
returnType="$"。jquery オブジェクトへの参照を返します。コード サンプル
var
button = $(
".selector"
).igTextEditor(
"dropDownButton"
);
-
dropDownContainer
- .igTextEditor( "dropDownContainer" );
- 返却型:
- jquery
- 返却型の説明:
- jQuery オブジェクトへの参照を返します。
ドロップダウンのコンテナーとして使用される jquery オブジェクトへの参照を取得します。
returnType="$"。jquery オブジェクトへの参照を返します。コード サンプル
$(
".selector"
).igTextEditor(
"dropDownContainer"
);
-
dropDownVisible
- .igTextEditor( "dropDownVisible" );
- 返却型:
- bool
- 返却型の説明:
- ドロップダウンの表示状態。
項目を表示するドロップダウンの表示状態を返します。
コード サンプル
var
visible = $(
".selector"
).igTextEditor(
"dropDownVisible"
);
-
editorContainer
継承- .igTextEditor( "editorContainer" );
- 返却型:
- jquery
- 返却型の説明:
- コンテナー エディター要素。
エディターをラップする jQuery 要素への参照を取得します。
コード サンプル
$(
".selector"
).igTextEditor(
"editorContainer"
);
-
field
継承- .igTextEditor( "field" );
- 返却型:
- jquery
- 返却型の説明:
- 視覚エディター要素。
エディターの入力要素を取得します。
returnType="$" 視覚エディター要素。コード サンプル
$(
".selector"
).igTextEditor(
"field"
);
-
findListItemIndex
- .igTextEditor( "findListItemIndex", text:string, [matchType:object] );
- 返却型:
- number
- 返却型の説明:
- 見つかった項目のインデックスを返します。
検索パラメーターと一致するテキストによってリスト項目のインデックスを検索します。
- text
- タイプ:string
- ドロップダウン リストで検索するテキスト。
- matchType
- タイプ:object
- オプション
- テキストの検索で適用されるルール。
コード サンプル
var
item = $(
".selector"
).igTextEditor(
"findListItemIndex"
);
-
getSelectedListItem
- .igTextEditor( "getSelectedListItem" );
- 返却型:
- jquery
- 返却型の説明:
- 選択されたリスト項目。
選択されたリスト項目を取得します。
returnType="$" 選択されたリスト項目。コード サンプル
var
selectedItem = $(
".selector"
).igTextEditor(
"getSelectedListItem"
);
-
getSelectedText
- .igTextEditor( "getSelectedText" );
- 返却型:
- string
- 返却型の説明:
- エディターで選択されたテキスト。
編集モードでエディターから選択されたテキストを取得します。keydown または keyup などのキー イベント ハンドラーで可能です。このメソッドはエディターにフォーカスがある場合のみ使用できます。エディターにフォーカスがない状態でこのメソッドを呼び出した場合、空文字列になる場合があります。
コード サンプル
var
text = (
".selector"
).igTextEditor(
"getSelectedText"
);
-
getSelectionEnd
- .igTextEditor( "getSelectionEnd" );
- 返却型:
- number
- 返却型の説明:
- エディターで選択されたテキストの終了インデックス。
エディターで選択されたテキストの終了インデックスを取得します。
コード サンプル
var
intex = $(
".selector"
).igTextEditor(
"getSelectionEnd"
);
-
getSelectionStart
- .igTextEditor( "getSelectionStart" );
- 返却型:
- number
- 返却型の説明:
- エディターで選択されたテキストの開始インデックス。
エディターで選択されたテキストの開始インデックスを取得します。
コード サンプル
var
intex = $(
".selector"
).igTextEditor(
"getSelectionStart"
);
-
hasFocus
継承- .igTextEditor( "hasFocus" );
- 返却型:
- bool
- 返却型の説明:
- エディターがフォーカスされるかどうかを返します。
エディターがフォーカスを持つかどうかを取得します。
コード サンプル
$(
".selector"
).igTextEditor(
"hasFocus"
);
-
hide
継承- .igTextEditor( "hide" );
エディターを非表示にします。
コード サンプル
$(
".selector"
).igTextEditor(
"hide"
);
-
hideDropDown
- .igTextEditor( "hideDropDown" );
ドロップダウン リストを非表示します。
コード サンプル
$(
".selector"
).igTextEditor(
"hideDropDown"
);
-
inputName
継承- .igTextEditor( "inputName", [newValue:string] );
- 返却型:
- string
- 返却型の説明:
- 現在の入力名。
エディター要素に適用される名前属性を取得または設定します。
- newValue
- タイプ:string
- オプション
- 新しい入力名。
コード サンプル
$(
".selector"
).igTextEditor(
"inputName"
,
"checkbox"
);
-
insert
- .igTextEditor( "insert", string:string );
カレットの位置、または現在選択を上書きしてテキストを挿入します。エディターがフォーカスを持つ場合、このメソッドは現在選択を上書きしてテキストを挿入します。エディターがフォーカスを持たない場合、このメソッドはエディターの値をテキストに設定します。注: メソッドは textChanged イベントを発生させます。
- string
- タイプ:string
- 挿入する文字列。
コード サンプル
$(
'.selector'
).igTextEditor({
blur:
function
(evt, ui) {
// insert 0 as the user leaves the field
ui.owner.insert(
"0"
);
}
});
$(
".selector"
).igTextEditor(
"insert"
,
"20"
);
-
isValid
継承- .igTextEditor( "isValid" );
- 返却型:
- bool
- 返却型の説明:
- 編集値が有効化どうか。
エディター内の値が値かどうかチェックします。注: この機能は自動通知をトリガーしません。
コード サンプル
var
isValid = $(
".selector"
).igTextEditor(
"isValid"
);
-
select
- .igTextEditor( "select", start:number, end:number );
エディターで開始インデックスおよび終了インデックスの間のテキストを選択します。パラメーターが等しい場合、このメソッドはカレットの場所を設定します。このメソッドはエディターにフォーカスがある場合のみ効果があります。
- start
- タイプ:number
- 選択の開始。
- end
- タイプ:number
- 選択の終了。
コード サンプル
$(
".selector"
).igTextEditor(
"select"
, 2, 4);
-
selectedListIndex
- .igTextEditor( "selectedListIndex", [index:number] );
- 返却型:
- number
- 返却型の説明:
- 選択されているインデックスを返します。
リ選択したリスト項目のインデックスを取得します。選択した項目をインデックスによって設定します。
- index
- タイプ:number
- オプション
- 選択する項目のインデックス。
コード サンプル
$(
".selector"
).igTextEditor(
"selectedListIndex"
, 1);
var
selectedIndex = $(
".selector"
).igTextEditor(
"selectedListIndex"
);
-
setFocus
継承- .igTextEditor( "setFocus", [delay:number] );
指定した遅延時間の後にフォーカスをエディターに設定します。
- delay
- タイプ:number
- オプション
- エディターにフォーカスする前の遅延。
コード サンプル
$(
".selector"
).igTextEditor(
"setFocus"
, 200);
-
show
継承- .igTextEditor( "show" );
エディターを表示します。
コード サンプル
$(
".selector"
).igTextEditor((
"show"
);
-
showDropDown
- .igTextEditor( "showDropDown" );
ドロップダウン リストを表示します。
コード サンプル
$(
".selector"
).igTextEditor(
"showDropDown"
);
-
spinDown
- .igTextEditor( "spinDown" );
ドロップダウン リストに次の項目を選択します。
コード サンプル
$(
".selector"
).igTextEditor(
"spinDown"
);
-
spinDownButton
- .igTextEditor( "spinDownButton" );
- 返却型:
- jquery
- 返却型の説明:
- エディターのスピン ダウン UI 要素を表す jQuery オブジェクト。
エディターのスピン ダウン UI 要素への参照を返します。
returnType="$" エディターのスピン ダウン UI 要素を表す jQuery オブジェクト。コード サンプル
var
button = $(
".selector"
).igTextEditor(
"spinDownButton"
);
-
spinUp
- .igTextEditor( "spinUp" );
ドロップダウン リストに前の項目を選択します。
コード サンプル
$(
".selector"
).igTextEditor(
"spinUp"
);
-
spinUpButton
- .igTextEditor( "spinUpButton" );
- 返却型:
- jquery
- 返却型の説明:
- エディターのスピン アップ UI 要素を表す jQuery オブジェクト。
エディターのスピン アップ UI 要素への参照を返します。
returnType="$" エディターのスピン アップ UI 要素を表す jQuery オブジェクト。コード サンプル
var
button = $(
".selector"
).igTextEditor(
"spinUpButton"
);
-
validate
継承- .igTextEditor( "validate" );
- 返却型:
- bool
- 返却型の説明:
- 編集値が有効化どうか。
エディターの検証をトリガーします。 validatorOptions を設定すると igValidator で検証も呼び出されます。
コード サンプル
var
valid = $(
".selector"
).igTextEditor(
"validate"
);
-
validator
継承- .igTextEditor( "validator" );
- 返却型:
- object
- 返却型の説明:
- igValidator への参照または null を返します。
エディターで使用される igValidator への参照を取得します。
コード サンプル
var
validator = $(
".selector"
).igTextEditor(
"validator"
);
-
value
継承- .igTextEditor( "value", newValue:object );
- newValue
- タイプ:object
コード サンプル
$(
".selector"
).igTextEditor(
"value"
,
"New Text"
);
-
ui-state-active
- エディターがアクティブなときに最上位の要素に適用されるクラス。デフォルト値は 'ui-state-active' です。
-
ui-igedit-button-common ui-unselectable
- すべてのボタン コンテナーに適用されるクラス。デフォルト値は 'ui-igedit-button-common ui-unselectable ui-igedit-button-ltr ui-state-default' です。
-
ui-igedit-buttonhover ui-state-hover
- マウス オーバー状態のボタンの SPAN 要素に適用されるクラス。デフォルト値は 'ui-igedit-buttonhover ui-state-hover' です。
-
ui-igedit-buttonpressed ui-state-highlight
- 押下状態のボタンの SPAN 要素に適用されるクラス。デフォルト値は 'ui-igedit-buttonpressed ui-state-highlight' です。
-
ui-igedit-cleararea ui-state-default
- クリア ボタンを保持する DIV 要素に適用されるクラス。デフォルト値は 'ui-igedit-cleararea ui-state-default' です。
-
ui-igedit-buttonimage ui-icon-circle-close
- クリア ボタン画像を保持する DIV 要素に適用されるクラス。デフォルト値は 'ui-igedit-buttonimage ui-icon-circle-close ui-icon ui-igedit-buttondefault' です。
-
ui-igedit ui-igedit-container ui-widget ui-corner-all ui-state-default
- エディターがコンテナーに描画される場合に最上位の要素に適用されるクラス。デフォルト値は、'ui-igedit ui-igedit-container ui-widget ui-corner-all ui-state-default' です。
-
ui-state-disabled
- 無効な状態の編集要素に適用されるクラス。デフォルト値は 'ui-igedit-disabled ui-state-disabled' です。
-
ui-igedit-dropdown-button
- ドロップ ダウン ボタンを保持する DIV 要素に適用されるクラス。デフォルト値は 'ui-igedit-dropdown-button' です。
-
ui-icon ui-icon-triangle-1-s ui-igedit-buttonimage
- ドロップ ダウン ボタン画像を保持する DIV 要素に適用されるクラス。デフォルト値は、'ui-icon ui-icon-carat-1-s ui-igedit-buttonimage' です。
-
ui-igedit-dropdown ui-widget
- listitems を保持するコンテナーに適用されるクラス。デフォルト値は 'ui-igedit-dropdown' です。
-
ui-igedit-input
- メイン/最上位の要素に適用されるクラス。デフォルト値は 'ui-igedit-input' です。
-
ui-igeditor-input-container ui-corner-all
- 編集可能な入力をラップする div に適用されたクラス (multiline textarea の場合)。デフォルト値は、"ui-igeditor-input-container ui-corner-all"。
-
ui-state-focus
- エディターがフォーカスされるときに最上位の要素に適用されるクラス。デフォルト値は 'ui-state-focus' です。
-
ui-state-hover
- エディターがホバーされるときに最上位の要素に適用されるクラス。デフォルト値は 'ui-state-hover' です。
-
ui-igedit-listitem ui-state-default
- ドロップダウン リスト内の項目を表す SPAN 要素に適用されるクラス。デフォルト値は 'ui-igedit-listitem ui-state-default' です。
-
ui-state-active ui-igedit-listitemactive
- ドロップダウン リスト内のアクティブ項目を表す SPAN 要素に適用されるクラスに適用されるクラス。デフォルト値は 'ui-igedit-listitemselected ui-state-highlight' です。
-
ui-igedit-listitemhover ui-state-hover
- マウス オーバー状態のドロップダウン リスト内の項目を表す SPAN 要素に適用されるクラスに適用されるクラス。デフォルト値は 'ui-igedit-listitemhover ui-state-hover' です。
-
ui-igedit-listitemselected ui-state-highlight
- ドロップダウン リスト内の選択項目を表す SPAN 要素に適用されるクラスに適用されるクラス。デフォルト値は 'ui-igedit-listitemselected ui-state-highlight' です。
-
ui-igedit-placeholder
- plaseHolder オプションを設定した場合に表示可能な入力に適用されるクラス。このクラスは、スタイリングのみに関連します。デフォルト値は 'ui-igedit-placeholder' です。
-
ui-igedit-spinlowerimage ui-icon-carat-1-s ui-icon
- スピン ダウン画像を保持する DIV 要素に適用されるクラス。デフォルト値は、'ui-igedit-spinlowerimage ui-icon-carat-1-s ui-icon ui-igedit-buttondefault ui-igedit-spinbutton ui-igedit-buttonimage' です。
-
ui-igedit-spinupperimage ui-icon-carat-1-n ui-icon
- スピン アップ画像を保持する DIV 要素に適用されるクラス。デフォルト値は、'ui-igedit-spinupperimage ui-icon-carat-1-n ui-icon ui-igedit-buttondefault ui-igedit-spinbutton ui-igedit-buttonimage' です。
-
ui-igedit-textarea
- textMode が 'multiline' に設定される場合、可視 textarea 要素に適用されるクラス。