Top  | Previous | Next

Numeric Label

display_NumericLabel

Description

This component is a specialized label designed to display a number. It can include units, and has an integrated number format string. By default the number is displayed bold and the units are not. This can be customized, see the Prefix and Suffix expert properties. This label's text is constructed as follows:

 

Prefix + numberFormat(Value, Pattern) + Suffix + Units

 

It is important to note that you could customize the standard Label component using custom properties and bindings to mimic this component exactly. If this component doesn't do something that you need, you can make your own numeric label and use it everywhere in your project.

Properties

Appearance

Font

Font of text of this component

Scripting name

font

Data type

Font

Foreground Color

The foreground color of the component.

Scripting name

foreground

Data type

Color

Flags

bindable

Background Color

The background color of the component.

Scripting name

background

Data type

Color

Flags

bindable

Number Format Pattern

The number formatting string used to format the value.

Scripting name

pattern

Data type

String

Fill Background

If true, the label's background color will be drawn. If false, it will have a transparent background.

Scripting name

fillBackground

Data type

boolean

Flags

bindable

Image Path

The relative path of the image.

Scripting name

path

Data type

String

Flags

bindable

Disabled Image Path

The relative path of the image to be displayed when this component is not enabled.

Scripting name

disabledPath

Data type

String

Flags

expert

Icon-Text Spacing

The space (in pixels) between the icon (if any) and the text (if any)

Scripting name

iconTextGap

Data type

int

Rotation

The angle of rotation in degrees.

Scripting name

rotation

Data type

int

Antialias

Draw with antialias on? Makes text smoother

Scripting name

antialias

Data type

boolean

Flags

expert

Styles

Contains the component's styles

Scripting name

styles

Data type

Dataset

Flags

bindable | expert

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Enabled

If disabled, a component cannot be used.

Scripting name

componentEnabled

Data type

boolean

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name

toolTipText

Data type

String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0

Default

1

Crosshair

2

Text

3

Wait

12

Hand

13

Move

4

SW Resize

5

SE Resize

6

NW Resize

7

NE Resize

8

N Resize

9

S Resize

10

W Resize

11

E Resize

Data

Value

The numeric value of this label.

Scripting name

value

Data type

double

Flags

bindable

Units

The engineering units to display after the number.

Scripting name

units

Data type

String

Prefix

A string that will be placed before the number.

Scripting name

prefix

Data type

String

Flags

expert

Suffix

A string that will be placed after the number, and before the units.

Scripting name

suffix

Data type

String

Flags

expert

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Layout

Horizontal Alignment

Determines the alignment of the label's contents along the X axis

Scripting name

horizontalAlignment

Data type

int

Values

2

Left

0

Center

4

Right

10

Leading

11

Trailing

Horizontal Text Position

Determines the horizontal position of the label's text, relative to its image

Scripting name

horizontalTextPosition

Data type

int

Flags

expert

Values

2

Left

0

Center

4

Right

10

Leading

11

Trailing

Vertical Alignment

Determines the alignment of the label's contents along the Y axis

Scripting name

verticalAlignment

Data type

int

Values

1

Top

0

Center

3

Bottom

Vertical Text Position

Determines the vertical position of the label's text, relative to its image

Scripting name

verticalTextPosition

Data type

int

Flags

expert

Values

1

Top

0

Center

3

Bottom

Uncategorized

Text

Text of this Label

Scripting name

text

Data type

String

Flags

bindable | read-only

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

•mouse
•mouseMotion
•propertyChange

 

Scripting Functions

This component has no special scripting functions.