Component/Label
Namespace
components.label
Constants
The form component module.
Source: lib/modules/components/label.whl, line: 8
Module calls for label component functions.
Source: lib/modules/components/label.whl, line: 11
| LABEL_COMPONENT_SET_HIDDEN | 0 |
| LABEL_COMPONENT_SET_X | 1 |
| LABEL_COMPONENT_SET_Y | 2 |
| LABEL_COMPONENT_SET_FONT_SIZE | 3 |
| LABEL_COMPONENT_SET_TEXT | 4 |
| LABEL_COMPONENT_SET_VALUE_NUMBER | 5 |
| LABEL_COMPONENT_SET_VALUE_STRING | 6 |
Properties
These properties can be edited with the property editor in the IDE.
| Name | Type | Description |
| name | string | The component name. |
| x | number | The left position of the component inside the parent component. |
| y | number | The top position of the component inside the parent component. |
| y | number | The font size. |
| zIndex | number | The depth of the component related to other components in the parent. |
| width | number | The label width. |
| halign | halign | The horizontal alignment of the text which can be: left, center or right. |
| text | string | The label text. |
| value | string | The value text, displayed on the right side of the text. |
Procedures
setHidden
Source: lib/modules/components/label.whl, line: 31
Hide the label.
proc setHidden(number windowHandle, number componentHandle, number hidden)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| hidden | number | Hidden TRUE or FALSE. |
setX
Source: lib/modules/components/label.whl, line: 40
Set the x position of the label.
proc setX(number windowHandle, number componentHandle, number x)
Parameters:
| 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
Source: lib/modules/components/label.whl, line: 49
Set the y position of the label.
proc setY(number windowHandle, number componentHandle, number y)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| y | number | The y position in pixels. |
setFontSize
Source: lib/modules/components/label.whl, line: 58
Set the font size of the label text.
proc setFontSize(number windowHandle, number componentHandle, number fontSize)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| fontSize | number | The font size in pixels, the default value is 16. |
setText
Source: lib/modules/components/label.whl, line: 67
Set label text.
proc setText(number windowHandle, number componentHandle, string text)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| text | string | The label text. |
setValueNumber
Source: lib/modules/components/label.whl, line: 76
Set label value as a number.
proc setValueNumber(number windowHandle, number componentHandle, number n)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| n | number | The label value. |
setValueString
Source: lib/modules/components/label.whl, line: 85
Set label value as a number.
proc setValueString(number windowHandle, number componentHandle, string s)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| s | string | |
