Ask-at-runtime Dialog: Introduction

When simple variables are used in a Check, Fixup, Profile or Process Plan, pdfToolbox Desktop brings up the Ask-at-runtime dialog before running the Check, Fixup... In this dialog you can modify the values for all variables (initially shown are the default values for each variable) before Profile execution.

Depending on the value type of the Variable, the Ask-at-runtime dialog will display different input fields and controls. Here is an example of an Ask-at-runtime dialog with four different "Value types":


  1. Value type PopUp: a PopUp is displayed with all the options valid for this parameter.
  2. Value type Boolean: if a variable is created for a checkbox, a button is displayed in the Ask-at-runtime dialog to enable or disable the checkbox.
  3. Value type String: a text field is displayed in which any string can be entered.
  4. Value type Float: any floating point number can be entered (you can either use the controls or enter the number manually).

Tipps and Tricks

  1. You can toggle between the label and key of a variable in the variable dialog using Strg/Cmd +K. The lower dialog shows the key view of the variable after pressing Ctrl/Cmd + K
  2. Import variables:  you can import a JSON file with predefined variable values.
  3. Export variables: exports all set values for the variables as a JSON file.
  4. Restore default values: previously set values can be restored using this button.
  5. If Strg/Cmd + i is pressed, an info button appears after each variable, indicating for which parameter the variable was created. The screenshot below shows the info for the first variable in the ask-at-runtime dialog above (Create as spot color button).

Adjust the Ask-at-runtime dialog

As of pdfToolbox 15, it is possible to use Java Script to define the order of the variables in the Ask-at-runtime dialog and to hide or disable variables under certain conditions. All inforation about adjusting the Ask-at-runtime dialog can be found in this article: Adjust the Ask-at-runtime dialog.

Customizing the Ask-at-runtime dialog

The Ask-at-runtime dialog uses a HTML template that makes changes much easier. All information about customizing the HTML template can be found in this article: Working with ask-at-runtime templates.

Ask-at-runtime dialog before pdfToolbox 11

Before the release of pdfToolbox 11 the Ask-at-runtime dialog looked different and had the following limitations :

  • The dialog always looked the same and could not be customised in any way.
  • The order of the variables in the dialog window could not easily be modified.
  • Any kind of additional grouping or structure, or any modification in the type of input fields used was impossible.
  • Only the most basic validation was available.