Class Browser

Browser

This class provides access to dialog boxes specific to Google Sheets.

The methods in this class are only available for use in the context of a Google Spreadsheet. Please use Google Workspace dialogs instead.

See also

Properties

PropertyTypeDescription
ButtonsButtonSet

Methods

MethodReturn typeBrief description
inputBox(prompt)StringPops up a dialog box with a text input box in the user's browser.
inputBox(prompt, buttons)StringPops up a dialog box with a text input box in the user's browser.
inputBox(title, prompt, buttons)StringPops up a dialog box with a text input box in the user's browser.
msgBox(prompt)StringPops up a dialog box with the given message and an OK button in the user's browser.
msgBox(prompt, buttons)StringPops up a dialog box with the given message and specified buttons in the user's browser.
msgBox(title, prompt, buttons)StringPops up a dialog box with the given title, message and specified buttons in the user's browser.

Detailed documentation

inputBox(prompt)

Pops up a dialog box with a text input box in the user's browser.

The inputBox method raises a client-side input box that displays the given prompt to the user. Note that this function causes the server-side script to be suspended. It resumes automatically after the user clears the dialog, but JDBC connections don't persist across the suspension. 

// The code below sets the value of name to the name input by the user, or 'cancel'.
var name = Browser.inputBox('Enter your name');
 This method is not recommended. Instead, use a UI prompt.

Parameters

NameTypeDescription
promptStringThe text to be displayed in the dialog box.

Return

String — The text entered by the user (or 'cancel' for a canceled or dismissed dialog).

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

inputBox(prompt, buttons)

Pops up a dialog box with a text input box in the user's browser.

The inputBox method raises a client-side input box that displays the given prompt to the user, and offers a choice of buttons to be displayed. Note that this function causes the server-side script to be suspended. It resumes automatically after the user clears the dialog, but JDBC connections don't persist across the suspension. 

// The code below sets the value of name to the name input by the user, or 'cancel'.
var name = Browser.inputBox('Enter your name', Browser.Buttons.OK_CANCEL);
 This method is not recommended. Instead, use a UI prompt.

Parameters

NameTypeDescription
promptStringThe text to be displayed in the dialog box.
buttonsButtonSetThe type of button set to use.

Return

String — The text entered by the user (or 'cancel' for a canceled or dismissed dialog).

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

inputBox(title, prompt, buttons)

Pops up a dialog box with a text input box in the user's browser.

The inputBox method raises a client side input box with the given title, that displays the given prompt to the user, and offers a choice of buttons to be displayed. Note that this function causes the server-side script to be suspended. It resumes automatically after the user clears the dialog, but JDBC connections don't persist across the suspension. 

// The code below sets the value of name to the name input by the user, or 'cancel'.
var name = Browser.inputBox('ID Check', 'Enter your name', Browser.Buttons.OK_CANCEL);
 This method is not recommended. Instead, use a UI prompt.

Parameters

NameTypeDescription
titleStringThe title for the dialog box.
promptStringThe text to be displayed in the dialog box.
buttonsButtonSetThe type of button set to use.

Return

String — The text entered by the user (or 'cancel' for a canceled or dismissed dialog).

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

msgBox(prompt)

Pops up a dialog box with the given message and an OK button in the user's browser.

The msgBox method raises a client-side message box that displays the given message to the user. Note that this method causes the server-side script to be suspended. It resumes automatically after the user clears the dialog, but JDBC connections don't persist across the suspension. 

// The code below displays "hello world" in a dialog box with an OK button
Browser.msgBox('hello world');
 This method is not recommended. Instead, use a UI alert dialog.

Parameters

NameTypeDescription
promptStringThe text to be displayed in the dialog box.

Return

String — The lower case text of the button that is clicked by the user (or 'cancel' for a dismissed dialog).

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

msgBox(prompt, buttons)

Pops up a dialog box with the given message and specified buttons in the user's browser.

The msgBox method raises a client-side message box that displays the given message to the user, and offers a choice of buttons to be displayed. Note that this method causes the server-side script to be suspended. It resumes automatically after the user clears the dialog, but JDBC connections don't persist across the suspension. 

// The code below displays "hello world" in a dialog box with OK and Cancel buttons.
Browser.msgBox('hello world', Browser.Buttons.OK_CANCEL);
 This method is not recommended. Instead, use a UI alert dialog.

Parameters

NameTypeDescription
promptStringThe text to be displayed in the dialog box.
buttonsButtonSetThe type of button set to use.

Return

String — The lower case text of the button that is clicked by the user (or 'cancel' for a dismissed dialog).

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

msgBox(title, prompt, buttons)

Pops up a dialog box with the given title, message and specified buttons in the user's browser.

The msgBox method raises a client-side message box with the given title, that displays the given message to the user, and offers a choice of buttons to be displayed. Note that this method causes the server-side script to be suspended. It resumes automatically after the user clears the dialog, but JDBC connections don't persist across the suspension. 

// 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);
 This method is not recommended. Instead, use a UI alert dialog.

Parameters

NameTypeDescription
titleStringThe title of the dialog box.
promptStringThe text to be displayed in the dialog box.
buttonsButtonSetThe type of button set to use.

Return

String — The lower case text of the button that is clicked by the user (or 'cancel' for a dismissed dialog).

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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