EmailItem

EmailItem クラスはメールアドレス型項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

value

入力されているメールアドレスです。

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

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

    // 値を変更
    emailItem.value = "test@example.com";

    // 変更後の値を確認
    console.log("変更後:", emailItem.value); // 変更後: "test@example.com"
  });
});

length読み取り専用

value の文字数を表します。

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onMounted(function () {
    // 値を設定
    emailItem.value = "test@example.com";

    console.log("文字数:", emailItem.length); // 文字数: 16
  });
});

インスタンスメソッド

setValue

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

構文

setValue(text);

引数

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

返値

なし

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

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

    // 値を変更
    emailItem.setValue("test@example.com");

    // 変更後の値を確認
    console.log("変更後:", emailItem.value); // 変更後: "test@example.com"
  });
});

equalsTo

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

構文

equalsTo(string);

引数

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

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onUpdated(function () {
    // 値を確認
    console.log("値:", emailItem.value); // 値: "test@example.com"

    const isEqual = emailItem.equalsTo("test@example.com");
    console.log("「test@example.com」と一致するか:", isEqual); // 「test@example.com」と一致するか: true
  });
});

contains

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

構文

contains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onUpdated(function () {
    // 値を確認
    console.log("初期値:", emailItem.value); // 値: "test@example.com"

    const result1 = emailItem.contains("test");
    console.log("「test」が含まれるか:", result1); // 「test」が含まれるか: true

    const result2 = emailItem.contains("example.co.jp");
    console.log("「example.co.jp」が含まれるか:", result2); // 「example.co.jp」が含まれるか: false
  });
});

lengthEqualsTo

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

構文

lengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onUpdated(function () {
    // 値を確認
    console.log("値:", emailItem.value); // 値: "test@example.com"

    const result = emailItem.lengthEqualsTo(16);

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

lengthIsGreaterThan

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

構文

lengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onUpdated(function () {
    // 値を確認
    console.log("値:", emailItem.value); // 値: "test@example.com"

    const result = emailItem.lengthIsGreaterThan(15);

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

lengthIsGreaterThanOrEqual

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

構文

lengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onUpdated(function () {
    // 値を確認
    console.log("値:", emailItem.value); // 値: "test@example.com"

    const result = emailItem.lengthIsGreaterThanOrEqual(15);

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

lengthIsLessThan

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

構文

lengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onUpdated(function () {
    // 値を確認
    console.log("初期値:", emailItem.value); // 値: "test@example.com"

    const result = emailItem.lengthIsLessThan(17);

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

lengthIsLessThanOrEqual

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

構文

lengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((screen) => {
  const emailItem = screen.getSheetItemByLabel("メールアドレス");

  emailItem.onUpdated(function () {
    // 値を確認
    console.log("値:", emailItem.value); // 値: "test@example.com"

    const result = emailItem.lengthIsLessThanOrEqual(17);

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

関連情報

• SheetItem
• SheetSaveScreen