Stay organized with collectionsSave 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 analertor aprompt. To determine which button the user clicked,
useButton.
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.constui=DocumentApp.getUi();constresponse=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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eButtonSet\u003c/code\u003e is an enum used to create predefined, localized button sets for dialog boxes in Apps Script.\u003c/p\u003e\n"],["\u003cp\u003eIt provides options like \u003ccode\u003eOK\u003c/code\u003e, \u003ccode\u003eOK_CANCEL\u003c/code\u003e, \u003ccode\u003eYES_NO\u003c/code\u003e, and \u003ccode\u003eYES_NO_CANCEL\u003c/code\u003e for different dialog scenarios.\u003c/p\u003e\n"],["\u003cp\u003eYou can determine the user's button click by comparing the response to \u003ccode\u003eui.Button\u003c/code\u003e values.\u003c/p\u003e\n"],["\u003cp\u003eThese button sets are used with \u003ccode\u003ealert()\u003c/code\u003e and \u003ccode\u003eprompt()\u003c/code\u003e methods of the \u003ccode\u003eUi\u003c/code\u003e class.\u003c/p\u003e\n"]]],[],null,["# Enum ButtonSet\n\nButtonSet\n\nAn enum representing predetermined, localized sets of one or more dialog buttons that can be\nadded to an [alert](/apps-script/reference/base/ui#alert(String,ButtonSet)) or a [prompt](/apps-script/reference/base/ui#prompt(String,ButtonSet)). To determine which button the user clicked,\nuse [Button](/apps-script/reference/base/button).\n\nTo call an enum, you call its parent class, name, and property. For example, `\nBase.ButtonSet.OK`.\n\n```javascript\n// Display a dialog box with a message and \"Yes\" and \"No\" buttons.\nconst ui = DocumentApp.getUi();\nconst response = ui.alert(\n 'Are you sure you want to continue?',\n ui.ButtonSet.YES_NO,\n);\n\n// Process the user's response.\nif (response === ui.Button.YES) {\n Logger.log('The user clicked \"Yes.\"');\n} else {\n Logger.log('The user clicked \"No\" or the dialog\\'s close button.');\n}\n``` \n\n### Properties\n\n| Property | Type | Description |\n|-----------------|--------|----------------------------------------------------------------------------------------------------------------------------------|\n| `OK` | `Enum` | A single \"OK\" button, indicating an informational message that can only be dismissed. |\n| `OK_CANCEL` | `Enum` | An \"OK\" button and a \"Cancel\" button, allowing the user to either proceed with or halt an operation. |\n| `YES_NO` | `Enum` | A \"Yes\" button and a \"No\" button, allowing the user to answer a yes/no question. |\n| `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. |"]]
