Enum ButtonSet | Apps Script | Google for Developers (original) (raw)
Enum ButtonSet
Stay organized with collections Save and categorize content based on your preferences.
ButtonSet
An enum representing predetermined, localized sets of one or more dialog buttons that can be added to an [alert](/apps-script/reference/base/ui#alert%28String,ButtonSet%29) or a [prompt](/apps-script/reference/base/ui#prompt%28String,ButtonSet%29). To determine which button the user clicked, use [Button](/apps-script/reference/base/button).
To call an enum, you call its parent class, name, and property. For example, Base.ButtonSet.OK.
// Display a dialog box with a message and "Yes" and "No" buttons. const ui = DocumentApp.getUi(); const response = ui.alert( 'Are you sure you want to continue?', ui.ButtonSet.YES_NO, );
// Process the user's response. if (response === ui.Button.YES) { Logger.log('The user clicked "Yes."'); } else { Logger.log('The user clicked "No" or the dialog's close button.'); }
Properties
| Property | Type | Description |
|---|---|---|
| OK | Enum | A single "OK" button, indicating an informational message that can only be dismissed. |
| OK_CANCEL | Enum | An "OK" button and a "Cancel" button, allowing the user to either proceed with or halt an operation. |
| YES_NO | Enum | A "Yes" button and a "No" button, allowing the user to answer a yes/no question. |
| YES_NO_CANCEL | Enum | A "Yes" button, a "No" button, and a "Cancel" button, allowing the user to either answer a yes/no question or halt an operation. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.