Developer Resources

TextEntryDialog

Overview

Class that represents a text entry dialog.

Constructor

TextEntryDialog()

Methods

TextEntryDialog.getCaption
Gets the caption of the text entry dialog.
TextEntryDialog.getMessage
Gets the message to display in the text entry dialog.
TextEntryDialog.getText
Gets the text of the text entry dialog.
TextEntryDialog.setCaption
Sets the caption for the text entry dialog.
TextEntryDialog.setMessage
Sets the message to display in the text entry dialog.
TextEntryDialog.setText
Sets the text of the text entry dialog.
TextEntryDialog.showDialog
Shows the text entry dialog.

TextEntryDialog.getCaption

function TextEntryDialog.getCaption() : String

Returns

Returns the caption of the text entry dialog.

Description

Returns the caption of the text entry dialog.

TextEntryDialog.getMessage

function TextEntryDialog.getMessage() : String

Returns

Returns the message to display in the text entry dialog.

Description

Returns the message to display in the text entry dialog.

TextEntryDialog.getText

function TextEntryDialog.getText() : String

Returns

Returns the text of the text entry dialog.

Description

Returns the text of the text entry dialog.

TextEntryDialog.setCaption

function TextEntryDialog.setCaption(text : String)

Arguments

text
The text to which to set the caption of the text entry dialog.

Description

Sets the caption of the text entry dialog to text.

TextEntryDialog.setMessage

function TextEntryDialog.setMessage(text : String)

Arguments

text
Sets the message to display in the text entry dialog to text.

Description

Sets the message to display in the text entry dialog to text.

TextEntryDialog.setText

function TextEntryDialog.setText(text : String)

Arguments

text
The text to which to set the text of the dialog.

Description

Sets the text of the text entry dialog.

TextEntryDialog.showDialog

function TextEntryDialog.showDialog() : Boolean

Returns

Returns DialogResult.Ok when the dialog is closed by pressing "OK" or equivalent, and DialogResult.Cancel if the dialog is closed by pressing "Cancel" or equivalent.

Description

Shows a text entry dialog and returns DialogResult.Ok if the user closes the text entry dialog by pressing "OK", or the equivalent, and DialogResult.Cancel if the user closes the text entry dialog by pressing "Cancel", or the equivalent.