Enum Button

  • The Button enum represents predetermined, localized dialog buttons returned by alert or PromptResponse.getSelectedButton() to indicate which button a user clicked.

  • These button values cannot be set directly; use ButtonSet to add buttons to an alert or prompt.

  • To call an enum, you use its parent class, name, and property, such as Base.Button.CLOSE.
Button

An enum representing predetermined, localized dialog buttons returned by an alert or PromptResponse.getSelectedButton() to indicate which button in a dialog the user clicked. These values cannot be set; to add buttons to an alert or prompt, use ButtonSet instead.

To call an enum, you call its parent class, name, and property. For example, 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.');
}

Properties

PropertyTypeDescription
CLOSEEnumThe standard close button displayed in every dialog's title bar. This button is not explicitly added to a dialog, and it cannot be removed.
OKEnumAn "OK" button, indicating that an operation should proceed.
CANCELEnumA "Cancel" button, indicating that an operation should not proceed.
YESEnumA "Yes" button, indicating a positive response to a question.
NOEnumA "No" button, indicating a negative response to a question.