screen

JSプラグインを適用する対象となる各画面のScreenインスタンスを返すメソッドを格納したオブジェクトです。
esmJSPluginを介して利用することができます。

const screen = esmJSPlugin.screen;

Warning

各メソッドが返すScreenインスタンスでは、eventHookを登録するためのonから始まるメソッドおよび、Listenable.unlistenGroup、Listenable.unlistenAllしか利用できません。
onから始まるメソッドに渡すコールバック関数の第一引数には、同じくScreenインスタンスが渡されますが、こちらではScreenインスタンスがもつ他のプロパティにもアクセス可能です。

const screen = esmJSPlugin.screen.sheetEntry("customer");
let customerNameItem = screen.getSheetItemByLabel("顧客名"); // アクセス不可能
screen.onEntered(function (screen) {
  customerNameItem = screen.getSheetItemByLabel("顧客名"); // アクセス可能
});

メソッド

sheetEntry

シート登録画面でのみ動作するSheetSaveScreenインスタンスを返します。

構文

sheetEntry(sheetName);

引数

sheetName

プラグインを適用する対象となるシートのsheetNameを示す文字列です。

返値

SheetSaveScreenインスタンスです。

例

const customerEntryScreen = esmJSPlugin.screen.sheetEntry("customer");

sheetUpdate

シート変更画面でのみ動作するSheetSaveScreenインスタンスを返します。

構文

sheetUpdate(sheetName);

引数

sheetName

プラグインを適用する対象となるシートのsheetNameを示す文字列です。

返値

SheetSaveScreenインスタンスです。

例

const customerUpdateScreen = esmJSPlugin.screen.sheetUpdate("customer");

sheetSave

シート登録・変更画面の両方で動作するSheetSaveScreenインスタンスを返します。

構文

sheetSave(sheetName);

引数

sheetName

プラグインを適用する対象となるシートのsheetNameを示す文字列です。

返値

SheetSaveScreenインスタンスです。

例

const customerUpdateScreen = esmJSPlugin.screen.sheetSave("customer");

sheetDetail

SheetDetailScreenインスタンスを返します。

構文

sheetDetail(sheetName);

引数

sheetName

プラグインを適用する対象となるシートのsheetNameを示す文字列です。

返値

SheetDetailScreenインスタンスインスタンスです。

例

const customerDetailScreen = esmJSPlugin.screen.sheetDetail("customer");

関連情報

• esmJSPlugin
• Screen
• Listenable
• SheetSaveScreen
• SheetDetailScreen
• sheetName