Enum Button
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Button
Um tipo enumerado que representa botões de diálogo localizados e predeterminados retornados por um alert ou PromptResponse.getSelectedButton() para indicar
em qual botão em uma caixa de diálogo o usuário clicou. Esses valores não podem ser definidos. Para adicionar botões a um
alert ou prompt, use ButtonSet.
Para chamar um tipo enumerado, chame a classe mãe, o nome e a propriedade dele. Por exemplo,
Base.Button.CLOSE.
// 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.');
}
Propriedades
| Propriedade | Tipo | Descrição |
CLOSE | Enum | O botão de fechar padrão exibido na barra de título de cada caixa de diálogo. Esse botão não é adicionado explicitamente
a uma caixa de diálogo e não pode ser removido. |
OK | Enum | Um botão "OK", indicando que uma operação precisa ser realizada. |
CANCEL | Enum | Um botão "Cancelar", indicando que uma operação não deve ser realizada. |
YES | Enum | Um botão "Sim", indicando uma resposta positiva a uma pergunta. |
NO | Enum | Um botão "Não", indicando uma resposta negativa a uma pergunta. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003e\u003ccode\u003eButton\u003c/code\u003e is an enum representing localized dialog buttons returned by alerts or prompts, indicating user action.\u003c/p\u003e\n"],["\u003cp\u003eThese predetermined button values (\u003ccode\u003eCLOSE\u003c/code\u003e, \u003ccode\u003eOK\u003c/code\u003e, \u003ccode\u003eCANCEL\u003c/code\u003e, \u003ccode\u003eYES\u003c/code\u003e, \u003ccode\u003eNO\u003c/code\u003e) cannot be set directly but are accessed via \u003ccode\u003eui.Button\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eTo add buttons to alerts or prompts, use \u003ccode\u003eButtonSet\u003c/code\u003e instead of individual \u003ccode\u003eButton\u003c/code\u003e values.\u003c/p\u003e\n"],["\u003cp\u003eThe provided example code demonstrates using \u003ccode\u003eButton\u003c/code\u003e to handle user responses from a dialog.\u003c/p\u003e\n"]]],[],null,["# Enum Button\n\nButton\n\nAn enum representing predetermined, localized dialog buttons returned by an [alert](/apps-script/reference/base/ui#alert(String)) or [PromptResponse.getSelectedButton()](/apps-script/reference/base/prompt-response#getSelectedButton()) to indicate\nwhich button in a dialog the user clicked. These values cannot be set; to add buttons to an\n[alert](/apps-script/reference/base/ui#alert(String,ButtonSet)) or [prompt](/apps-script/reference/base/ui#prompt(String,ButtonSet)), use [ButtonSet](/apps-script/reference/base/button-set) instead.\n\nTo call an enum, you call its parent class, name, and property. For example, `\nBase.Button.CLOSE`.\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| `CLOSE` | `Enum` | The standard close button displayed in every dialog's title bar. This button is not explicitly added to a dialog, and it cannot be removed. |\n| `OK` | `Enum` | An \"OK\" button, indicating that an operation should proceed. |\n| `CANCEL` | `Enum` | A \"Cancel\" button, indicating that an operation should not proceed. |\n| `YES` | `Enum` | A \"Yes\" button, indicating a positive response to a question. |\n| `NO` | `Enum` | A \"No\" button, indicating a negative response to a question. |"]]
