Control: Button
  • Display Name: Button
  • Type Name: Button

Description

Use the button to perform actions like opening windows, execute a script or set a tag value.

Buttons may be Active or Inactive. Active corresponds to the ‘Pushed’ state, and inactivate to the ‘Idle’ state. Different types of buttons will behave differently with the mouse events (see Button Property ‘Type’).

Creation

Open the destination window to add the Control.

From the Toolbox, select the Control icon, move the pointer into the window and drag out the initial position and size for the control.

Access

If the Property Editor is not displayed, click on Ribbon > Home > Property Editor

Click on the Control. The Properties for the control will appear in the Property Editor panel and allow changes to be made.

Properties

Name Description
Name Name of the control
Alias Alias of the control
General
Is Visible controls the visibility of the button. Untick to hide this button.
Type Can be one of:
  • Push: normal button behaviour. The button becomes active when the mouse is pressed, and becomes inactive when the mouse is released.
  • Latch: the button becomes active when the mouse is pressed and released. It becomes inactive when the mouse is pressed and released again.
  • Set: the button becomes active when the mouse is pressed and released. It then remains active (the only way to make it inactive is by script or if it is bound to a tag that becomes inactive).
Permissions List of permissions required to action the button. Any mouse event on the button will be ignored unless the current user has all the selected permissions enabled.
See Users panel to define new permissions or edit the current ones.
Template Select a template to use for this control
Layout
X X location in the window to place the control
Y Y location in the window to place the control
Width Default = 20
Width of the control.
Height Default = 120
Height of the control.
Anchor Which edge of the window the control is anchored to when the window is resized
Visual
General: Text Enter the Text to display in the button for the Acrive and Inactive state. Default to ‘Active’ for the Active state and ‘Inactive’ for the Inactive state.
Background: Start Color Select the background start color
Background: End Color Select the background end color
Background: Gradient Mode Select from one of the displayed Gradient modes
Background: Image Select from a list of Project images. See Images.
Background: Image Layout Select from None, Tile or Stretch
Border: Corner Radius Default = 0
To produce rounded corners enter a Radius value.
Border: Thickness Default = 1
Enter the Border thickness.
Border: Color Select the color of the text from the list of available colors define in the project.
Border: Dash Style If the border needs to be dashed select from one of the available dash styles
Shadow: Color If the Panel needs a drop shadow, select the color of the text from the list of available colors defined in the project
Shadow: Distance distance for the drop shadow. Note that the shadow is produced behind the Panel, below and to the right by the specified distance
Font: Family Default = Arial
Select the Font family for the Label text from the System available fonts.
Font: Size Default = 10
Size for the Label text in points.
Font: Style Select from Regular, Bold, Italic, Underline or Strikeout
Font: Alignment Select from Left, Right or Center
Font: Color Select the color of the text from the list of available colors defined in the project
Actions (An action may be triggered when the button becomes active and inactive if the current users has all the required permissions. See “Actions”)
On Active Default = None
Action to take when the Button is changed to Active. It can be selected from one of the System actions.
On Inactive Default = None
Action to take when the Button is changed to Inactive. It can be selected from one of the System actions.

Binding

The following properties may be bound to a tag

  • Active
  • Active Text
  • Active Background Color Start
  • Active Background Color End
  • Active Background Image
  • Active Border Color
  • Active Shadow Color
  • Active Font Color
  • Inactive Text
  • Inactive Background Color Start
  • Inactive Background Color End
  • Inactive Background Image
  • Inactive Border Color
  • Inactive Shadow Color
  • Inactive Font Color
  • Visible

Event Log

Configure an Event Log entry for this control. See “Event Logs”