C++ Syntax

bool

MKI_DialogSelectVariable(

HWND f_hWindow,

__int32 f_nTextCtlID );

Displays a popup menu offering all available variables for user selection. The function determines either the name of the selected variable (enclosed by ~ characters, NOT the value of the variable) or the content of a selected text module from a collection and inserts it into the given text edit control.

Parameters

Window

[HWND] Handle of the window or dialog window that is the parent of the selection, i.e. that will receive the selection messages.

ButtonRect

[MKI_CONST_INTRECT_PTR] Address of a rectangle structure that contains the bounding rectangle of a button that is used to open the selection. The appearing popup menu will be aligned to that button. If ButtonRect is nullptr, the popup menu will be center to the current mouse cursor position.

TextCtlID New in Version 2020.0

[__int32] Identification number of an edit control whose currently selected text can be saved as a text module in a collection. If negative, saving of a text module is not possible.

Return Value

Returns true, if the user selected a variable and its name has been copied to the text edit control successfully. Otherwise, false is returned.

The user does not necessarily have to select any entry of the popup menu and can close it by pressing the ESC key or by clicking outside the popup menu.