Latched Button

The latched button is great for telling a PLC to do something. It simply writes a value, and then waits for it to be reset by the PLC before it is available again. Note that this is only applicable when the PLC is programmed to reset the value after reading it. If your PLC expects the HMI to reset the bit, use the Momentary Button. Also note that this component is considered safer than the momentary button, because it receives positive feedback from the PLC that the signal was received, avoiding the timing dangers associated with a Momentary Button.

To use the latched button, bind an OPC tag bidirectionally to the latched button's Value property. When clicked, the button will write the value in its Set Value property to the Value property. Typically, Set Value is 1, and Value is 0 in a ready state, although the logic could be reversed or change simply by altering Set Value. The button can disable itself when it is writing, and will display different text. Note that the button considers itself to be writing whenever Value equals Set Value - you must make sure that the PLC resets this value, otherwise the button will remain in a writing state.

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

Background Color

The background color of the button.

Scripting name	buttonBG
Data type	Color

Background 3D?

Should this button have a 3d type background, or a flat color one?

Scripting name	background3D
Data type	boolean
Flags	expert

Fill Area?

Controls whether or not this button's internal area is filled

Scripting name	contentAreaFilled
Data type	boolean
Flags	expert

Border Painted?

Should the border of this button be displayed?

Scripting name	borderPainted
Data type	boolean
Flags	expert

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

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

Behavior

Rollover

If true, the button may indicate that the mouse is hovering over it.

Scripting name	rolloverEnabled
Data type	boolean
Flags	expert

Focusable

If a button is not focusable, you will not be able to interact with it with the keyboard. This means you can't "tab" over to it.

Scripting name	focusable
Data type	boolean
Flags	expert

Idle Text

The text of the button while its value is not being written

Scripting name	normalText
Data type	String
Flags	bindable

Writing Text

The text of the button while its value is being written

Scripting name	writePendingText
Data type	String
Flags	bindable

Disable While Writing

If true, the button will be disabled while it is writing.

Scripting name	disableWhileWriting
Data type	boolean

Confirm?

If true, a confirmation box will be shown.

Scripting name	confirm
Data type	boolean

Confirm Text

The message to ask the user if confirmation is turned on.

Scripting name	confirmText
Data type	String

Mnemonic

A single letter that will activate the button using 'ALT-mnemonic'.

Scripting name	mnemonicChar
Data type	String
Flags	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

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

Border

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

Scripting name	border
Data type	Border
Flags	expert

Opaque

Is this button completely opaque? Most aren't, so this should usually be false.

Scripting name	opaque
Data type	boolean
Flags	expert

Data

Data Quality

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

Scripting name	dataQuality
Data type	int
Flags	bindable \| expert

Value

The current value. Should be bound bi-directionally to a tag

Scripting name	value
Data type	int
Flags	bindable

Set Value

The value to set the control value to when the button is pushed.

Scripting name	setValue
Data type	int
Flags	bindable

Layout

Margin

The space between a button's text and its borders.

Scripting name	margin
Data type	Insets
Flags	expert

Horizontal Alignment

The horizontal alignment of the button's contents (text and/or image)

Scripting name

horizontalAlignment

Data type

int

Values

2	Left
0	Center
4	Right
10	Leading
11	Trailing

Horizontal Text Position

The horizontal position of the button'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

The vertical alignment of the button's contents (text and/or image)

Scripting name

verticalAlignment

Data type

int

Values

1	Top
0	Center
3	Bottom

Vertical Text Position

The vertical position of the button's text relative to its image

Scripting name

verticalTextPosition

Data type

int

Flags

expert

Values

1	Top
0	Center
3	Bottom

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