Methods of the Dialog Manager

Visualizations that are a “Dialog” visualization type and are used to prompt an input are instantiated automatically and managed by the internal dialog manager.

In the application, the dialog manager can be accessed via the also internal Visualization Manager by calling the method ‎GetDialogManager‎.

The dialog manager is provided with the following methods for handling a dialog.

NOTICE

You can program the method calls in function blocks or functions which are themselves called from the visualization by the action ‎Execute ST Code‎.

Moreover, you can program the method calls in the application code. Make sure that the call runs in ‎VISU_TASK‎. If this is not the case, then the behavior is undefined.

Method 'GetDialog'

Returns the instance (‎IVisualisationDialog‎) of the dialog whose name is passed.

Table 675: Inputs (VAR_INPUT)
Name	Data Type	Description
`‎stName‎`	`‎STRING‎`	Name of the dialog

Table 676: Outputs (VAR_OUTPUT)
Name	Data Type	Description
`‎GetDialog‎`	`‎VisuElems.IVisualisationDialog ‎`	Instance (`‎IVisualisationDialog‎`) of the dialog

Method 'GetClientInterface'

Returns a pointer to the dialog structure.

Respective dialog data held for each display variant.

Table 677: Inputs (VAR_INPUT)
Name	Data Type	Description
`‎dialog‎`	`‎VisuElems.IVisualisationDialog‎`	Name of the visualization
pClient	`‎POINTER TO VisuElems.IVisualisationDialogVisuStructClientData‎`	Pointer to the display variant

Table 678: Outputs (VAR_OUTPUT)
Name	Data Type	Description
`‎GetClientInterface‎`	Example: `‎POINTER TO Login_VISU_STRUCT‎`	Pointer to the dialog structure

Method 'OpenDialog'

Opens the dialog of the client.

Next to it, there is the extended method 'OpenDialog(number)'.

Table 679: Inputs (VAR_INPUT)
Name	Data Type	Description
`‎dialog‎`	`‎VisuElems.IVisualisationDialog‎`	Name of the visualization
`‎pClient‎`	`‎POINTER TO VisuElems.VisuStructClientData‎`
`‎bModal‎`	`‎BOOL‎`
`‎pRect‎`	`‎POINTER TO‎`

Table 680: Outputs (VAR_OUTPUT)
Name	Data Type	Description
`‎OpenDialog‎`

Method 'CloseDialog'

Closes the dialog of the client.

Table 681: Inputs (VAR_INPUT)
Name	Data Type	Description
`‎dialog‎`	`‎VisuElems.IVisualisationDialog‎`	Dialog object as received by `‎GetDialog‎`
`‎pClient‎`	`‎POINTER TO VisuElems.VisuStructClientData‎`

Table 682: Outputs (VAR_OUTPUT)
Name	Data Type	Description
`‎CloseDialog‎`

Method 'CloseDialog2'

Closes the dialog of the client. Extension of the method ‎CloseDialog‎.

Table 683: Inputs (VAR_INPUT)
Name	Data Type	Description
`‎dialog‎`	`‎VisuElems.IVisualisationDialog‎`	Dialog object as received by `‎GetDialog‎`
`‎pClient‎`	`‎POINTER TO VisuElems.VisuStructClientData‎`
`‎DialogFlags‎`	`‎DWORD‎`	Specification of possible options for closing the dialogs. Only the values 0 (behavior as for `‎CloseDialog‎`) and 16#40 are relevant in the case that a dialog should be closed on all connected clients.

Table 684: Outputs (VAR_OUTPUT)
Name	Data Type	Description
`‎CloseDialog2‎`