StringItem

StringItem クラスはテキスト型項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

value

入力されている文字列です。

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onMounted(function () {
    // 初期値を確認
    console.log("初期値:", stringItem.value); // 初期値: ""

    // 値を変更
    stringItem.value = "ソフトブレーン株式会社";

    // 変更後の値を確認
    console.log("変更後:", stringItem.value); // 変更後: "ソフトブレーン株式会社"
  });
});

length読み取り専用

value の文字数を表します。

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onMounted(function () {
    // 値を設定
    stringItem.value = "ソフトブレーン";

    console.log("文字数:", stringItem.length); // 文字数: 7
  });
});

インスタンスメソッド

setValue

文字列を受け取り、入力内容を変更します。

構文

setValue(text);

引数

text
入力内容を示す文字列です。

返値

なし

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onMounted(function () {
    // 初期値を確認
    console.log("初期値:", stringItem.value); // 初期値: ""

    // 値を変更
    stringItem.setValue("ソフトブレーン株式会社");

    // 変更後の値を確認
    console.log("変更後:", stringItem.value); // 変更後: "ソフトブレーン株式会社"
  });
});

equalsTo

value が指定した文字列と一致するかどうかを判定します。

構文

equalsTo(string);

引数

string
比較対象の文字列です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onUpdated(function () {
    // 値を確認
    console.log("値:", stringItem.value); // 値: "ソフトブレーン"

    const isEqual = stringItem.equalsTo("ソフトブレーン");
    console.log("「ソフトブレーン」と一致するか:", isEqual); // 「ソフトブレーン」と一致するか: true
  });
});

contains

指定した文字列が value に含まれているかどうかを判定します。

構文

contains(substring);

引数

substring
検索対象の文字列です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onUpdated(function () {
    // 値を確認
    console.log("値:", stringItem.value); // 値: "ソフトブレーン"

    const containsSoft = stringItem.contains("ソフト");
    console.log("「ソフト」が含まれるか:", containsSoft); // 「ソフト」が含まれるか: true

    const containsBrain = stringItem.contains("ブレイン");
    console.log("「ブレイン」が含まれるか:", containsBrain); // 「ブレイン」が含まれるか: false
  });
});

lengthEqualsTo

数値を受け取り、value の文字数が指定した数値と同じかどうかを判定します。

構文

lengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onUpdated(function () {
    // 値を確認
    console.log("値:", stringItem.value); // 値: "ソフトブレーン"

    const result = stringItem.lengthEqualsTo(7);

    console.log("文字数が7かどうか:", result); // 文字数が7どうか: true
  });
});

lengthIsGreaterThan

value の文字数が指定した数値より大きいかどうかを判定します。

構文

lengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onUpdated(function () {
    // 値を確認
    console.log("値:", stringItem.value); // 値: "ソフトブレーン"

    const result = stringItem.lengthIsGreaterThan(6);

    console.log("文字数が6より大きいか:", result); // 文字数が6より大きいか: true
  });
});

lengthIsGreaterThanOrEqual

value の文字数が指定した数値以上かどうかを判定します。

構文

lengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onUpdated(function () {
    // 値を確認
    console.log("値:", stringItem.value); // 値: "ソフトブレーン"

    const result = stringItem.lengthIsGreaterThanOrEqual(6);

    console.log("文字数が6以上か:", result); // 文字数が6以上か: true
  });
});

lengthIsLessThan

value の文字数が指定した数値より小さいかどうかを判定します。

構文

lengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onUpdated(function () {
    // 値を確認
    console.log("値:", stringItem.value); // 値: "ソフトブレーン"

    const result = stringItem.lengthIsLessThan(10);

    console.log("文字数が10未満か:", result); // 文字数が10未満か: true
  });
});

lengthIsLessThanOrEqual

value の文字数が指定した数値以下かどうかを判定します。

構文

lengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const stringItem = SheetSaveScreen.getSheetItem(
    "customers.customer.customer_name"
  );

  stringItem.onUpdated(function () {
    // 値を確認
    console.log("値:", stringItem.value); // 値: "ソフトブレーン"

    const result = stringItem.lengthIsLessThanOrEqual(8);

    console.log("文字数が8以下か:", result); // 文字数が8以下か: true
  });
});

関連情報

• SheetItem
• SheetSaveScreen