Dialog and Menu Functions

Introduction

Dialog and menu functions allow an Operator Action (written as IEC 61131-3 Structured Text) to open menus and dialogs:

Function	Returns	Description
ConfirmActionDialog	INT	Opens a dialog with a title, a message string, and OK and Cancel buttons.
DialogAddComboBox		Adds a Combo Box to the current dialog definition.
DialogAddGraphicPage		Adds a Graphic Page to the current dialog definition.
DialogAddLabel		Adds a text label to the current dialog definition.
DialogAddNumericKeyPad		Adds a read-only text entry field and a numeric key pad to the current dialog definition.
DialogAddPasswordEntry		Adds a password entry box to the current dialog definition.
DialogAddTextEditor		Adds a multiple line text editor to the current dialog definition.
DialogAddValue		Adds a text entry field mapped to a program variable to the current dialog definition.
DialogNew		Resets the current dialog definition back to empty.
DialogOpen	INT	Opens a current dialog using the current dialog definition.
MenuAddCheckedEntry		Adds a text command with a check mark to the current drop-down menu definition.
MenuAddEntry		Adds a text command to the current drop-down menu definition.
MenuAddSeparator		Adds a separator to the current drop-down menu definition.
MenuAddSubMenu		Adds a submenu to the current drop-down menu definition.
MenuNew		Resets the current drop-down menu definition back to empty.
MenuOpen	INT	Opens a menu using the current drop-down menu definition.
MessageDialog		Opens a dialog with a title, a message string, and an OK button.
StandardTagMenu		Opens the Standard Tag Menu for a tag.
TextEditorDialog	INT	Opens a dialog with a title, a text editor, and OK and Cancel buttons.
TagCommand		Executes a command on a tag, prompting for confirmation or user input if required.
ValueDialog	INT	Opens a dialog with a title, a text editor, and OK and Cancel buttons.

A function that returns a value can be called from an Expression.

These functions can be called from a Structured Text Function Call.

Using Dialog functions

You can use the functions that begin with the word Dialog, for example DialogNew(), DialogAddLabel(), and DialogOpen(), to build custom dialogs.

A usual call sequence is:

Call DialogNew() to reset the current dialog definition back to empty.
Call one or more DialogAdd() functions to add fields to the current dialog definition.
Call DialogOpen() to open the dialog defined by the current dialog definition.

Further Information

Operator Actions

To learn where you can use these functions.

Glossary

For the meaning of terms used in Fernhill SCADA.