Tutorial

Getting Started with Macros

Macro Editor

User Interface

Menus and Toolbar

Editing Macro Statements

Expression Editor

Macro Debugging

How To

Using variables

Finding and modifying objects

Creating new page content

Asking for user input

Storing persistent data

Using binary data

Sorting objects

Macro menus

Bulleted and numbered lists

Sample Macros

Concepts

Expressions

Objects

Properties

Variables

Data Types

Arrays

Functions

Literals

Operators

Comments

Last updated on: March 19, 2023
Also available as a single HTML file

Onetastic Macro Documentation > Other Objects > DialogBox

DialogBox Object

Description

Represents a dialog box to interact with the user.

Remarks

Represents a dialog box to display a message or request input from user. Dialog boxes can be created with DialogBox_Create and displayed with DialogBox_Show. Controls can be added to dialog boxes with DialogBox_AddTextBox, DialogBox_AddLabel, DialogBox_AddCheckBox, DialogBox_AddDropDown, DialogBox_AddComboBox, and DialogBox_AddColorPicker functions. Dialog box objects have a member named "controls" to access the user input after they are displayed.

Properties

Name Type Access Description
controls Array<Mixed> read-only The values provided by the user for the controls on the dialog box after the dialog is displayed with DialogBox_Show function. The value for checkboxes are Bool while the values for textboxes and drop down list boxes are Strings.
type ObjectType read-only Type of this object. Always has the value of "DialogBox".

Reference

Statements

For

ForEach

If

Else If

Else

Switch

Case

Default

While

Expression

Comment

Break

Continue

Return

Hierarchy Objects

NotebookRoot

Notebook

SectionGroup

Section

Page

Page Objects

Title

Outline

Table

Column

Row

Cell

Paragraph

Text

Image

EmbeddedFile

Tag

Other Objects

DialogBox

MacroMenu

Window

Functions

Array Functions

Color Functions

Data Store Functions

Date/Time Functions

Dialog Box Functions

Macro Execution Functions

Macro Menu Functions

Object Functions

String Functions

Window Functions