34.3.11 Fieldsオブジェクト

エミュレータ画面のフィールドオブジェクトをリストで保持するオブジェクトです。Fieldsオブジェクトを使用するには、screenオブジェクトのfieldsメソッドでオブジェクトの取得が必要です。

メソッド名	機能
Filter	指定したセレクターで絞り込んだ結果のFieldsオブジェクトを取得
Get	指定したインデックスのフィールドを取得
GetNextField	Fieldsオブジェクトが保持する各フィールドより指定した先にあるフィールドを取得
GetNextInputField	Fieldsオブジェクトが保持する各フィールドの次の非保護フィールドを取得
Next	Fieldsオブジェクトが保持する各フィールドの次のフィールドを取得
Prev	Fieldsオブジェクトが保持する各フィールドの前のフィールドを取得

プロパティ名	設定	参照	機能
Length	-	○	Fieldsオブジェクトが保持するフィールド数

■Filter

セレクターで絞り込んだFieldsオブジェクトの取得

指定したセレクターで絞り込んだ結果から、Fieldsオブジェクトを取得します。

●呼び出し形式

Filter(selector)

●パラメータ

パラメータ	説明	省略時の初期値
selector	Fieldsオブジェクトが保持するFieldオブジェクトのリストから抽出する条件を指定抽出条件はScreenオブジェクトのGetFieldsメソッドを参照	すべて("*")

●リターン値

関数の呼び出しに成功すると取得したFieldsオブジェクトを返します。一致する文字列が見つからなかった場合、およびエラーが発生した場合は、FieldsオブジェクトのLengthプロパティが0のFieldsオブジェクトを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

●C#を用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var fields = dspemu.Screen.GetFields("担当");  // 文字列「担当」を含むFieldsオブジェクトを取得
fields = fields.Filter("{attr: 'protect'}"); // 保護フィールドで絞り込み

■Get

指定したインデックスのフィールドを取得

指定したインデックス位置に存在するフィールドを取得します。

●呼び出し形式

Get(index)

●パラメータ

パラメータ	説明	省略時の初期値
index	Fieldオブジェクトのインデックス位置(0以上)	省略できません

●リターン値

関数の呼び出しに成功すると指定位置のFieldオブジェクトを返します。エラーが発生した場合はnullを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

●C#を用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var fields = dspemu.Screen.GetFields("担当");  // 文字列「担当」を含むfieldsオブジェクトを取得
for (var i = 0; i < fields.Length; i++) {
    var field = fields.get(i); 
}

■GetNextField

Fieldsオブジェクトより指定した先に存在するFieldsオブジェクトを取得

Fieldsオブジェクトが保持するすべてのフィールドより取得したFieldsオブジェクトから、指定数分先に存在するFieldsオブジェクトを取得します。

●呼び出し形式

GetNextField(index)

●パラメータ

パラメータ	説明	省略時の初期値
index	取得対象のFieldオブジェクトまでの数を指定	1

●リターン値

関数の呼び出しに成功すると取得したFieldsオブジェクトを返します。フィールドが見つからなかった場合、およびエラーが発生した場合はFieldsオブジェクトのLengthプロパティが0のFieldsオブジェクトを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

●C#を用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var fields = dspemu.Screen.GetFields("ユーザID");  // 文字列"ユーザID"を含むFieldsオブジェクトを取得
fields = fields.GetNextField(2); // 2つ先のフィールドを含むFieldsオブジェクトの取得

■GetNextInputField

Fieldsオブジェクトの次の非保護フィールドのFieldsオブジェクトを取得

Fieldsオブジェクトが保持するすべての非保護フィールドより、次の非保護フィールドを保持するFieldsオブジェクトを取得します。

●呼び出し形式

GetNextInputField()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると取得したFieldsオブジェクトを返します。フィールドが見つからなかった場合、およびエラーが発生した場合はFieldsオブジェクトのlengthプロパティが0のFieldsオブジェクトを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

●C#を用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var fields = dspemu.Screen.GetFields("ユーザID");  // 文字列"ユーザID"を含むFieldsオブジェクトを取得
fields = fields.GetNextInputField(); // フィールドの次の非保護フィールドを含むFieldsオブジェクトの取得

■Next

Fieldsオブジェクト内の次のFieldsオブジェクトを取得

Fieldsオブジェクトが保持するすべてのフィールドより現在のフィールドの次のフィールドから、Fieldsオブジェクトを取得します。

●呼び出し形式

Next()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると次のFieldsオブジェクトを返します。現在のフィールドが最終フィールドで、次のフィールドが存在しない場合、およびエラーの場合はFieldsオブジェクトのLengthプロパティが0のFieldsオブジェクトを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

●C#を用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var fields = dspemu.Screen.GetFields("{attr: 'protect'}");  // 保護フィールドのFieldsオブジェクトを取得
fields = fields.Next(); //次のフィールドを含む、Fieldsオブジェクトを取得

■Prev

Fieldsオブジェクト内の前のFieldsオブジェクトを取得

Fieldsオブジェクトが保持するすべてのオブジェクトより、現在のフィールドの前のフィールドから、Fieldsオブジェクトを取得します。

●呼び出し形式

Prev()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると前のFieldsオブジェクトを返します。現在のフィールドが先頭フィールドで、前のフィールドが存在しない場合、およびエラーの場合はFieldsオブジェクトのLengthプロパティが0のFieldsオブジェクトを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

●C#を用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var fields = dspemu.Screen.GetFields("{attr : 'unprotect'}");  // 非保護フィールドのFieldsオブジェクトを取得
fields = fields.Prev(); //前のフィールドを含むFieldsオブジェクトを取得