ui.igValidator
コード サンプル
<!DOCTYPE html> <html> <head> <!--Ignite UI Required Combined CSS Files--> <link href="css/themes/infragistics/infragistics.theme.css" rel="stylesheet" /> <link href="css/themes/infragistics/infragistics.ui.popover.css" rel="stylesheet" /> <link href="css/themes/infragistics/infragistics.ui.notifier.css" rel="stylesheet" /> <link href="css/themes/infragistics/infragistics.ui.editors.css" rel="stylesheet" /> <link href="css/themes/infragistics/infragistics.ui.shared.css" rel="stylesheet" /> <link href="css/structure/infragistics.css" rel="stylesheet" /> <script src="js/modernizr-latest.js"></script> <script src="js/jquery.js"></script> <script src="js/jquery-ui.js"></script> <!--Ignite UI Required Combined JavaScript Files--> <script src="js/infragistics.core.js"></script> <script src="js/infragistics.lob.js"></script> <script type="text/javascript"> $(document).ready(function () { $('#validator').igTextEditor({ placeHolder: "User name" }); $('#validator').igValidator({ notificationOptions: { direction: "right", showIcon: "true", mode:"popover" }, required:true }); }); </script> </head> <body> <input id="validator"/> </body> </html>
関連サンプル
関連トピック
依存関係
-
creditCard
- タイプ:
- enumeration
- デフォルト:
- false
クレジット カード番号検証ルールのオプションを取得または設定します。注: このルールは、カード型に関係なく Luhn アルゴリズムを使用して番号のチェックサムを検証します。
メンバー
- boolean
- タイプ:bool
- フィールドが有効なクレジット カード番号かどうかを指定するブール値。
- object
- タイプ:object
- 構成オブジェクトおよびオプションのエラー メッセージ (例: creditCard: { errorMessage: "有効なカード番号を入力してください"} )。
コード サンプル
//Initialize $('.selector').igValidator({ creditCard: true }); //OR $('.selector').igValidator({ creditCard: { errorMessage : "Enter a valid card number" } }); //Get var creditCard = $('.selector').igValidator("option", "creditCard"); //Set $('.selector').igValidator("option", 'creditCard', true);
-
custom
- タイプ:
- enumeration
- デフォルト:
- null
検証を実行するためのカスタム関数を取得または設定します。「this」を使用して、呼び出される検証コントロールを参照します。値およびオプションのフィールド設定引数を使用して、フィールドの状態を決定して返します。
メンバー
- function
- タイプ:function
- 呼び出す関数。
- string
- タイプ:string
- グローバル名前空間の関数名 (window["name"])。
- object
- タイプ:object
- method プロパティが関数である構成オブジェクト、およびオプションのエラー メッセージ。
コード サンプル
//Initialize $('.selector').igValidator({ custom: function(value, fieldOptions){ return false; } }); //OR $('.selector').igValidator({ custom: { method: function(value, fieldOptions){ return false; }, errorMessage : "Value did not match" } }); //Get var custom = $(".selector").igValidator("option", "custom"); //Set var custom = { method: function (value, fieldOptions) { return false; }, errorMessage: "This field is required." }; $(".selector").igValidator("option", "custom", custom);
-
date
- タイプ:
- enumeration
- デフォルト:
- false
日付検証ルールのオプションを取得または設定します。valueRange 検証に便利です。注: JavaScript Date の解析に依存関係があります。値の広い範囲を承諾します。
メンバー
- boolean
- タイプ:bool
- フィールドが有効な JavaScript Date であるか、解析可能である必要かどうかを示すブール値。
- object
- タイプ:object
- 構成オブジェクトおよびオプションのエラー メッセージ (例: date: { errorMessage: "有効な数値を入力してください"} )。
コード サンプル
//Initialize $('.selector').igValidator({ date: true }); //OR $('.selector').igValidator({ date: { errorMessage: "Not a valid date" } }); //Get var date = $(".selector").igValidator("option", "date"); //Set $(".selector").igValidator("option", "date", true);
-
email
- タイプ:
- enumeration
- デフォルト:
- false
メール検証ルールのオプションを取得または設定します。"$.ui.igValidator.defaults" オブジェクトに定義される RegExp を使用します。
メンバー
- boolean
- タイプ:bool
- フィールドがメール アドレスかどうかを指定するブール値。
- object
- タイプ:object
- 構成オブジェクトおよびオプションのエラー メッセージ (例: email: { errorMessage: "有効なメール アドレスを入力してください"} )。
コード サンプル
//Initialize $('.selector').igValidator({ email: true } //OR $('.selector').igValidator({ email: { errorMessage : "Enter a valid email" } }); //Get var email = $(".selector").igValidator("option", "email"); //Set $(".selector").igValidator("option", "email", true);
-
equalTo
- タイプ:
- enumeration
- デフォルト:
- null
このフィールドの値が別の入力要素、またはエディター コントロールと同じである必要性を取得または設定します。
メンバー
- string
- タイプ:string
- ターゲット要素の有効な jQuery セレクター。
- object
- タイプ:object
- ターゲットの jQuery オブジェクトへの参照、または selector プロパティおよびカスタム errorMessage のオブジェクト。
コード サンプル
//Initialize $('.selector').igValidator({ equalTo: "#field1" }); //OR $('.selector').igValidator({ equalTo: { selector: "#myEditor" errorMessage: "Value did not match." } }); //Get var equalTo = $(".selector").igValidator("option", "equalTo"); //Set $(".selector").igValidator("option", "equalTo", "#field1");
-
errorMessage
- タイプ:
- string
- デフォルト:
- null
特定のルールで設定されていない場合、error-message のテキストを取得または設定します。デフォルトのルール固有のエラー メッセージをオーバーライドします。
コード サンプル
//Initialize $('.selector').igValidator({ errorMessage: 'This field is required!' }); //Get var errorMessage = $(".selector").igValidator("option", "errorMessage"); //Set $(".selector").igValidator("option", "errorMessage", 'This field is required!');
-
executeAllRules
- タイプ:
- bool
- デフォルト:
- false
フィールドのすべてのルールをチェックすべきかどうかを取得または設定します。
注: 値なしで通常実行しないルールの空フィールドのチェックは強制しません。コード サンプル
//Initialize $('.selector').igValidator({ executeAllRules: true }); //Get var executeAllRules = $(".selector").igValidator("option", "executeAllRules"); //Set $(".selector").igValidator("option", "executeAllRules", true);
-
fields
- タイプ:
- array
- デフォルト:
- []
- 要素タイプ:
- object
検証オプションおよび必須なセレクターをもつ項目を説明するターゲット フィールド項目のリストを取得します。フィールドが任意の検証ルールおよびトリガーを含みますが、その他のフィールドまたはイベント ハンドラーを含みません。
適切なオプションが設定されない場合、グローバル コントロール構成から継承されます。コード サンプル
//Initialize $('.selector').igValidator({ fields: [{ selector: "#input1", required: true, number: true, onblur: false }, { selector: "#input2", lengthRange: { min: 2, max: 10 }, onchange: true }] }); //Get var fields = $(".selector").igValidator("option", "fields");
-
selector
- タイプ:
- enumeration
- デフォルト:
- null
検証するためのターゲット要素 (入力またはコントロール対象要素) を取得します。このフィールド設定は必須です。
メンバー
- string
- タイプ:string
- 要素の有効な jQuery セレクター。
- object
- タイプ:object
- jQuery オブジェクトへの参照。
コード サンプル
//Initialize $('.selector').igValidator({ fields: [{ selector: "#input1" }, { selector: "#input2" }] });
-
language
継承- タイプ:
- string
- デフォルト:
- "en"
ウィジェットのロケール言語設定を取得または設定します。
コード サンプル
//Initialize $(".selector").igValidator({ language: "ja" }); // Get var language = $(".selector").igValidator("option", "language"); // Set $(".selector").igValidator("option", "language", "ja");
-
lengthRange
- タイプ:
- enumeration
- デフォルト:
- null
テキストの最小および最大長、または選択した項目の最小数および最大数を取得または設定します。null または 0 値は無視されます。
メンバー
- array
- タイプ:array
- 2 つの数字の配列。最初の値が最小値、最後の値が最大値です。(例: lengthRange: [ 1, 10] )。
- object
- タイプ:object
- オプションのエラー メッセージをもつ構成オブジェクト。メッセージ文字列は最小値と最大値の形式を含めます (engthRange: { min: 6, max: 20, errorMessage: 「パスワードは {0} 以上 {1} 以下でなければなりません 」} など)。
コード サンプル
//Initialize $('.selector').igValidator({ lengthRange: [2, 6] }); //OR $('.selector').igValidator({ lengthRange: { min: 2, max: 6, errorMessage: "Must be at least {0} long and no more than {1}." } }); //Get var lengthRange = $(".selector").igValidator("option", "lengthRange"); //Set $(".selector").igValidator("option", "lengthRange", [2, 6]);
-
locale
継承- タイプ:
- object
- デフォルト:
- null
ウィジェットのロケール設定を取得または設定します。
コード サンプル
//Initialize $(".selector").igValidator({ locale: {} }); // Get var locale = $(".selector").igValidator("option", "locale"); // Set $(".selector").igValidator("option", "locale", {});
-
messageTarget
- タイプ:
- domelement
- デフォルト:
- null
検証メッセージに使用されるカスタム jQuery 要素を取得または設定します。ターゲットの innerHTML 属性が変更されます。ターゲットは SPAN、LABEL、または DIV が可能です。
コード サンプル
//Initialize $('.selector').igValidator({ messageTarget: "#field1" }); //Get var messageTarget = $(".selector").igValidator("option", "messageTarget"); //Set $(".selector").igValidator("option", "messageTarget", "#field1");
-
notificationOptions
- タイプ:
- object
- デフォルト:
- null
エラー メッセージを表示するための igNotifier のオプションを取得または設定します。
コード サンプル
//Initialize $('.selector').igValidator({ notificationOptions: { direction: "right", showIcon: "true", mode:"popover", messages: { error: "This field is required!" } } }); //Get var notificationOptions = $(".selector").igValidator("option", "notificationOptions"); //Set var notificationOptions = { direction: "right", showIcon: "true", mode:"popover", messages: { error: "This field is required!" }; $(".selector").igValidator("option", "notificationOptions", notificationOptions);
-
number
- タイプ:
- enumeration
- デフォルト:
- false
数値検証ルールのオプションを取得または設定します。10 進および 1000 進のデフォルトのセパレーター文字は「.」および 「,」で、"$.ui.igValidator.defaults" オブジェクトに定義されます。
メンバー
- boolean
- タイプ:bool
- フィールドが数値かどうかを指定するブール値。デフォルトのセパレーター文字が使用されます。
- object
- タイプ:object
- errorMessage、decimalSeparator、および thousandsSeparator を持つ構成オブジェクト。そのプロパティはすべてオプションです。
コード サンプル
//Initialize $('.selector').igValidator({ number: true }); //OR $('.selector').igValidator({ number: { errorMessage : "Not a valid number", decimalSeparator: ".", thousandsSeparator: " " } }); //Get var number = $(".selector").igValidator("option", "number"); //Set $(".selector").igValidator("option", "number", true);
-
onblur
- タイプ:
- bool
- デフォルト:
- true
エディターがフォーカスを失ったときに検証がトリガーされるかどうかを取得または設定します。
コード サンプル
//Initialize $('.selector').igValidator({ onblur: true }); //Get var onblur = $(".selector").igValidator("option", "onblur"); //Set $(".selector").igValidator("option", "onblur", true);
-
onchange
- タイプ:
- bool
- デフォルト:
- false
エディターのテキストが変更されたときに検証がトリガーされるかどうかを取得または設定します。注: チェックボックス、コンボ、レーティングなどの選択コントロールに適用します。テキスト フィールドでメッセージが多くなる可能性があるため、最初の検証が threshold オプションによって遅延できます。
コード サンプル
//Initialize $('.selector').igValidator({ onchange: true }); //Get var onchange = $(".selector").igValidator("option", "onchange"); //Set $(".selector").igValidator("option", "onchange", true);
-
onsubmit
- タイプ:
- bool
- デフォルト:
- true
検証ターゲットを含むフォームが送信中の場合に検証がトリガーされるかどうかを取得または設定します。検証が失敗した場合、送信できません。ネイティブな JavaScript submit 関数に適用しませんが、jQuery の submit 関数およびブラウザーのデフォルト操作を処理します。
コード サンプル
//Initialize $('.selector').igValidator({ onsubmit: true }); //Get var onsubmit = $(".selector").igValidator("option", "onsubmit"); //Set $(".selector").igValidator("option", "onsubmit", true);
-
optionalIndication
- タイプ:
- bool
- デフォルト:
- false
オプションのフィールドの隣にラベル通知を表示するためのオプションを取得または設定します。
注: チェック ボックスやオプション ボタンのようなグループ化されたコントロールおよび igRating コントロールの場合はインジケーターがサポートされません。コード サンプル
//Initialize $('.selector').igValidator({ optionalIndication: true }); //Get var optionalIndication = $(".selector").igValidator("option", "optionalIndication"); //Set $(".selector").igValidator("option", "optionalIndication", true);
-
pattern
- タイプ:
- enumeration
- デフォルト:
- null
正規表現検証ルールのオプションを取得または設定します。
メンバー
- string
- タイプ:string
- 正規表現を含む文字列。
- object
- タイプ:object
- RegExp オブジェクトまたは expression および errorMessage プロパティを持つオブジェクト。
コード サンプル
//Initialize $(".selector").igValidator({ pattern: "^\\d*\\.{0,1}\\d+$" }); //OR $('.selector').igValidator({ pattern: { expression: /^[a-z]+$/, errorMessage : "Value did not match" } }); //Get var pattern = $(".selector").igValidator("option", "pattern"); //Set $(".selector").igValidator("option", "pattern", "^\\d*\\.{0,1}\\d+$");
-
regional
継承- タイプ:
- enumeration
- デフォルト:
- defaults
ウィジェットの領域設定を取得または設定します。
コード サンプル
//Initialize $(".selector").igValidator({ regional: "ja" }); // Get var regional = $(".selector").igValidator("option", "regional"); // Set $(".selector").igValidator("option", "regional", "ja");
-
required
- タイプ:
- enumeration
- デフォルト:
- false
値 (空でないテキスト、選択項目など) が入力されたかどうかを検証するオプションを取得または設定します。
メンバー
- boolean
- タイプ:bool
- フィールドが必須であるかどうかを示すブール値。
- object
- タイプ:object
- オプションのエラー メッセージをもつ構成オブジェクト (必須: { errorMessage: 「エラー」} など))。
コード サンプル
//Initialize $('.selector').igValidator({ required: true }); //OR $('.selector').igValidator({ required: { errorMessage: "This field is required." } }); //Get var required = $(".selector").igValidator("option", "required"); //Set $(".selector").igValidator("option", "required", true);
-
requiredIndication
- タイプ:
- bool
- デフォルト:
- false
必須のフィールドの隣にアスタリスク表示を表示するためのオプションを取得または設定します。
注: チェック ボックスやオプション ボタンのようなグループ化されたコントロールおよび igRating コントロールの場合はインジケーターがサポートされません。コード サンプル
//Initialize $('.selector').igValidator({ requiredIndication: true }); //Get var requiredIndication = $(".selector").igValidator("option", "requiredIndication"); //Set $(".selector").igValidator("option", "requiredIndication", true);
-
successMessage
- タイプ:
- string
- デフォルト:
- null
成功メッセージのテキストを取得または設定します。デフォルト値がないため、このメッセージを設定すると、成功通知の表示を有効にします。
コード サンプル
//Initialize $('.selector').igValidator({ successMessage: "Well done!" }); //Get var successMessage = $(".selector").igValidator("option", "successMessage"); //Set $(".selector").igValidator("option", "successMessage", "Well done!");
-
threshold
- タイプ:
- number
- デフォルト:
- -1
最小の長さの入力の検証を取得または設定します。変更やぼかしでこの値にならない限り、入力の検証はトリガーされません。
注: フォームを送信するとき、必須のフィールドに影響しません。コード サンプル
//Initialize $('.selector').igValidator({ threshold: 1 }); //Get var threshold = $(".selector").igValidator("option", "threshold"); //Set $(".selector").igValidator("option", "threshold", 1);
-
valueRange
- タイプ:
- enumeration
- デフォルト:
- null
最小値および最大値を取得または設定します。null 値は無視されます。
メンバー
- array
- タイプ:array
- 2 つの数値または日付の配列。最初の値が最小値、最後の値が最大値です。(例: valueRange: [ 1, 10] )。
- object
- タイプ:object
- オプションのエラー メッセージをもつ構成オブジェクト。メッセージ文字列は最小値と最大値の形式を含めます (lengthRange: { min: 6, max: 20, errorMessage: 「値は {0} ~ {1} でなければなりません 」} など)。
コード サンプル
//Initialize $('.selector').igValidator({ valueRange: [2, 6] //OR $('.selector').igValidator({ valueRange: { min: 2, max: 6, errorMessage: "Value must be between {0} and {1}." } }); //Get var valueRange = $(".selector").igValidator("option", "valueRange"); //Set var range = [2, 6]; $(".selector").igValidator("option", "valueRange", range);
Ignite UI コントロール イベントの詳細については、
Ignite UI でイベントを使用するを参照してください。
-
error
- キャンセル可能:
- false
無効なフィールドの場合、値の検証後、なんらかの操作が有効になる前に発生するイベント。
関数は引数 evt および ui を受け取ります。-
evtタイプ: Event
jQuery イベント オブジェクト。
-
uiタイプ: Object
-
ownerタイプ: Object
igValidator ウィジェットへの参照を取得します。
-
valueタイプ: Object
ターゲット内の現在の値を取得します。
-
validタイプ: Bool
検証の結果を決定します。
-
messageタイプ: String
メッセージのテキストを取得します。
-
messagesタイプ: Array
すべてのメッセージを取得します。executeAllRules が有効な場合、1 つ以上が可能です。
-
ruleタイプ: String
非推奨。検証が失敗したルールの名前で生成されます。
-
rulesタイプ: Array
検証が失敗したルールの名前で生成されます。
-
fieldOptionsタイプ: Object
コレクションで指定したフィールドのオプションを含むか、null に設定されます。
-
コード サンプル
//Bind after initialization $(document).on("igvalidatorerror", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get current value in target ui.value; //get rules that failed validation ui.rules; //gets text of message ui.message; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ error: function (evt, ui) { ... } });
-
errorHidden
- キャンセル可能:
- false
エラー メッセージが非表示になった後に発生するイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorerrorhidden", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ errorHidden: function (evt, ui) { ... } });
-
errorHiding
- キャンセル可能:
- true
エラー メッセージが非表示になる前に発生するイベント。
エラー メッセージを表示し続けるには、False を返します。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorerrorhiding", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ errorHiding: function (evt, ui) {. ... } });
-
errorShowing
- キャンセル可能:
- true
エラー メッセージが表示される前に発生するイベント。
エラー メッセージが表示されないようにするには、False を返します。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorerrorshowing", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ errorShowing: function (evt, ui) { ... } });
-
errorShown
- キャンセル可能:
- false
エラー メッセージが表示された後に発生するイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorerrorshown", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ errorShown: function (evt, ui) { ... } });
-
formError
- キャンセル可能:
- false
フォームの送信イベントで検証を失敗した後で Validator インスタンス レベルにトリガーされるイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorformerror", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get reference of the event target form ui.target }); //Initialize $(".selector").igValidator({ formError: function (evt, ui) { ... } });
-
formSuccess
- キャンセル可能:
- false
フォームの送信イベントで検証を成功にした後で Validator インスタンス レベルにトリガーされるイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorformsuccess", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get reference of the event target form ui.target; }); //Initialize $(".selector").igValidator({ formSuccess: function (evt, ui) { ... } });
-
formValidated
- キャンセル可能:
- false
フォームの送信イベントで検証後で Validator インスタンス レベルにトリガーされるイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorformvalidated", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get reference of the event target form ui.target; //determine the outcome of the validation ui.valid; }); //Initialize $(".selector").igValidator({ formValidated: function (evt, ui) { ... } });
-
formValidating
- キャンセル可能:
- true
フォームの送信イベントを処理する前に Validator インスタンス レベルにトリガーされるイベント。
検証をスキップし、その他の検証コントロールがエラーを返さない場合、送信を許可することを可能になるために false を返します。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorformvalidating", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get reference of the event target form ui.target; }); //Initialize $(".selector").igValidator({ formValidating: function (evt, ui) { ... } });
-
success
- キャンセル可能:
- false
有効なフィールドの場合、値の検証後、なんらかの操作が有効になる前に発生するイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorsuccess", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get current value in target ui.value; //gets text of message, if any ui.message; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ success: function (evt, ui) { ... } });
-
successHidden
- キャンセル可能:
- false
成功メッセージが非表示になった後に発生するイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorsuccesshidden", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ successHidden: function (evt, ui) { ... } });
-
successHiding
- キャンセル可能:
- true
成功メッセージが非表示になる前に発生するイベント。
成功メッセージを表示し続けるには、False を返します。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorsuccesshiding", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ successHiding: function (evt, ui) { ... } });
-
successShowing
- キャンセル可能:
- true
成功メッセージが表示される前に発生するイベント。
成功メッセージが表示されないようにするには、False を返します。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorsuccessshowing", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ successShowing: function (evt, ui) { ... } });
-
successShown
- キャンセル可能:
- false
成功メッセージが表示された後に発生するイベント。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorsuccessshown", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //gets text of message ui.message; //get reference to the target of the message ui.target; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ successShown: function (evt, ui) { ... } });
-
validated
- キャンセル可能:
- false
値の検証後、なんらかの操作が有効になる前に発生するイベント。
関数は引数 evt および ui を受け取ります。-
evtタイプ: Event
jQuery イベント オブジェクト。
-
uiタイプ: Object
-
ownerタイプ: Object
igValidator ウィジェットへの参照を取得します。
-
valueタイプ: Object
ターゲット内の現在の値を取得します。
-
validタイプ: Bool
検証の結果を決定します。
-
messageタイプ: String
メッセージのテキストを取得します。
-
messagesタイプ: Array
メッセージがある場合、すべてのメッセージを取得します。executeAllRules が有効な場合、1 つ以上が可能です。
-
ruleタイプ: String
非推奨。検証が失敗したルールがある場合、その名前で生成されます。
-
rulesタイプ: Array
検証が失敗したルールがある場合、名前で生成されます。
-
fieldOptionsタイプ: Object
コレクションで指定したフィールドのオプションを含むか、null に設定されます。
-
コード サンプル
//Bind after initialization $(document).on("igvalidatorvalidated", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get current value in target ui.value; //determine the outcome of the validation ui.valid; }); //Initialize $(".selector").igValidator({ validated: function (evt, ui) { ... } });
-
validating
- キャンセル可能:
- true
検証時、デフォルトの検証ロジックが適用される前に発生するイベント。
イベントをキャンセルし、フィールドを有効として実行するために false を返します。
関数は引数 evt および ui を受け取ります。コード サンプル
//Bind after initialization $(document).on("igvalidatorvalidating", ".selector", function (evt, ui) { //get reference to the igValidator widget ui.owner; //get current value in target ui.value ; //get the options of the specific field in the collection ui.fieldOptions; }); //Initialize $(".selector").igValidator({ validating: function (evt, ui) { ... } });
-
addField
- .igValidator( "addField", field:object );
フィールド コレクションに新しい入力を追加し、検証コントロールで初期化します。注: 検証コントロールがコレクションで作成された場合にのみ追加のフィールドが適用されます。
- field
- タイプ:object
- フィールド セレクターおよびオプションをもつオブジェクト。
コード サンプル
var field = { selector: "#input1", required: true, number: true, onblur: false }; $(".selector").igValidator("addField",field);
-
changeGlobalLanguage
継承- .igValidator( "changeGlobalLanguage" );
ウィジェットの言語をグローバルの言語に変更します。グローバルの言語は $.ig.util.language の値です。
コード サンプル
$(".selector").igValidator("changeGlobalLanguage");
-
changeGlobalRegional
継承- .igValidator( "changeGlobalRegional" );
ウィジェットの地域設定をグローバルの地域設定に変更します。グローバルの地域設定は $.ig.util.regional にあります。
コード サンプル
$(".selector").igValidator("changeGlobalRegional");
-
changeLocale
継承- .igValidator( "changeLocale", $container:object );
指定したコンテナーに含まれるすべてのロケールを options.language で指定した言語に変更します。
注: このメソッドは珍しいシナリオのみで使用されます。language または locale オプションのセッターを参照してください。- $container
- タイプ:object
- オプションのパラメーター: 設定しない場合、ウィジェットの要素を $container として使用します。
コード サンプル
$(".selector").igValidator("changeLocale");
-
destroy
- .igValidator( "destroy" );
検証コントロール ウィジェットを破棄します。
コード サンプル
$(".selector").igValidator("destroy");
-
getErrorMessages
- .igValidator( "getErrorMessages", [field:object] );
- 返却型:
- array
- 返却型の説明:
- すべての現在のエラー メッセージの配列。
無効なフィールドのすべての現在のエラー メッセージを取得します。このメソッドが検証を実行せずに、状態およびメッセージが検証のみで更新されるため、
formValidated イベントまたは validate/isValid メソッド呼び出しの後にこれを使用できます。- field
- タイプ:object
- オプション
- エラー メッセージを取得する単一のフィールドのオプションのフィールド オブジェクト、セレクター、または 0 から始まるインデックス。
コード サンプル
var getErrorMessages = $(".selector").igValidator("getErrorMessages","#field1");
-
hide
- .igValidator( "hide", [field:object] );
messageTarget または igNotifier の可能なメッセージを非表示にします。
注: validator がフィールド コレクションを持つ場合、フィールドを渡さない場合、すべてのフィールドでメッセージを非表示にします。- field
- タイプ:object
- オプション
- メッセージを非表示するオプションのフィールド オブジェクト、セレクター、または 0 から始まるインデックス。
コード サンプル
$(".selector").igValidator("hide");
-
isMessageDisplayed
- .igValidator( "isMessageDisplayed", [field:object] );
- 返却型:
- bool
- 返却型の説明:
- 現在表示されているメッセージがある場合は True。
表示されているメッセージがあるかどうかを確認します。オプション フィールドを使用します。
注: validator がフィールド コレクションを持つ場合、フィールドを渡さない場合、単一のフィールドのみに表示されるメッセージがあっても true を返します。- field
- タイプ:object
- オプション
- エラー メッセージを取得する単一のフィールドのオプションのフィールド オブジェクト、セレクター、または 0 から始まるインデックス。
コード サンプル
var isMessageDisplayed = $(".selector").igValidator("isMessageDisplayed","#field1");
-
isValid
- .igValidator( "isValid", [field:object] );
- 返却型:
- bool
- 返却型の説明:
- フイールドがすべての検証を通過した場合は True。
検証をトリガーしますがエラー メッセージを表示しません。
- field
- タイプ:object
- オプション
- 確認するオプションのフィールド オブジェクト、セレクター、または 0 から始まるインデックス。フィールド コレクションの場合にのみ有効で他のフィールドはスキップします。
コード サンプル
var isValid = $(".selector").igValidator("isValid");
-
notifier
- .igValidator( "notifier", [field:object] );
- 返却型:
- object
- 返却型の説明:
- igNotifier への参照、または無効なフィールドの場合は null。
igValidator または単一のフィールドの notifier を取得します。
- field
- タイプ:object
- オプション
- notifier を取得するオプションのフィールド オブジェクト、セレクター、または 0 から始まるインデックス。
コード サンプル
var notifier = $(".selector").igValidator("notifier");
-
removeField
- .igValidator( "removeField", field:object );
フィールド コレクションから入力を削除します。
- field
- タイプ:object
- 削除されるフィールド オブジェクト、そのゼロから始まるインデックス、またはセレクター。
コード サンプル
$(".selector").igValidator("removeField","#input1");
-
updateField
- .igValidator( "updateField", field:object, [fieldOptions:object] );
検証コントロール コレクションのフィールドを更新します。コントロールが validator の後に作成された場合にフィールドを再初期化するか、新しいオプションを渡すために使用されます。
- field
- タイプ:object
- 更新されるフィールド オブジェクト、そのゼロから始まるインデックス、またはセレクター。
- fieldOptions
- タイプ:object
- オプション
- フィールドに適用される新しいオプション。
コード サンプル
var newOptions = { required: true, number: true, onblur: false }; $(".selector").igValidator("updateField","#input1", newOptions);
-
validate
- .igValidator( "validate", [field:object] );
- 返却型:
- bool
- 返却型の説明:
- フイールドがすべての検証を通過した場合は True。
検証をトリガーし、無効なフィールドでエラーを表示します。
- field
- タイプ:object
- オプション
- 検証されるオプションのフィールド オブジェクト。フィールド コレクションの場合にのみ有効で他のフィールドはスキップします。
コード サンプル
var validate = $(".selector").igValidator("validate");
-
ui-igvalidator-optional-indication
- オプション フィールドの隣の表示スパンに適用されるクラス。
-
ui-igvalidator-required-indication
- オプション フィールドの隣のアスタリスク表示スパンに適用されるクラス。
-
ui-igvalidator-target
- 検証をもつターゲット要素に適用されるクラス。視覚効果がありません。