FileItem

FileItem クラスはファイル型項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

length読み取り専用

選択されているファイル数を表します。

例

esmJSPlugin.sheetEntry("customer").onEntered((screen) => {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  fileItem.onUpdated(function () {
    console.log("ファイル数:", fileItem.length);
  });
});

インスタンスメソッド

onFileAdded

ファイルが追加されたタイミングで関数を実行するeventHookを登録します。

構文

onFileAdded(callback);
onFileAdded(callback, group);

引数

callback

ファイルが追加されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  // ファイルが追加されたタイミングで関数を実行
  const unregister = fileItem.onFileAdded(function () {
    console.log(fileItem.length);
    unregister(); // 解除
  });
});

onFileRemoved

ファイルが削除されたタイミングで関数を実行するeventHookを登録します。

構文

onFileRemoved(callback);
onFileRemoved(callback, group);

引数

callback

ファイルが削除されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  // ファイルが削除されたタイミングで関数を実行
  const unregister = fileItem.onFileRemoved(function () {
    console.log(fileItem.length);
    unregister(); // 解除
  });
});

lengthEqualsTo

数値を受け取り、選択されているファイル数が指定した数値と同じかどうかの真偽値を返します。

構文

lengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  fileItem.onUpdated(function () {
    const result = fileItem.lengthEqualsTo(1);
    console.log(result);
  });
});

lengthIsGreaterThan

選択されているファイル数が指定した数値より大きいかどうかを判定します。

構文

lengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  fileItem.onUpdated(function () {
    const result = fileItem.lengthIsGreaterThan(1);
    console.log(result);
  });
});

lengthIsGreaterThanOrEqual

選択されているファイル数が指定した数値以上かどうかを判定します。

構文

lengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  fileItem.onUpdated(function () {
    const result = fileItem.lengthIsGreaterThanOrEqual(1);
    console.log(result);
  });
});

lengthIsLessThan

選択されているファイル数が指定した数値より小さいかどうかを判定します。

構文

lengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  fileItem.onUpdated(function () {
    const result = fileItem.lengthIsLessThan(1);
    console.log(result);
  });
});

lengthIsLessThanOrEqual

選択されているファイル数が指定した数値以下かどうかを判定します。

構文

lengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const fileItem = screen.getSheetItemByLabel("ファイル");

  fileItem.onUpdated(function () {
    const result = fileItem.lengthIsLessThanOrEqual(1);
    console.log(result);
  });
});

関連情報