ToggleButton

Switch for switching an option on or off.

Symbol

Menu ribbon

Start > Controls > Buttons > General > ToggleButton

The "ToggleButton" control element is used to call up any function that triggers an event by pressing it with the mouse, keyboard or finger. A digital process variable value can also be changed. Pressing the ToggleButton toggles the value (false æ true or trueæ false). The standard display stands out from the background as a visible button and also displays text and/or a graphic. In addition, the "ToggleButton" is graphically animated when hovered over with the mouse and when pressed/released, e.g. through shadow effects and colour changes.

ToggleButton on and ToggleButton off

Functionalities

The control element supports the following functionality:

You can configure these functionalities via the properties in the Properties window when you select the control in the Designer or in the document outline. Whether a property is visible in the properties window depends on the style of the control.

Style

By default, the control uses the "Plain.Default" style. Other system styles are available for the control in the "Style" property from the "General properties" category.

Certain properties may be missing in the Properties window for styled controls. For example, the "Colors" category is not available for controls in the system styles. These properties cannot be edited in the system styles.

You can also create your own styles for the control element. These styles are available for selection in the "Style" property after creation.

Structure

The control element consists of a number of other elements. Both the control itself and its elements can be configured via the properties of the control. Properties for a sub-element of the control can usually be found in the category that bears the name of this element.

Example: The properties for configuring the "Text" element can be found in the Properties window in the "Text" category when you select the control element in the Designer or in the document outline.

The toggle button and its elements

Related topics: