List box
List whose selectable elements are obtained from project nodes or from one or more database tables
- BrowseName
- ListBox
- SuperType
- Element(Item)
Properties
| Name | BrowseName | DataType | Description |
|---|---|---|---|
| Model | Model | NodeId | Reference to the information model or database from which to obtain the data |
| Selected value | SelectedValue | BaseDataType | Value of the property set in Path of the value selected when an element is selected at runtime |
| Selected item | SelectedItem | NodeId | Element selected when the object is initialized at runtime (if empty, it is initialized without selections). After initialization, this property displays the node corresponding to the selected element (access to the property is both read and write when the data are obtained from project nodes, read-only when obtained from a database) |
| UI selected item | UISelectedItem | NodeId | Returns the element of the list that is selected at runtime |
| UI selected value | UISelectedValue | BaseDataType | Value of the property of the element that is selected at runtime |
| Allow deselection | AllowDeselection | Boolean | Allow deselecting elements from the list (no selected items) |
| Display value path | DisplayValuePath | LocalizedText | Attribute/property of the nodes (or column of a database table) whose value is displayed in the list. When this property is empty, if the model is node-based, the BrowseName of the nodes is displayed; if the model is based on a database, the value of the first cell of each row is displayed, except for queries that further filter the values |
| Selected value path | SelectedValuePath | BaseDataType | The property of the selected element used to assign a value to the Selected Value object when an element is selected at runtime |
| Query | Query | String | Standard SQL query to filter the data of interest. You can use it to filter data from a database and to filter data obtained from a node-based model. In case of a node-based model, the SELECT * FROM Model part is mandatory, followed by the WHERE clause with which to indicate the search conditions - for example, SELECT * FROM Model WHERE Speed > 40 |
| Font family | FontFamily | Font | Font family |
| Font weight | FontWeight | Font weight | Font weight |
| Font italic | FontItalic | Boolean | Enables/disables italics in the text |
| Font size | FontSize | Size | Font size |
| Text color | TextColor | Color | Color of the text to display |
| Sort order | SortOrder | Sorting | Default sort order, ascending or descending, of the elements |
| Order by | OrderBy | NodePath | Attribute/property of the nodes or column of a table by which to sort the elements. Generally the same attribute/property or column from which the elements are obtained is set |
| DataList style | DataListStyle | String | Style for data lists |
| ScrollBar style | ScrollBarStyle | String | Style for scrollbars |
| Visible | Visible | Boolean | (Inherited from Element) |
| Enabled | Enabled | Boolean | (Inherited from Element) |
| Opacity | Opacity | Float | (Inherited from Element) |
| Left margin | LeftMargin | Size | (Inherited from Element) |
| Top margin | TopMargin | Size | (Inherited from Element) |
| Right margin | RightMargin | Size | (Inherited from Element) |
| Bottom margin | BottomMargin | Size | (Inherited from Element) |
| Width | Width | Size | (Inherited from Element) |
| Height | Height | Size | (Inherited from Element) |
| Horizontal alignment | HorizontalAlignment | Horizontal alignment | (Inherited from Element) |
| Vertical alignment | VerticalAlignment | Vertical alignment | (Inherited from Element) |
| Rotation | Rotation | Size | (Inherited from Element) |
Methods
Refresh
- BrowseName
- Refresh
Refresh the displayed data
Events
User selection changed
- BrowseName
- User selection changed
Event that is triggered when the user changes the current value or status of the control