List

A list is a control that displays a list of items.

It can be used to send commands or set datapoints.

Attributes

Common

ID

Sets the object's ID.

The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.

The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.

IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dinamically attached to a set of attribute values.

E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:

Value binding:

="mybutton" + ui('button', 'address')

UISet:

UISet('button', 'address', '1') switches the ID to mybutton1

UISet('button', 'address', '2') switches the ID to mybutton2

Position and Size

Position

Sets the object's position.

Attribute Values

Value	Description	Example
x<left>y<top>	Specify left/top coordinates in pixels.	x10y20

This attribute is available when parent's layout is neither "flex" nor "grid".

When parent's layout is neither "flex" nor "grid", this attribute defaults to x0y0.

Flex Grow

Specifies if the objects should grow to fill the available space.

Attribute Values

Value	Description
false	Default value. Objects do not grow to fill the available space.
true	Objects expand to fill the available space.

This attribute is available when parent's layout is "flex".

The default value is: false.

Flex Shrink

Specifies if the objects should shrink to fit the available space.

Attribute Values

Value	Description
false	Default value. Objects do not shrink to fit the available space.
true	Objects shrink to fit the available space.

This attribute is available when parent's layout is "flex".

The default value is: false.

Column

Specifies the starting column of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column index starting from 1.

This attribute is available when parent's layout is "grid".

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Column Span

Specifies how many grid columns the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Row

Specifies the starting row of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
[empty]	Auto placement by the grid.
<int>	Row index starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to auto.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Row Span

Specifies how many grid rows the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Row span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Width

Sets the object's width in pixels.

Possible values are from 50 to 2000.

Height

Sets the object's height in pixels.

Possible values are from 46 to 2000.

Data

Data Mode

Specifies the mode of the data.

Attribute Values

Value	Description
items	Default value. Data is set with the UI attribute Items.
list	Data is a list of comma-separated values. Set in the List attribute.
datasource	Data is set by a linked datasource.

The default value is: items.

Items

Specifies the items.

Attribute Values

Value	Description	Example
<JSON array>	Array of list items.	[{"value":"kitchen","label":"Kitchen"}]

This attribute is available when datamode is "items".

List

Sets the items. An item with a label "---" (three hyphen-minus characters) is treated as a separator and its value is ignored.

Attribute Values

Value	Description	Example
<comma-separated list>	Items specified as a comma-separated list.	item1,item2,item3
<array>	Items specified as an array of strings.	["item1","item2","item3"]
<array of arrays>	Items specified as an array of arrays. Each item has an array of value and label.	[[1,"label1"],[2,"label2"],[3,"label3"]]
<array of arrays>	Items specified as an array of arrays. Each item has an array of values that can be recalled from the template attribute.	[[1,"label1","descr1"],[2,"label2","descr2"],[3,"label3","descr3"]]

This attribute is available when datamode is "list".

Datasource ID

Specifies the ID of the datasource.

The datasource keys are used as values, while a column specified in Label Data Name is used as label.

Attribute Values

Value	Description
<string>	ID of the datasource.

This attribute is available when datamode is "datasource".

Label Data Name

Specifies the name of the column containing the label.

Attribute Values

Value	Description
<string>	Name of the column containing the label.

This attribute is available when datamode is "datasource".

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Values

This attribute is available when datamode is "list".

note

This attribute has been deprecated since ver. 4.0

Labels

This attribute is available when datamode is "list".

note

This attribute has been deprecated since ver. 4.0

Template

Specifies the template for the items.

The template can contain placeholders for the values of the items. The placeholders are specified as %0;, %1;, %2;, etc.

For example, if the template is %0; - %1;, %2; and the item is ["value", "label", "descr"], the result is value - label, descr.

If the template is not specified, the items' labels are displayed.

Wrap

Specifies the wrap mode.

Attribute Values

Value	Description
none	No wrap.
breakword	Default value. Wrap at word boundaries.
breakall	Wrap at any character.

The default value is: breakword.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Action

Action

Specifies the action to perform when the user selects an item.

The action is associated with the item's value.

In datasource mode, the item's value is the key or the index, if the key is missing.

Use select when the list should behave as a field: the selected item key is stored in the Value attribute and is submitted as a comma-separated string. To also notify the server with a JSON selection-change command, enable select in the Commands attribute.

Use command when clicking an item should send a command: the command name is specified in the Name attribute and the clicked item value is sent as the command parameter. Use Commands for JSON collection events such as add, edit, delete, move and selection changes.

Attribute Values

Value	Description
none	Default value. No action.
select	Field value selection. The selected item keys are stored in Value and submitted as a comma-separated string, or auto-sent when Auto Send is enabled.
link	Opens the link specified as the item's value.
command	Sends a command with the item's value as the command parameter.
download	Downloads the file with path specified as the item's value.

The default value is: none.

Selection Mode

Specifies the selection mode.

Attribute Values

Value	Description
single	Default value. Single selection.
multi	Multiple selection.
multi-key	Multiple selection with keys modifiers: Ctrl/Meta to toggle, Shift to select range.

This attribute is available when action is "select".

The default value is: single.

Name

Specifies the command name that is sent to the server.

If the name starts with $, then the server will automatically set a variable with the same name as the command, containing the command's parameter.

Attribute Values

Value	Description	Example
<string>	A command name.
$[variable name]	A command name that sets a variable.	$myvar
$[variable name]!	A command name that sets a persistent variable.	$myvar!

This attribute is available when action is one of "select", "command", or "download".

When action is one of "select", "command", or "download", this attribute defaults to the id attribute.

Value

Specifies the value of the selected item.

Attribute Values

Value	Description	Example
<string>	The value of the selected item.	value1
<comma-separated list>	A list of values of the selected items (in multi selection mode).	value1,value2

This attribute is available when action is "select".

Repeat

If enabled, the command will be repeated every second. Instead of a single command on the button press event, multiple commands are sent with the following suffixes:

• <command name>/down: on mouse down or touch down events
• <command name>/repeat: if the button is still pressed, a repeat command is sent every second
• <command name>/up: on mouse up or touch up events, for a short press (less than a second, so no repeat commands have been sent yet)
• <command name>/stop: on mouse up or touch up events, for a long press (more than a second, so at least a repeat command has been sent)

Attribute Values

Value	Description
false	Default value. Repeat mode is disabled.
true	Repeat mode is enabled.

This attribute is available when action is "command".

The default value is: false.

Auto Send

Specifies whether the value is automatically sent on change or is sent through a button with submit action.

Attribute Values

Value	Description
auto	The value is sent only if there's no buttons with submit action in the same or a parent container.
true	The value is sent automatically on change.
false	Default value. The value is not automatically sent.

This attribute is available when action is "select".

The default value is: false.

Required

Specifies if the field is required when submitting multiple fields with a submit button. If true, an empty/null value is considered not valid. When there are non valid fields, the submit button focuses the first non valid field instead of sending data to the server, to prompt the user to fill in the required fields.

Attribute Values

Value	Description
false	Default value. The field is not required.
true	The field is required.

This attribute is available when action is "select".

The default value is: false.

Selection Marker

Controls the normal selection marker displayed next to selected items.

Attribute Values

Value	Description
auto	Default value. Use the default marker for the object and selection mode.
check	Display a check mark.
hidden	Hide the normal selection marker.

This attribute is available when action is "select".

When action is "select", this attribute defaults to auto.

Edit Options

Edit Mode

Controls the edit mode. When edit mode is true, collection editing interactions are enabled.

Attribute Values

Value	Description
false	Default value. Edit not enabled.
true	Edit enabled.
toggle	Edit mode can be toggled by the user.

The default value is: false.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Item Controls

Specifies which fixed item controls are visible in edit mode.

Attribute Values

Value	Description
selection	Displays a selection checkbox used by edit operations. When Action is select, this checkbox controls the same field Value as row selection.
move	Displays a drag handle that can be used to move the item.
edit	Displays an edit button on the right.
add	Displays an add button on the right. The add command includes the item as placement context; in trees it adds inside the item.
delete	Displays a delete button on the right.

This attribute is available when editmode is not "false".

When editmode is not "false", this attribute defaults to selection,move,edit,add,delete.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Item Drag

Enables dragging from the item body in edit mode. Use Item Controls=move to display a separate move handle.

Attribute Values

Value	Description
true	Items can be moved by dragging the item body.
false	Default value. The item body is not draggable.

This attribute is available when editmode is not "false".

When editmode is not "false", this attribute defaults to false.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Toolbar Controls

Specifies which controls are visible in the bottom edit toolbar.

Attribute Values

Value	Description
add	Displays an add button. The add command includes the current selection context when exactly one item is selected.
edit	Displays an edit button for the current selection.
delete	Displays a delete button for the current selection.

This attribute is available when editmode is not "false".

When editmode is not "false", this attribute defaults to add,edit,delete.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Delete Confirm

Requires a confirmation before deleting the item(s).

Attribute Values

Value	Description
false	Default value. No confirmation, the item(s) is deleted right away.
doubleclick	A second click or touch is required to confirm the deletion.
popup	A popup is displayed to ask for confirmation.

This attribute is available when editmode is not "false".

The default value is: false.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Delete Confirm Message

The confirmation message to be displayed if the "confirm" attribute is set to "popup".

Attribute Values

Value	Description	Example
<string>	The message to be displayed in the confirm popup.	Are you sure?

This attribute is available when editmode is not "false" and deleteconfirm is "popup".

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Commands

Specifies the commands that are sent to the server when the user performs collection actions.

In items and list modes, add, edit, delete and move actions are sent as commands when edit mode is enabled. In datasource mode, add, edit and delete are handled through datasource callbacks, while move is sent as a command. The select command can be enabled for lists and trees with Action=select, and sends a JSON selection-change command. These commands are JSON collection events, separate from Action=command, which sends a command when the user clicks an item.

Add commands include placement context. The footer add button sends the selected key when exactly one item is selected. In trees it also sends the selected node's parent and collapsed state, so the server can decide where to add the new node. The item add control sends origin: "item" with the item key; in trees it also sends parent with the same item key. Toolbar add does not include origin.

Pre-commands can specify field modifiers and an editpopup property in the JSON reply, as in table edit popups.

Attribute Values

Value	Description
pre-add	Sends a command before opening the add popup, including default values for the popup fields. Command parameter: { "action": "pre-add", "values": { "<field name>": "<value>", ... }, "popup": "<popup id>" } When the add is based on a selected item, the selected item key is also sent: { "action": "pre-add", "key": "<item key>", "values": { ... }, "popup": "<popup id>" } For trees, the selected node's parent and collapsed state are included when available: { "action": "pre-add", "key": "<node key>", "parent": "<parent key>", "collapsed": "true&#124;false", "values": { ... }, "popup": "<popup id>" } When the add is started from an item add control, origin is set to item: { "action": "pre-add", "origin": "item", "key": "<item key>", "values": { ... }, "popup": "<popup id>" } For tree item add controls, parent is the same as key: { "action": "pre-add", "origin": "item", "key": "<node key>", "parent": "<node key>", "values": { ... }, "popup": "<popup id>" } In the JSON reply, the server can specify UISets for specific edit field attributes: { "fields": { "<field name>": { "value": "value", "enabled": "false", "type": "select", ... }, ... } } The server can also specify a custom edit popup to open: { "editpopup": "<popup id>", "fields": { ... } } This action can be canceled by the server by replying with: { "cancel": true }.
pre-edit	Sends a command before opening the edit popup, including the item key and the current values of all popup fields. Command parameter: { "action": "pre-edit", "key": "<item key>", "values": { "<field name>": "<value>", ... }, "popup": "<popup id>" } For multiple item updates, the key property is replaced by keys: { "action": "pre-edit", "keys": ["<item key>", ...], "values": { "<field name>": "<value>", ... }, "popup": "<popup id>" } In the JSON reply, the server can specify UISets for specific edit field attributes: { "fields": { "<field name>": { "value": "value", "enabled": "false", "type": "select", ... }, ... } } The server can also specify a custom edit popup to open: { "editpopup": "<popup id>", "fields": { ... } } This action can be canceled by the server by replying with: { "cancel": true }.
pre-delete	Sends a command before deleting items. Command parameter: { "action": "pre-delete", "keys": ["<item key>", ...] } The server can cancel the delete by replying with: { "cancel": true }.
add	Sends a command when the user confirms the add popup. Command parameter: { "action": "add", "data": { "<field name>": "<value>", ... }, "popup": "<popup id>" } When the add is based on a selected item, the selected item key is also sent: { "action": "add", "key": "<item key>", "data": { ... }, "popup": "<popup id>" } For trees, the selected node's parent and collapsed state are included when available: { "action": "add", "key": "<node key>", "parent": "<parent key>", "collapsed": "true&#124;false", "data": { ... }, "popup": "<popup id>" } When the add is started from an item add control, origin is set to item: { "action": "add", "origin": "item", "key": "<item key>", "data": { ... }, "popup": "<popup id>" } For tree item add controls, parent is the same as key: { "action": "add", "origin": "item", "key": "<node key>", "parent": "<node key>", "data": { ... }, "popup": "<popup id>" }.
edit	Sends a command when the user confirms the edit popup. Command parameter: { "action": "edit", "key": "<item key>", "data": { "<field name>": "<value>", ... }, "popup": "<popup id>" } For multiple item updates, the key property is replaced by keys: { "action": "edit", "keys": ["<item key>", ...], "data": { "<field name>": "<value>", ... }, "popup": "<popup id>" }.
delete	Sends a command when the user deletes items. Command parameter: { "action": "delete", "keys": ["<item key>", ...] }.
move	Sends a command when the user moves an item. Item Drag enables dragging from the item body. Item Controls=move displays a separate drag handle. List command parameters: { "action": "move", "key": "<item key>", "after": "<item key>" } { "action": "move", "key": "<item key>", "before": "<item key>" } Tree command parameters: { "action": "move", "key": "<node key>", "parent": "<parent key>", "after": "<node key>" } { "action": "move", "key": "<node key>", "parent": "<parent key>", "before": "<node key>" } { "action": "move", "key": "<node key>", "parent": "<target parent key>" } The key property is the moved item. before and after are sibling placement anchors. parent is the target parent for tree moves, or null for a root-level tree move.
select	Sends a command when the selected field value changes. Command parameter: { "action": "select", "keys": ["<item key>", ...] } The keys property is an array of all selected item keys.
edit-change	Sends a command when the user changes the value of a field in the add/edit popup. Command parameter: { "action": "edit-change", "field": "<field name>", "values": { "<field name>": "<value>", ... }, "popup": "<popup id>" } When editing one item, the item key is included: { "action": "edit-change", "key": "<item key>", "field": "<field name>", "values": { "<field name>": "<value>", ... }, "popup": "<popup id>" } For multiple item updates, the key property is replaced by keys: { "action": "edit-change", "keys": ["<item key>", ...], "field": "<field name>", "values": { "<field name>": "<value>", ... }, "popup": "<popup id>" } In the JSON reply, the server can specify UISets for specific edit field attributes: { "fields": { "<field name>": { "value": "value", "enabled": "false", "type": "select", ... }, ... } }.

This attribute is available when editmode is not "false" or action is "select".

Default behavior:

• When editmode is not "false" and datamode is not "datasource", this attribute defaults to add,edit,delete,move.
• When editmode is not "false" and datamode is "datasource", this attribute defaults to move.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Edit Popups

Configures custom add/edit popup forms. The default add and edit entries start with Value and Label fields.

Attribute Values

Value	Description
<JSON>	A JSON defining the edit popup overrides.

This attribute is available when editmode is not "false".

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Toolbar

Item Label

Specifies a label to use when referring to the items. It's used in the bottom toolbar item count. Singular and plural words can be specified by separating them with a pipe character ("|").

Attribute Values

Value	Description	Example
<string>	The item labels.	`person

The default value is: item|items.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Show Item Count

Shows the item count in the bottom toolbar.

Attribute Values

Value	Description
true	Default value. Show.
false	Hide.

The default value is: true.

Filter

Filter

Displays an input field for filtering the items. After typing a value in the field or setting the Filter Value attribute, any item that does not match the input will be hidden. A match occurs when the filter value is found anywhere within any item's fields ('value', 'label', etc).

Attribute Values

Value	Description
true	Display the filter field.
false	Default value. Hides the filter field.

The default value is: false.

Filter Placeholder

Specifies a short hint that is displayed in the filter field before the user enters a value. Describes the expected value of an input field (e.g. a sample value or a short description of the expected format)

Attribute Values

Value	Description
<string>	A short hint.

This attribute is available when filter is "true".

Filter Value

Specifies a string used as filter value. It's applied even if the filter field is hidden.

Attribute Values

Value	Description	Example
<string>	The filter string.	Jan 2015

Panel

Panel

Shows a panel that frames the object. Its style can be modified.

Attribute Values

Value	Description
true	Default value. Shows the panel.
false	Hides the panel.

The default value is: true.

Panel Color

Specifies the panel color.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight important areas.
warning	Warning color, used to highlight warning areas.
success	Success color, used to highlight success areas.
error	Error color, used to highlight error areas.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

This attribute is available when panel is "true".

The default value is: default.

Panel Custom Color

Specifies the panel custom color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

This attribute is available when panelstyle is "custom" or panelstyle is "glass" or panelcolor is "custom".

Typography

Font Family

Specifies the font family.

The default value is: default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

The default value is: 14.

Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

The default value is: normal.

Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

The default value is: false.

Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

The default value is: false.

Decoration

Specifies the text decoration.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

The default value is: none.

Text Align

Sets the horizontal alignment of the text.

Attribute Values

Value	Description
none	Default value. No alignment.
left	Left alignment.
right	Right alignment.
center	Center alignment.
justify	Justified alignment.

The default value is: none.

Line Height

Sets the line height of the text.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

The default value is: 1.0.

Layout

Auto Scroll

Scrolls to the bottom of the list automatically, unless the user has scrolled up.

Attribute Values

Value	Description
false	Default value. False.
true	True.

The default value is: false.

Horizontal Borders

Displays horizontal borders.

Attribute Values

Value	Description
false	Default value. False.
true	True.

The default value is: false.

Striped

Adds zebra-striping to rows.

Attribute Values

Value	Description
false	Default value. False.
true	True.

The default value is: false.

Highlight Selected

Specifies wether the selected items are highlighted.

Attribute Values

Value	Description
true	Default value. Highlight.
false	No highlight.

The default value is: true.

CSS Style

note

This attribute has been deprecated since ver. 4.0

View

Visible

Sets the object's visibility.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

The default value is: true.

Enabled

Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

The default value is: true.

Blink

Blinks the object at the specified speed.

Attribute Values

Value	Description
false	Default value. Not blinking.
slow	Blinks slowly.
fast	Blinks fast.

The default value is: false.

Transition

Specifies the transition effect when the object is shown or hidden.

Attribute Values

Value	Description
none	Default value. No transition.
fade	Fade in/out.
fade-left	Slide from left and fade in/out.
fade-right	Slide from right and fade in/out.
fade-up	Slide from top and fade in/out.
fade-down	Slide from bottom and fade in/out.
slide-left	Slide from left.
slide-right	Slide from right.
slide-up	Slide from top.
slide-down	Slide from bottom.
zoom-in	Zoom in.
zoom-out	Zoom out.
3d-flip-left	3D flip from left.
3d-flip-right	3D flip from right.

The default value is: none.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Transition Duration

Specifies the transition duration in milliseconds.

Attribute Values

Value	Description
<integer>	Duration in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 300.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Transition Delay

Specifies the transition delay in milliseconds.

Attribute Values

Value	Description
<integer>	Delay in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Opacity

Sets the object's opacity. Opacity is the degree to which content behind an object is hidden.

Attribute Values

Value	Description
0	The object is fully transparent.
>0.0, <1.0	The object is translucent (content behind the element can be seen).
1.0	Default value. The object is fully opaque.

The default value is: 1.0.

Rotation

Specifies the degrees by which the object is rotated. A positive number rotates it clockwise, while a negative value rotates it counter-clockwise.

The default value is: 0.

CSS Class

Specifies a CSS Class that applies to the object, useful to customize its appearance. Custom CSS Classes are specified within the custom.css file.

Margin

Specifies the margin of the object. The margin is the space outside the object's border.

Attribute Values

Value	Description	Example
<int>	Specify the margin in pixels for all sides of the object.
<top> <right> <bottom> <left>	Specify the margin in pixels for each side of the object.	10 20 30 40

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

View Scale

Specifies the scale of the object. The scale is the ratio between the object's size and the size of the view it is contained in.

Attribute Values

Value	Description
<float>	Specify the scale for both width and height of the object.

The default value is: 1.0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Meta

Comment

Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Exclude

Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.

Attribute Values

Value	Description
false	Default value. Object is included in the UI.
true	Object is excluded from the UI.

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.