Skip to main content
Version: 7.9


Component Palette Icon:


The List component displays a list of options, allowing freeform selection of the items. It is powered by a Dataset, from which it displays the first column.


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
CursorThe mouse cursor to use when hovering over this
DataThe data for the list. If multiple columns exist, the first will be used.Dataset.dataData
Data QualityThe data quality code for any tag bindings on this
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component.Color.foregroundAppearance
Layout OrientationThis property defines the orientation of the list
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
OpaqueIf false, backgrounds are not drawn. If true, backgrounds are drawn.boolean.opaqueCommon
Row HeightAn integer specifying the row height, or -1 for automatic row
Selected BackgroundThe color of the background for the selected cell(s).Color.selectedBackgroundAppearance
Selected Focus BorderThe border for the selected, focused cell.Border.selectedFocusBorderAppearance
Selected ForegroundThe color of the foreground for the selected cell(s).Color.selectedForegroundAppearance
Selected IndexThe index of the selected cell, or -1 if
Selection ModeThis mode determines if only one cell can be selected at once, or single or multiple
StylesContains the component's styles.Dataset.stylesAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Visible Row CountAn integer specifying the preferred number of rows to display without requiring


See the List Scripting Functions page for the full list of scripting functions available for this component.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page.



Code Snippet
#The following code will print the selected value to the console when called on the 'mouseClicked' event handler.
value = event.source.getSelectedValue()
print value