QX.js API Reference

dialogs

app. dialogs

The dialogs module represents the QuarkXPress application's user interface for dialogs in java scripting world. You can use its properties and methods for user interaction.

Methods

(static) alert(descriptionopt, alertTypeopt) → {undefined}

This method displays an alert dialog with the optional specified content and an OK button.
Parameters:
Name Type Attributes Default Description
description string <optional>
"" It is an optional string of text you want to display in the alert dialog.
alertType app.constants.alertTypes <optional>
app.constants.alertTypes.kNoteAlert type of alert you want to show.
Returns:
Type
undefined

(static) confirm(descriptionopt, alertTypeopt)

This method displays a dialog box with a specified message, along with OK and Cancel button.
Parameters:
Name Type Attributes Default Description
description string <optional>
"" It is an optional string of text you want to display in the alert dialog.
alertType app.constants.alertTypes <optional>
app.constants.alertTypes.kNoteAlert type of alert you want to show.
Returns:
The method returns true if the user clicks "OK", and false otherwise.

(static) prompt(descriptionopt, defaultValueopt)

This method displays a dialog box that prompts the user for input.
Parameters:
Name Type Attributes Default Description
description string <optional>
"" It is an optional string of text you want to display in the prompt dialog.
defaultValue defaultValue <optional>
"" The default input text
Returns:
The method returns the input value if the user clicks "OK". If the user clicks "Cancel" the method returns null.