DisplayTextInputDialog Method
Opens a window to allow data to be entered.
Syntax
object.DisplayTextInputDialog
(
i_Label As String,
i_Title As String,
i_DefaultValue As String
Parameters
| Parameter | Description |
|---|---|
i_Label |
Text to be displayed in the dialog as a label. |
i_Title |
Text to be displayed in the title bar of the window. |
i_DefaultValue |
Default value, which will appear in the input control when it is first displayed to the user. Optional; if you do not specify it, a value of "" is used and the control is displayed with no value. |
Return Value
The return value is an IGrooveSimpleDialogResult object. This object indicates whether the user approved or cancelled the dialog and contains the string entered by the user. If the user clicked the OK button, the IGrooveSimpleDialogResult.Result element has a value of GrooveDialogBoxResultCode_OK and the IGrooveSimpleDialogResult.Data element has the user-entered string. If the user cancels, the IGrooveSimpleDialogResult.result element has a value of GrooveDialogBoxResultCode_Cancel.
Remarks
This method displays a modal dialog and should not be called from a script when a transaction is open. Macros are run within an open transaction; consequently, this method should not be called from a macro. See Accessing Forms Records for more information on this restriction.
See Also
Reference
IGrooveFormsToolUIDelegate Interface
ClearStatusBarMessage Method
DisplayDatePickerDialog Method
DisplayError Method
DisplayOKMessageBox Method
DisplayStatusBarMessage Method
DisplayYesNoMessageBox Method