LocalTool

LocalToolクラスはレコード一覧画面のローカルツールに対して操作を行うためのメンバーを持っています。

継承

Item

インスタンスプロパティ

setButtons

ローカルツールにボタンを追加します。

構文

setButtons([
  {
    onClick: callback,
    title: title,
  },
]);

引数

onClick

ボタンがクリックされたときに実行される関数です。

title

ボタンに表示される文字列です。

返値

なし

例

esmJSPlugin.screen
  .sheetIndex("customer")
  .onLocalToolMounted(function (screen) {
    const localTool = screen.getLocalTool();

    // クリックされたタイミングで関数を実行するボタンを追加する
    localTool.setButtons([
      {
        onClick: () => {
          alert("clicked");
        },
        title: "カスタムボタン",
      },
    ]);
  });

setSelectionToolButtons

ローカルツールの選択操作プルダウンにボタンを追加します。

構文

setSelectionToolButtons([
  {
    onClick: callback,
    title: title,
  },
]);

引数

onClick

ボタンがクリックされたときに実行される関数です。

title

ボタンに表示される文字列です。

返値

なし

例

esmJSPlugin.screen
  .sheetIndex("customer")
  .onLocalToolMounted(function (screen) {
    const localTool = screen.getLocalTool();

    // クリックされたタイミングで関数を実行するボタンを追加する
    localTool.setSelectionToolButtons([
      {
        onClick: () => {
          alert("clicked");
        },
        title: "カスタムボタン",
      },
    ]);
  });

Info

一覧画面で全て選択のチェックが入っている場合、追加したボタンは非活性になります。