You're currently browsing the Ignition 7.9 docs. Click here to view the latest docs.

General

Component Palette Icon:


 

Description

The Language Selector component gives an easy way to set the user's locale to control display of dates, times, numbers, and the language used for translations.

Properties
NameDescriptionProperty TypeScriptingCategory
AntialiasDraw with antialias on? Makes text smoother.boolean.antialiasAppearance
Background ColorThe background color of the component.Color.backgroundAppearance
BorderThe border surrounding this component. NOTE that the border is unaffected by rotation.Border.borderCommon
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component.Color.foregroundAppearance
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
Selected LocaleThe display name of the currently selected locale. (Read only. Usable in bindings and scripting.)String.selectedLocaleUncategorized
Selection BackgroundThe background color of a selected cell in the dropdown list.Color.selectionBackgroundAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Scripting
Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have extension functions associated with it.

Event Handlers

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

This event fires when the mouse enters the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

  This event fires when the mouse leaves the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

  This event fires when a mouse button is pressed down on the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

Fires when the mouse moves over a component after a button has been pushed.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

Fires when the mouse moves over a component, but no buttons are pushed.

 

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event.  
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed.
.propertyName

The name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change.       

Customizers

This component does not have any customizers.

Examples
Select Between Languages

Property Name
No property changes made to this component for this example, but there must be at least one Spanish translation in the system.
  • No labels