Class Browser

مرورگر

این کلاس دسترسی به کادرهای محاوره‌ای مخصوص Google Sheets را فراهم می‌کند.

متدهای این کلاس فقط برای استفاده در متن صفحه گسترده گوگل (Google Spreadsheet) در دسترس هستند. لطفاً به جای آن از کادرهای محاوره‌ای Google Workspace استفاده کنید.

همچنین ببینید

خواص

ملک نوع توضیحات
Buttons Button Set

روش‌ها

روش نوع بازگشتی شرح مختصر
input Box(prompt) String|null یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.
input Box(prompt, buttons) String|null یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.
input Box(title, prompt, buttons) String|null یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.
msg Box(prompt) String|null یک کادر محاوره‌ای حاوی پیام داده شده و یک دکمه‌ی تأیید در مرورگر کاربر ظاهر می‌شود.
msg Box(prompt, buttons) String|null یک کادر محاوره‌ای حاوی پیام داده شده و دکمه‌های مشخص شده در مرورگر کاربر، نمایش می‌دهد.
msg Box(title, prompt, buttons) String|null یک کادر محاوره‌ای با عنوان، پیام و دکمه‌های مشخص شده در مرورگر کاربر نمایش داده می‌شود.

مستندات دقیق

input Box(prompt)

یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.

متد inputBox یک کادر ورودی سمت کلاینت ایجاد می‌کند که اعلان داده شده را به کاربر نمایش می‌دهد. توجه داشته باشید که این تابع باعث می‌شود اسکریپت سمت سرور به حالت تعلیق درآید. پس از اینکه کاربر کادر محاوره‌ای را پاک کرد، اسکریپت به طور خودکار از سر گرفته می‌شود، اما اتصالات JDBC در طول تعلیق ادامه نمی‌یابند.

// The code below sets the value of name to the name input by the user, or
// 'cancel'.
const name = Browser.inputBox('Enter your name');
این روش توصیه نمی‌شود. در عوض، از یک رابط کاربری سریع (UI prompt ) استفاده کنید.

پارامترها

نام نوع توضیحات
prompt String متنی که قرار است در کادر محاوره‌ای نمایش داده شود.

بازگشت

String|null — متنی که توسط کاربر وارد شده است (یا 'cancel' برای یک کادر محاوره‌ای لغو شده یا رد شده).

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

input Box(prompt, buttons)

یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.

متد inputBox یک کادر ورودی سمت کلاینت ایجاد می‌کند که اعلان داده شده را به کاربر نمایش می‌دهد و امکان انتخاب دکمه‌ها را برای نمایش فراهم می‌کند. توجه داشته باشید که این تابع باعث می‌شود اسکریپت سمت سرور به حالت تعلیق درآید. پس از اینکه کاربر کادر محاوره‌ای را پاک کرد، اسکریپت به طور خودکار از سر گرفته می‌شود، اما اتصالات JDBC در طول تعلیق ادامه نمی‌یابند.

// The code below sets the value of name to the name input by the user, or
// 'cancel'.
const name = Browser.inputBox('Enter your name', Browser.Buttons.OK_CANCEL);
این روش توصیه نمی‌شود. در عوض، از یک رابط کاربری سریع (UI prompt ) استفاده کنید.

پارامترها

نام نوع توضیحات
prompt String متنی که قرار است در کادر محاوره‌ای نمایش داده شود.
buttons Button Set نوع دکمه‌ای که قرار است استفاده شود.

بازگشت

String|null — متنی که توسط کاربر وارد شده است (یا 'cancel' برای یک کادر محاوره‌ای لغو شده یا رد شده).

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

input Box(title, prompt, buttons)

یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.

متد inputBox یک کادر ورودی سمت کلاینت با عنوان داده شده ایجاد می‌کند که اعلان داده شده را به کاربر نمایش می‌دهد و امکان انتخاب دکمه‌ها را فراهم می‌کند. توجه داشته باشید که این تابع باعث می‌شود اسکریپت سمت سرور به حالت تعلیق درآید. پس از اینکه کاربر کادر محاوره‌ای را پاک کرد، اسکریپت به طور خودکار از سر گرفته می‌شود، اما اتصالات JDBC در طول تعلیق ادامه نمی‌یابند.

// The code below sets the value of name to the name input by the user, or
// 'cancel'.
const name = Browser.inputBox(
    'ID Check',
    'Enter your name',
    Browser.Buttons.OK_CANCEL,
);
این روش توصیه نمی‌شود. در عوض، از یک رابط کاربری سریع (UI prompt ) استفاده کنید.

پارامترها

نام نوع توضیحات
title String عنوان برای کادر محاوره‌ای.
prompt String متنی که قرار است در کادر محاوره‌ای نمایش داده شود.
buttons Button Set نوع دکمه‌ای که قرار است استفاده شود.

بازگشت

String|null — متنی که توسط کاربر وارد شده است (یا 'cancel' برای یک کادر محاوره‌ای لغو شده یا رد شده).

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msg Box(prompt)

یک کادر محاوره‌ای حاوی پیام داده شده و یک دکمه‌ی تأیید در مرورگر کاربر ظاهر می‌شود.

متد msgBox یک کادر پیام سمت کلاینت ایجاد می‌کند که پیام داده شده را به کاربر نمایش می‌دهد. توجه داشته باشید که این متد باعث می‌شود اسکریپت سمت سرور به حالت تعلیق درآید. پس از اینکه کاربر کادر محاوره‌ای را پاک کرد، اسکریپت به طور خودکار از سر گرفته می‌شود، اما اتصالات JDBC در طول حالت تعلیق باقی نمی‌مانند.

// The code below displays "hello world" in a dialog box with an OK button
Browser.msgBox('hello world');
این روش توصیه نمی‌شود. در عوض، از یک پنجره هشدار رابط کاربری استفاده کنید.

پارامترها

نام نوع توضیحات
prompt String متنی که قرار است در کادر محاوره‌ای نمایش داده شود.

بازگشت

String|null — متن کوچک دکمه‌ای که توسط کاربر کلیک می‌شود (یا «لغو» برای یک کادر محاوره‌ای رد شده).

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msg Box(prompt, buttons)

یک کادر محاوره‌ای حاوی پیام داده شده و دکمه‌های مشخص شده در مرورگر کاربر، نمایش می‌دهد.

متد msgBox یک کادر پیام سمت کلاینت ایجاد می‌کند که پیام داده شده را به کاربر نمایش می‌دهد و امکان انتخاب دکمه‌های نمایش داده شده را فراهم می‌کند. توجه داشته باشید که این متد باعث می‌شود اسکریپت سمت سرور به حالت تعلیق درآید. پس از اینکه کاربر کادر محاوره‌ای را پاک کرد، اسکریپت به طور خودکار از سر گرفته می‌شود، اما اتصالات JDBC در طول تعلیق ادامه نمی‌یابند.

// The code below displays "hello world" in a dialog box with OK and Cancel
// buttons.
Browser.msgBox('hello world', Browser.Buttons.OK_CANCEL);
این روش توصیه نمی‌شود. در عوض، از یک پنجره هشدار رابط کاربری استفاده کنید.

پارامترها

نام نوع توضیحات
prompt String متنی که قرار است در کادر محاوره‌ای نمایش داده شود.
buttons Button Set نوع دکمه‌ای که قرار است استفاده شود.

بازگشت

String|null — متن کوچک دکمه‌ای که توسط کاربر کلیک می‌شود (یا «لغو» برای یک کادر محاوره‌ای رد شده).

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msg Box(title, prompt, buttons)

یک کادر محاوره‌ای با عنوان، پیام و دکمه‌های مشخص شده در مرورگر کاربر نمایش داده می‌شود.

متد msgBox یک کادر پیام سمت کلاینت با عنوان داده شده ایجاد می‌کند که پیام داده شده را به کاربر نمایش می‌دهد و امکان انتخاب دکمه‌های نمایش داده شده را فراهم می‌کند. توجه داشته باشید که این متد باعث می‌شود اسکریپت سمت سرور به حالت تعلیق درآید. پس از اینکه کاربر کادر محاوره‌ای را پاک کرد، به طور خودکار از سر گرفته می‌شود، اما اتصالات JDBC در طول تعلیق ادامه نمی‌یابند.

// The code below displays "hello world" in a dialog box with a custom title and
// Yes and No buttons
Browser.msgBox('Greetings', 'hello world', Browser.Buttons.YES_NO);
این روش توصیه نمی‌شود. در عوض، از یک پنجره هشدار رابط کاربری استفاده کنید.

پارامترها

نام نوع توضیحات
title String عنوان کادر محاوره‌ای.
prompt String متنی که قرار است در کادر محاوره‌ای نمایش داده شود.
buttons Button Set نوع دکمه‌ای که قرار است استفاده شود.

بازگشت

String|null — متن کوچک دکمه‌ای که توسط کاربر کلیک می‌شود (یا «لغو» برای یک کادر محاوره‌ای رد شده).

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets