34.3.10 Fieldオブジェクト

エミュレータ画面のフィールド情報を参照、および操作するためのオブジェクトです。Fieldオブジェクトを使用するには、ScreenオブジェクトのFindFieldメソッドでオブジェクトの取得が必要です。

メソッド名	機能
GetColor	フィールドカラー値の取得
GetEndCol	フィールドの終了桁位置を取得
GetEndPos	フィールド終了位置の取得
GetEndRow	フィールドの終了行位置を取得
GetName	フィールドに設定した名前を取得
GetNextField	指定した先にあるフィールドオブジェクトを取得
GetNextInputField	次の非保護フィールドのFieldオブジェクトを取得
GetStartCol	フィールドの開始桁位置を取得
GetStartPos	フィールド開始位置の取得
GetStartRow	フィールドの開始行位置を取得
GetText	フィールド文字列の取得
IsAutoEnter	オートエンターフィールドの判定
IsBlink	ブリンクフィールドの判定
IsComplete	完全入力フィールドの判定
IsEscape	脱出要求フィールドの判定
IsHilight	高輝度フィールドの判定
IsInput	非保護フィールドの判定
IsKana	かなフィールドの判定
IsKonzai	混在フィールドの判定
IsLightpen	ライトペン検出可能フィールドの判定
IsNihongo	日本語フィールドの判定
IsNumeric	数字フィールドの判定
IsProtected	保護フィールドの判定
IsReverse	反転フィールドの判定
IsTrigger	トリガーフィールドの判定
IsUnderScore	下線フィールドの判定
IsVisible	可視フィールドの判定
Next	次のFieldオブジェクトを取得
Prev	前のFieldオブジェクトを取得
SetName	フィールドに名前を設定
SetText	フィールドに文字列を入力

プロパティ名	設定	参照	機能
Length	－	○	フィールド長を取得 ※フィールドアトリビュートは含まれません

プロパティ名

設定

参照

機能

Length

－

○

フィールド長を取得

※フィールドアトリビュートは含まれません

■ GetColor

フィールドカラー値の取得

フィールドより表示カラーの値を取得します。

●呼び出し形式

GetColor()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとカラーを示す値の文字列を返します。

返却される文字列	説明
Default	背景色（初期値）
Blue	青
Red	赤
Magenta	マゼンタ
Green	緑
Cyan	シアン
Yellow	黄
white	白

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var color = field.GetColor();                        // 上記のカラー値を取得

■GetEndCol

フィールドの終了桁位置を取得

フィールドの終了桁位置を取得します。

●呼び出し形式

GetEndCol()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとフィールドの終了桁位置を返します。エラーが発生した場合は-1を返します。エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var col = field.GetEndCol(); // フィールドの終了桁位置を取得

■GetEndPos

フィールド終了位置の取得

フィールドの終了位置のアドレスを取得します。

●呼び出し形式

GetEndPos()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとフィールドの終了位置のアドレスを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var addr = field.GetEndPos();                    // フィールドの終了位置を取得

■GetEndRow

フィールドの終了行位置を取得

フィールドの終了行位置を取得します。

●呼び出し形式

GetEndRow()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとフィールドの終了行位置を返します。エラーが発生した場合は-1を返します。エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var row = field.GetEndRow(); // フィールドの終了行位置を取得

■ GetName

フィールドに設定した名前を取得

フィールドに設定した名前を取得します。

●呼び出し形式

GetName ()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとフィールド名を返します。名前が設定されていない場合、およびエラーが発生した場合は空文字を返します。エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

var field = dspemu.Screen.FindField("担当者");  // 文字列「担当者」を含むFieldオブジェクトを取得
var name = field.GetName(); // フィールドの名前を取得

■GetNextField

指定した先に存在するフィールドオブジェクトを取得

エミュレータ画面より取得したFieldオブジェクトから、指定数分先に存在するFieldオブジェクトを取得します。

●呼び出し形式

GetNextField(index)

●パラメータ

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

●リターン値

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

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

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

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

■GetNextInputField

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

エミュレータ画面より取得したFieldオブジェクトの次に定義されている入力フィールドを取得します。

●呼び出し形式

GetNextInputField()

●パラメータ

ありません

●リターン値

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

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

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

■GetStartCol

フィールドの開始桁位置を取得

フィールドの開始桁位置を取得します。

●呼び出し形式

GetStartCol()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとフィールドの開始桁位置を返します。エラーが発生した場合は-1を返します。エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var col = field.GetStartCol(); // フィールドの開始桁位置を取得

■GetStartPos

フィールド開始位置の取得

フィールドの開始位置のアドレスを取得します。

●呼び出し形式

GetStartPos()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとフィールドの開始位置のアドレスを返します

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var addr = field.GetStartPos();                    // フィールドの開始位置を取得

■GetStartRow

フィールドの開始行位置を取得

フィールドの開始行位置を取得します。

●呼び出し形式

GetStartRow()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとフィールドの開始行位置を返します。エラーが発生した場合は-1を返します。エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var row = field.GetStartRow(); // フィールドの開始行位置を取得

■GetText

フィールド文字列の取得

フィールド内の文字列を取得します。

●呼び出し形式

GetText()

●パラメータ

パラメータはありませんが、リモートフォントをコード値で取得する場合は、次の関連プロパティをあらかじめ設定してください。

プロパティ	説明	省略時の初期値
TextCodeType	エミュレータ画面から取得する文字列に含まれるリモートフォントをコード値で取得するか指定します。 'mixed'：リモートフォントをコード変換した際に無効文字(■)に変換された文字をコード値で取得します。コード値例：[80A1] 'mixed'以外が指定された場合は、コード変換した文字を取得します。	""空文字

参考

TextCodeTypeプロパティに'mixed'を指定した場合、指定範囲に含まれる「[」はエスケープされ「[[」として取得されます。

●リターン値

関数の呼び出しに成功するとフィールドの文字列を返します。フィールドに文字が存在しない場合、またはエラーが発生した場合は空文字を返します。エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むfieldオブジェクトを取得
var text = field.GetText(); // フィールドの文字を取得

■IsAutoEnter

オートエンターフィールドの判定

フィールドがオートエンターフィールドであるかを判定します。

●呼び出し形式

IsAutoEnter()

●パラメータ

ありません

●リターン値

オートエンターフィールドの場合はtrueを返します。オートエンターフィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.SsAutoEnter())                    // オートエンターフィールドかどうか
    Cosole.WriteLine("フィールドはオートエンターフィールドです");

■IsBlink

ブリンクフィールドの判定

フィールドがブリンクフィールドであるかを判定します。

●呼び出し形式

IsBlink()

●パラメータ

ありません

●リターン値

ブリンクフィールドの場合はtrueを返します。ブリンクフィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsBlink())                    // ブリンクフィールドかどうか
    Console.WriteLine("フィールドはブリンクフィールドです");

■IsComplete

完全入力フィールドの判定

フィールドが完全入力フィールドであるかを判定します。

●呼び出し形式

IsComplete()

●パラメータ

ありません

●リターン値

完全入力フィールドの場合はtrueを返します。完全入力フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsComplete())                    // 完全入力フィールドかどうか
    console.WriteLine("フィールドは完全入力フィールドです");

■IsEscape

脱出要求フィールドの判定

フィールドが脱出要求フィールドであるかを判定します。

●呼び出し形式

IsEscape()

●パラメータ

ありません

●リターン値

脱出要求フィールドの場合はtrueを返します。脱出要求フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsEscape())                    // 脱出要求フィールドかどうか
    console.WriteLine("フィールドは脱出要求フィールドです");

■IsHilight

高輝度フィールドの判定

フィールドが高輝度フィールドであるかを判定します。

●呼び出し形式

IsHilight()

●パラメータ

ありません

●リターン値

高輝度フィールドの場合はtrueを返します。高輝度フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsHilight())                    // 高輝度フィールドかどうか
    console.WriteLine("フィールドは高輝度フィールドです");

■IsInput

非保護フィールドの判定

非保護フィールドを判定します。

●呼び出し形式

IsInput()

●パラメータ

ありません

●リターン値

非保護フィールドの場合、trueを返します。非保護フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsInput()) {    // フィールドが非保護フィールドかどうか
    console.WriteLine("フィールドは非保護フィールドです");
}

■IsKana

かなフィールドの判定

フィールドがかなフィールドであるかを判定します。

●呼び出し形式

IsKana()

●パラメータ

ありません

●リターン値

かなフィールドの場合はtrueを返します。かなフィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsKana())                    // かなフィールドかどうか
    console.WriteLine("フィールドはかなフィールドです");

■IsKonzai

混在フィールドの判定

フィールドが混在フィールドであるかを判定します。

●呼び出し形式

IsKonzai()

●パラメータ

ありません

●リターン値

混在フィールドの場合はtrueを返します。混在フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsKonzai())                    // 混在フィールドかどうか
    console.WriteLine("フィールドは混在フィールドです");

■IsLightpen

ライトペン検出可能フィールドの判定

フィールドがライトペン検出可能フィールドであるかを判定します。

●呼び出し形式

IsLightpen()

●パラメータ

ありません

●リターン値

ライトペン検出可能フィールドの場合はtrueを返します。ライトペン検出可能フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsLightpen())                    // ライトペン検出フィールドかどうか
    console.WriteLine("フィールドはライトペン検出可能フィールドです");

■IsNihongo

日本語フィールドの判定

フィールドが日本語フィールドであるかを判定します。

●呼び出し形式

IsNihongo()

●パラメータ

ありません

●リターン値

日本語フィールドの場合はtrueを返します。日本語フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザ");  // 文字列「ユーザ」を含むFieldオブジェクトを取得
if (field.IsNihongo())                    // 日本語フィールドかどうか
    console.WriteLine("フィールドは日本語フィールドです");

■IsNumeric

数字フィールドの判定

フィールドが数字フィールドであるかを判定します。

●呼び出し形式

IsNumeric()

●パラメータ

ありません

●リターン値

数字フィールドの場合はtrueを返します。数字フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsNumeric())                    // 数字フィールドかどうか
    console.WriteLine("フィールドは数字フィールドです");

■IsProtected

保護フィールドの判定

フィールドが保護フィールドであるかを判定します。

●呼び出し形式

IsProtected()

●パラメータ

ありません

●リターン値

保護フィールドの場合はtrueを返します。保護フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsProtected())                    // 保護フィールドかどうか
    console.WriteLine("フィールドは保護フィールドです");

■IsReverse

反転フィールドの判定

フィールドが反転フィールドであるかを判定します。

●呼び出し形式

IsReverse()

●パラメータ

ありません

●リターン値

反転フィールドの場合はtrueを返します。反転フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsReverse())                    // 反転フィールドかどうか
    console.WriteLine("フィールドは反転フィールドです");

■IsTrigger

トリガーフィールドの判定

フィールドがトリガーフィールドであるかを判定します。

●呼び出し形式

IsTrigger()

●パラメータ

ありません

●リターン値

トリガーフィールドの場合はtrueを返します。トリガーフィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsTrigger())                    // トリガーフィールドかどうか
    console.WriteLine("フィールドはトリガーフィールドです");

■IsUnderScore

下線フィールドの判定

フィールドが下線フィールドであるかを判定します。

●呼び出し形式

IsUnderScore()

●パラメータ

ありません

●リターン値

下線フィールドの場合はtrueを返します。下線フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsUnderScore())                    // 下線フィールドかどうか
    console.WriteLine("フィールドは下線フィールドです");

■IsVisible

可視フィールドの判定

フィールドが表示可能なフィールドであるかを判定します。

●呼び出し形式

IsVisible()

●パラメータ

ありません

●リターン値

可視フィールドの場合はtrueを返します。可視フィールド以外の場合はfalseを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
if (field.IsVisible())                    // 可視フィールドかどうか
    console.WriteLine("フィールドは可視フィールドです");

■Next

次のFieldオブジェクトを取得

現在のフィールドの次のフィールドから、Fieldオブジェクトを取得します。

●呼び出し形式

Next()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると次のFieldオブジェクトを返します。現在のフィールドが最終フィールドで、次のフィールドが存在しない場合nullを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var nextfield = field.Next();                        // 上記の次のオブジェクトを取得

■Prev

前のFieldオブジェクトを取得

現在のフィールドの前のフィールドから、Fieldオブジェクトを取得します。

●呼び出し形式

Prev()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると前のFieldオブジェクトを返します。現在のフィールドが先頭フィールドで、前のフィールドが存在しない場合nullを返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
var prevfield = field.Prev();                        // 上記の前のオブジェクトを取得

■SetName

フィールドへ名前を設定

エミュレータ画面のフィールドに名前を指定します。

●呼び出し形式

SetName(name)

●パラメータ

パラメータ	説明	省略時の初期値
name	フィールドに設定する名前の文字列	設定した値をクリア

注意

複数のフィールドに同じ名前を指定することはできません。

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

var field = dspemu.Screen.FindField("担当者");  // 文字列「担当者」を含むFieldオブジェクトを取得
field.SetName("担当者"); // フィールドの名前を「担当者」に設定

■SetText

フィールドに文字列を入力

フィールドに指定した文字列を入力します。文字列はフィールドの先頭から入力され、フィールド長で指定文字列を切り詰めて入力します。

●呼び出し形式

SetText(text)

●パラメータ

パラメータ	説明	省略時の初期値
text	入力する文字列	省略できません

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

参考

メソッド呼び出し時に入力禁止状態だった場合は、RESETキーによる解除後に指定された文字列を入力します。また、指定されたすべての文字入力が正常に行われた結果、入力禁止状態となった場合もRESETキーにより解除されます。
入力禁止状態を解除した場合は、リターン値はfalseを返します。エラーの詳細コードは28(キー入力禁止を解除しました)を返します。

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

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

var field = dspemu.Screen.FindField("ユーザID");  // 文字列「ユーザID」を含むFieldオブジェクトを取得
field = field.GetNextInputField(); // 次の入力可能フィールドを取得
field.SetText("USER1"); // フィールドに「USER1」を入力