Component/TextInput

Namespace

Constants

MODULE_COMPONENT_TEXT_INPUT

70

TEXT_INPUT_COMPONENT_SET_HIDDEN	0
TEXT_INPUT_COMPONENT_SET_DISABLED	1
TEXT_INPUT_COMPONENT_SET_X	2
TEXT_INPUT_COMPONENT_SET_Y	3
TEXT_INPUT_COMPONENT_GET_TEXT_VALUE	4
TEXT_INPUT_COMPONENT_SET_TEXT_VALUE	5
TEXT_INPUT_COMPONENT_GET_NUMBER_VALUE	6
TEXT_INPUT_COMPONENT_SET_NUMBER_VALUE	7
TEXT_INPUT_COMPONENT_SET_PLACE_HOLDER	8

Properties

These properties can be edited with the property editor in the IDE.

Name	Type	Description
name	string	The component name.
hidden	boolean	Hide the component.
disabled	boolean	Disable the component.
x	number	The left position of the component inside the parent component.
y	number	The top position of the component inside the parent component.
zIndex	number	The depth of the component related to other components in the parent.
width	number|empty	The width of the input, if empty then the default size is used.
value	number|string	The value.
numeric	boolean	Select if the input only accepts numeric values or any text.

Events

onChange

Called when the text input is selected or unselected.

proc onChange(number windowHandle, number value)

Name	Type	Description
windowHandle	number	The handle of the parent window of the text input.
value	number	`TRUE` when checked, `FALSE` if not checked.

onFocus

Called when the text input is focussed.

proc onFocus(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the text input.

onBlur

Called when the text input looses focus.

proc onBlur(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the text input.

---

Procedures

setHidden

Hide the text input.

proc setHidden(number windowHandle, number componentHandle, number hidden)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
hidden	number	Hidden TRUE or FALSE.

---

setDisabled

Disable the text input.

proc setDisabled(number windowHandle, number componentHandle, number disabled)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
disabled	number	Disabled TRUE or FALSE.

---

setX

Set the x position of the text input.

proc setX(number windowHandle, number componentHandle, number x)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
x	number	The x position in pixels.

---

setY

Set the y position of the text input.

proc setY(number windowHandle, number componentHandle, number y)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
y	number	The y position in pixels.

---

getTextValue

Get the text input text value.

proc getTextValue(number windowHandle, number componentHandle, string text)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
text	string	The string to store the text value.

---

setTextValue

Set the text input text value.

proc setTextValue(number windowHandle, number componentHandle, string text)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
text	string	The text input value.

---

getNumberValue

Get the text input number value.

proc getNumberValue(number windowHandle, number componentHandle)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.

---

setNumberValue

Set the text input number value.

proc setNumberValue(number windowHandle, number componentHandle, number value)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
value	number

---

setPlaceHolder

Set the text input place holder text.

proc setPlaceHolder(number windowHandle, number componentHandle, string placeHolder)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
placeHolder	string	The text input hint.

---