C++ Syntax

bool

MKI_DialogTextFrame(

HWND f_hWindow,

const LPCWSTR f_pszCaption,

MKI_TEXTFRAME_REF f_rTextFrame,

LPWSTR f_pszEditText,

const size_t f_unMaxSize,

bool f_fAllowCurrentSystem,

bool f_fReadOnly );

Shows and processes a dialog for frame text editing or viewing (including text parameters).

Parameters

f_hWindow

[HWND] Handle of the dialog window's parent window.

f_pszCaption

[const LPCWSTR] Title of the dialog window to be displayed. Be careful that the given title fits into the dialog window's caption.

f_rTextFrame

[MKI_TEXTFRAME_REF] Address of a frame text parameter set. The frame text parameters will be used to initialize the dialog window, and they will receive the selected frame text parameters if the user ends the dialog by pressing the OK button.

f_pszEditText

[LPWSTR] Address of a text. If this address is not nullptr, the text will be used to initialize the dialog window, and it will receive the edited text if the user ends the dialog by pressing the OK button.

f_unMaxSize

[const size_t] Maximum allowed size of the text in characters including the terminating zero. Maximum allowed value is MKI_LENGTH_TEXT_LONG.

f_fAllowCurrentSystem New in Version 2018.1

[bool] If true, the dialog will allow the user to choose "Current" (-1) as coordinate system in f_rData.m_nSystem.

f_fReadOnly New in Version 2020.2

[bool] If true, the dialog will be in read-only mode.

Return Value

Returns true if the dialog window was ended by pressing the OK button and anything inside the window was changed, else false.

Comment

Depending on the value of f_pszEditText, the dialog does have an edit control.