Component Palette Icon:

On this page ...

The Button component can be configured to open and/or close windows, write to tags, and run scripts when triggered by an event handler.


NameDescriptionProperty TypeScriptingCategory
Background ColorThe background color of the button. Can be chosen from color wheel, chosen from color palette, or entered as  RGB  or  HSL  value. See Color Selector . Color.buttonBGAppearance

The border surrounding this component. No Border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Field Border, and Line Border.

Note: The border is unaffected by rotation.
This feature was changed in Ignition version 8.1.21:

As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border Painted?

Indicates if the border of this button should be displayed.

This property was removed in 8.1.8

CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE
Default ButtonIf true, this button will be activated when the user presses Enter on the window.boolean.defaultBtnBehavior
Disabled Image PathThe relative path of the image to be displayed when this component is not enabled.String.disabledPathAppearance
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
Fill Area?Controls whether or not this button's internal area is filled.boolean.contentAreaFilledAppearance
FocusableIf 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.boolean.focusableBehavior
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component. See Color Selector . Color.foregroundAppearance
Horizontal AlignmentThe horizontal alignment of the button's contents (text and/or image).int.horizontalAlignmentLayout
Horizontal Text PositionThe horizontal position of the button's text relative to its
Icon-Text SpacingThe space (in pixels) between the icon (if any) and the text (if any).int.iconTextGapAppearance
Image PathThe relative path of the image.String.pathAppearance
MarginThe space between a button's text and its borders.Insets.marginLayout
MnemonicA single letter that will activate the button using 'ALT-mnemonic'.String.mnemonicCharBehavior
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon

If true, button will be opaque. Default is false.

Note: This property was removed in 8.0.0

QualityThe data quality code for any bindings on this component.QualityCode.qualityData
RolloverIf true, the button may indicate that the mouse is hovering over it.boolean.rolloverEnabledBehavior
StylesContains the component's styles.Dataset.stylesAppearance
TextText of this component.String.textAppearance
Vertical AlignmentThe vertical alignment of the button's contents (text and/or image).int.verticalAlignmentLayout
Vertical Text PositionThe vertical position of the button's text relative to its
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Data QualityThe data quality code for any tag bindings on this


Component Functions


  • Description

Virtually "clicks" the button, meaning that its actionPerformed event handler will run.

  • Parameters


  • Return


Extension Functions

This component does not have any extension functions associated with it.


Styled Button

Property NameValue
BorderEtched (Raised)
FontDialog, Bold, 18
TextPress Me!

Image Path

Styled Button

Property NameValue
BorderNo Border
Fill Area?False
Border Painted?False
Image PathBuiltin/icons/48/stop.png

  • No labels