List

Inherits from UIView

Used by: ComboBox DataGrid TabPanel

Description

The list view presents a selectable list of items. It can either contain a static list of ListItem views or one ListItem with IsTemplate="True". If bound to list data through the Items field the list uses the template to generate a dynamic list of ListItems.

View Fields

Name	Type	Description
AddMaskMargin	List	Indicates if mask margin should be added.
Boolean indicating if margin should be added to the content mask to make room for the scrollbars.
Alignment	ElementAlignment	View alignment.
Used to align the view relative to the layout parent region it resides in. Enum Values Name Description Center Element centered horizontally and vertically. Left Element aligned to the left horizontally and centered vertically. Top Element aligned to the top vertically and centered horizontally. Right Element aligned to the right horizontally and centered vertically. Bottom Element aligned to the bottom vertically and centered horizontally. TopLeft Element aligned to the top vertically and to the left horizontally. TopRight Element aligned to the top vertically and to the right horizontally. BottomLeft Element aligned to the bottom vertically and to the left horizontally. BottomRight Alement aligned to the bottom vertically and to the right horizontally.
Alpha	float	Alpha value.
Can be used to adjust the alpha color of this view and all its children. E.g. used for fade in/out animations. Is separate from and different from the background color of the view as it affects the children as well.
AlternateItems	bool	Indicates if the items should alternate in style.
Boolean indicating if the ListItem style should alternate between "Default" and "Alternate".
BackgroundColor	Color	Background color of the view.
Background color of the view.
BackgroundImage	SpriteAsset	Background image sprite.
The sprite that will be rendered.
BackgroundImageEventAlphaThreshold	float	Alpha threshold for letting through events.
The alpha threshold specifying the minimum alpha a pixel must have for the event to be passed through.
BackgroundImageFillAmount	float	Background image fill amount.
Amount of the Image shown when the Image.type is set to Image.Type.Filled.
BackgroundImageFillCenter	bool	Indicates if center should be filled.
Boolean indicating whether or not to render the center of a Tiled or Sliced image.
BackgroundImageFillClockwise	bool	Indicates if the image should be filled clockwise.
Whether the Image should be filled clockwise (true) or counter-clockwise (false).
BackgroundImageFillMethod	FillMethod	Background image fill method.
Indicates what type of fill method should be used. Enum Values Name Description Horizontal Vertical Radial90 Radial180 Radial360
BackgroundImageFillOrigin	int	Background image fill origin.
Controls the origin point of the Fill process. Value means different things with each fill method.
BackgroundImageMaskable	bool	Indicates if the image is maskable.
Indicates if the background image graphic is to be maskable.
BackgroundImageOverrideSprite	SpriteAsset	Background image override sprite.
Set an override sprite to be used for rendering. If set the override sprite is used instead of the regular image sprite.
BackgroundImagePreserveAspect	bool	Preserve aspect ratio.
Indicates whether this image should preserve its Sprite aspect ratio.
BackgroundImageType	Type	Type of background image.
The type of the image sprite that is to be rendered. Enum Values Name Description Simple Sliced Tiled Filled
BackgroundMaterial	Material	Background image material.
Background image material.
BaseDirectory	string	Base directory.
Specifies the base directory to be used by the view and its children. The base directory is used when loading resources such as sprites, fonts, etc.
BasedOn	string	Based on style.
Used in style definition to specify which style it's based on.
CanDeselect	bool	Indicates if items can be deselected by clicking.
A boolean indicating if items in the list can be deselected by clicking. Items can always be deselected programmatically.
CanMultiSelect	bool	Indicates if more than one list item can be selected.
A boolean indicating if more than one list items can be selected by clicking or programmatically.
CanReselect	bool	Indicates if item can be selected again if it's already selected.
Boolean indicating if the item can be selected again if it is already selected. This setting is ignored if CanDeselect is True.
CanScrollHorizontally	List	Indicates if the content can scroll horizontally.
Boolean indicating if the content can be scrolled horizontally.
CanScrollVertically	List	Indicates if the content can scroll vertically.
Boolean indicating if the content can be scrolled vertically.
CanSelect	bool	Indicates if items can be selected by clicking.
A boolean indicating if items can be selected by clicking. Items can always be selected programmatically.
ContentAlignment	ElementAlignment	The alignment of list items.
If the list items varies in size the content alignment specifies how the list items should be arranged in relation to each other. Enum Values Name Description Center Element centered horizontally and vertically. Left Element aligned to the left horizontally and centered vertically. Top Element aligned to the top vertically and centered horizontally. Right Element aligned to the right horizontally and centered vertically. Bottom Element aligned to the bottom vertically and centered horizontally. TopLeft Element aligned to the top vertically and to the left horizontally. TopRight Element aligned to the top vertically and to the right horizontally. BottomLeft Element aligned to the bottom vertically and to the left horizontally. BottomRight Alement aligned to the bottom vertically and to the right horizontally.
ContentMargin	List	Content margin of the list.
Sets the margin of the list mask view that contains the contents of the list.
DecelerationRate	List	Scroll deceleration rate.
Value indicating the rate of which the scroll stops moving.
DeselectAfterSelect	bool	Indicates if items are deselected immediately after being selected.
A boolean indicating if items are deselected immediately after being selected. Useful if you want to trigger selection action but don't want the item to remain selected.
DisableInteractionScrollDelta	List	Scroll delta distance for disabling interaction.
If set any interaction with child views (clicks, etc) is disabled when the specified distance has been scrolled. This is used e.g. to disable clicks while scrolling a selectable list of items.
DisableItemArrangement	bool	Boolean indicating if list item arrangement should be disabled.
If set to true the list doesn't automatically arrange one item after another. Used when item arrangement is done elsewhere.
Elasticity	List	Scroll elasticity.
Value indicating how elastic the scrolling is when moved beyond the bounds of the scrollable content.
HasInertia	List	Indicates if scroll has intertia.
Boolean indicating if the scroll has inertia.
Height	ElementSize	The height of the view.
Specifies the height of the view either in pixels or percents.
HideFlags	HideFlags	Hide flags for the game object.
Bit mask that controls object destruction, saving and visibility in editor. Enum Values Name Description None HideInHierarchy HideInInspector DontSaveInEditor NotEditable DontSaveInBuild DontUnloadUnusedAsset DontSave HideAndDontSave
HorizontalNormalizedPosition	List	Horizontal normalized position.
Value between 0-1 indicating the position of the scrollable content.
HorizontalScrollbarBreadth	List	Breadth of the horizontal scrollbar.
Breadth of the horizontal scrollbar.
HorizontalScrollbarColor	List	Horizontal scrollbar image color.
Horizontal scrollbar image color.
HorizontalScrollbarHandleColor	List	Horizontal scrollbar handle image color.
Horizontal scrollbar handle image color.
HorizontalScrollbarHandleImage	List	Horizontal scrollbar handle image.
Horizontal scrollbar handle image sprite.
HorizontalScrollbarHandleImageType	List	Horizontal scrollbar handle image type.
Horizontal scrollbar handle image sprite type.
HorizontalScrollbarHandleMaterial	List	Horizontal scrollbar handle image material.
Horizontal scrollbar handle image material.
HorizontalScrollbarHandleSize	List	Handle size.
The size of the horizontal scrollbar handle where 1 means it fills the entire horizontal scrollbar.
HorizontalScrollbarImage	List	Horizontal scrollbar image.
Horizontal scrollbar image sprite.
HorizontalScrollbarImageType	List	Horizontal scrollbar image type.
Horizontal scrollbar image sprite type.
HorizontalScrollbarMaterial	List	Horizontal scrollbar image material.
Horizontal scrollbar image material.
HorizontalScrollbarNumberOfSteps	List	Scroll steps.
The number of steps to use for the value. A value of 0 disables use of steps.
HorizontalScrollbarOrientation	List	Orientation of the horizontal scrollbar.
Orientation of the horizontal scrollbar.
HorizontalScrollbarScrollDirection	List	Scrollbar scroll direction.
Scrollbar scroll direction.
HorizontalScrollbarSpacing	List	Space between scrollbar and scrollable content.
Space between scrollbar and scrollable content.
HorizontalScrollbarValue	List	Scrollbar value.
The current value of the horizontal scrollbar, between 0 and 1.
HorizontalScrollbarVisibility	List	Horizontal scrollbar visibility of scrollable list content.
Horizontal scrollbar visibility of scrollable list content.
HorizontalSpacing	ElementSize	Horizontal spacing between list items.
The horizontal spacing between list items.
Id	string	The ID of the view.
Specifies a unique ID for the view. Used to map the view to reference fields on the parent view model. Provides a way to reference the view in data bindings. Is used as selectors in styles.
IsActive	bool	Indicates if the view is enabled.
Activates/deactivates the view. If set to false in this or in any parent view, all components are disabled, attached renderers are turned off, etc. Any components attached will no longer have Update() called.
IsDestroyed	bool	Indicates if the view has been destroyed by GameObject.Destroy().
IsDynamic	bool	Indicates if the view has been created dynamically.
IsInitialized	bool	Gets or sets bool indicating if the view has been initialized.
IsItemSelected	bool	Indicates if an item is selected.
Set to true when a list item is selected.
IsScrollable	bool	Indicates if the list is scrollable.
Boolean indicating if the list is to be scrollable.
IsTemplate	bool	Indicates if this view is to be used as a template.
A template view is used to create dynamic instances of the view. Used by certain views such as the List and TabPanel.
IsVisible	bool	Indicate if the view is visible.
Can be used to adjust the visiblity of the view. If set to false the view is made invisible but unlike when deactivating the view, invisible views are still is active and takes up space.
Item	object	Item data.
Provides a mechanism to bind to dynamic list data. The item is set, e.g. by the List view on the child views it generates for its dynamic list data. The Item points to the list item data the view is associated with.
Items	IObservableList	User-defined data list.
Can be bound to an generic ObservableList to dynamically generate ListItems based on a template.
LayoutRoot	UserInterface	Gets layout root canvas.
ListMaskAlignment	List	List mask alignment.
Specifies the alignment of the list mask.
ListMaskColor	List	List max image color.
The color of the list max image.
ListMaskHeight	List	The height of the list mask image.
Specifies the height of the list mask image either in pixels or percents.
ListMaskImage	List	List max image sprite.
The sprite that will be rendered as the list max.
ListMaskImageType	List	List max image type.
The type of the image sprite that is to be rendered as the list max.
ListMaskMaterial	List	List max image material.
The material of the list max image.
ListMaskOffset	List	The offset of the list mask image.
Specifies the offset of the list mask image.
ListMaskShowGraphic	List	Indicates if list mask should be rendered.
Indicates if the list mask, i.e. the list mask background image sprite and color should be rendered.
ListMaskWidth	List	The width of the list mask image.
Specifies the width of the list mask image either in pixels or percents.
Margin	ElementMargin	View margin
Determines the size of the content region relative the view's width and height. Adding margins to a view does not change its width or height.
MaxPoolSize	int	Max list item pool size.
Indicates maximum number of list items that should be pooled. If not set it uses initial PoolSize is used as max. Pooled items are already created and ready to be used rather than being created and destroyed on demand. Can be used to increase the performance of dynamic lists.
MovementType	List	Behavior when scrolled beyond bounds.
Enum specifying the behavior to use when the content moves beyond the scroll rect.
NormalizedPosition	List	Normalized position of the scroll.
The scroll position as a Vector2 between (0,0) and (1,1) with (0,0) being the lower left corner.
Offset	ElementMargin	View offset.
Determines the offset of the content region relative to the view's position.
OffsetFromParent	ElementMargin	View offset from parent.
Used by parent views to adjust the positioning of its children without affecting the internal offset of the children.
Orientation	ElementOrientation	Orientation of the list.
Defines how the list items should be arranged. Enum Values Name Description Vertical Vertical element orientation. Horizontal Horizontal element orientation.
Overflow	OverflowMode	Indicates how items overflow.
Enum indicating how items should overflow as they reach the boundaries of the list. Enum Values Name Description Overflow Items can exceed the boundaries. Wrap Items will wrap as they reach the boundaries.
OverrideHeight	ElementSize	Override height.
Used to override the layouting logic of inherited views and set the specified height.
OverrideWidth	ElementSize	Override width.
Used to override the layouting logic of inherited views and set the specified width.
Padding	ElementMargin	List item padding.
Adds padding to the list.
Pivot	Vector2	View pivot position.
The normalized position that the view rect transform rotates around.
PoolSize	int	List item pool size.
Indicates how many list items should be pooled. Pooled items are already created and ready to be used rather than being created and destroyed on demand. Can be used to increase the performance of dynamic lists.
Position	Vector3	Position of the view.
The local position of the view in relation to the layout parent view transform.
PropagateChildLayoutChanges	bool	Indicates if the view propagates child layout changes.
Boolean indicating if view propagates child layout changes. Generally set to true whenever a view adjusts its size to child layout changes.
RaycastBlockMode	RaycastBlockMode	Indicates when raycast should be blocked.
Enum indicating when raycasts should be blocked by the view. Enum Values Name Description Default Raycast is blocked if view is displayed and not transparent. Always Raycast is always blocked. Never Raycast is never blocked.
RealizationMargin	float	Indicates how much margin should be added to the realization viewport.
Boolean indicating how much margin should be added to the realization viewport. If zero the realization viewport will be the same size as the scrollable viewport. Used when UseVirtualization is True.
Rotation	Quaternion	Rotation of the view.
The local rotation of the view in relation to the layout parent view transform. Stored as a Quaternion but specified in XUML as euler angles.
Scale	Vector3	Scale of the view.
The scale of the view in relation to the layout parent view transform.
ScrollableContentAlignment	List	Alignment of scrollable list content.
Sets the alignment of the scrollable list content.
ScrollSensitivity	List	Scroll sensitivity.
Value indicating how sensitive the scrolling is to scroll wheel and track pad movement.
ScrollVelocity	List	Current velocity of the content.
Indicates the current velocity of the scrolled content.
SelectedItem	object	Selected data list item.
Set when the selected list item changes and points to the user-defined data item.
SelectedItems	GenericObservableList	Selected items in the data list.
Contains selected items in the user-defined list data. Can contain more than one item if IsMultiSelect is true.
SelectOnMouseUp	bool	Indicates if items are selected on mouse up.
Boolean indicating if items are selected on mouse up rather than mouse down (default).
ShowTemplateInEditor	bool	Indicates if template is to be shown in the editor.
Boolean indicating if template should be shown in the editor.
SortDirection	ElementSortDirection	Sort direction.
If list items has SortIndex set they can be sorted in the direction specified. Enum Values Name Description Ascending Ascending element sort direction. Descending Descending element sort direction.
SortIndex	int	View sort index.
The sort index is used by views such as Group and List to sort its child views.
Spacing	ElementSize	Spacing between list items.
The spacing between list items.
State	string	View state.
View state name. Determines state values to be applied to the view. All views start out in the "Default" state and when the state changes the values associated with that state are applied to the view.
Style	string	The style of the view.
Used as selector by the styles. Specifies the name of the style that is to be applied to the view and any children that explicitly inherits its style. The style is applied when the view is created (usually in the editor as the XUML is processed).
Theme	string	The theme of the view.
Specifies the name of the theme that is applied to the view and its children. The theme determines which set of styles are to be considered when applying matching styles to the view.
UnitSize	Vector3	Unit size.
Specifies the user-defined unit size to be used by the view and its children. Used when element size is specified in user-defined units to convert it into pixels.
UpdateBackground	bool	Indicates if background is updated.
If set to false the background image and color is not updated by the view. Is used when the background updates is done elsewhere.
UpdateRectTransform	bool	Indicates if rect transform is updated.
If set to false the rect transform is not updated by the layout logic. It is used when layouting is done elsewhere.
UseListMask	bool	Indicates if a list mask is to be used.
Boolean indicating if a list mask is to be used.
UseVirtualization	bool	Indicates if list should use virtualization.
Boolean indicating if list should use virtualization where only visible list items are presented in the visual hierarchy.
VerticalNormalizedPosition	List	Vertical normalized position.
Value between 0-1 indicating the position of the scrollable content.
VerticalScrollbarBreadth	List	Breadth of the vertical scrollbar.
Breadth of the vertical scrollbar.
VerticalScrollbarColor	List	Vertical scrollbar image color.
Vertical scrollbar image color.
VerticalScrollbarHandleColor	List	Vertical scrollbar handle image color.
Vertical scrollbar handle image color.
VerticalScrollbarHandleImage	List	Vertical scrollbar handle image.
Vertical scrollbar handle image sprite.
VerticalScrollbarHandleImageType	List	Vertical scrollbar handle image type.
Vertical scrollbar handle image sprite type.
VerticalScrollbarHandleMaterial	List	Vertical scrollbar handle image material.
Vertical scrollbar handle image material.
VerticalScrollbarHandleSize	List	Vertical scrollbar handle size.
The size of the vertical scrollbar handle where 1 means it fills the entire vertical scrollbar.
VerticalScrollbarImage	List	Vertical scrollbar image.
Vertical scrollbar image sprite.
VerticalScrollbarImageType	List	Vertical scrollbar image type.
Vertical scrollbar image sprite type.
VerticalScrollbarMaterial	List	Vertical scrollbar image material.
Vertical scrollbar image material.
VerticalScrollbarNumberOfSteps	List	Scroll steps.
The number of steps to use for the value. A value of 0 disables use of steps.
VerticalScrollbarOrientation	List	Orientation of the vertical scrollbar.
Orientation of the vertical scrollbar.
VerticalScrollbarScrollDirection	List	Scrollbar scroll direction.
Scrollbar scroll direction.
VerticalScrollbarSpacing	List	Space between scrollbar and scrollable content.
Space between scrollbar and scrollable content.
VerticalScrollbarValue	List	Scrollbar value.
The current value of the vertical scrollbar, between 0 and 1.
VerticalScrollbarVisibility	List	Vertical scrollbar visibility of scrollable list content.
Vertical scrollbar visibility of scrollable list content.
VerticalSpacing	ElementSize	Vertical spacing between list items.
The vertical spacing between list items.
VirtualizationUpdateThreshold	float	Indicates how many pixels should be scrolled before virtualization updates.
Boolean indicating how many pixels should be scrolled before virtualization updates.
Width	ElementSize	The width of the view.
Specifies the width of the view either in pixels or percents.

View Actions

Name	Action Data	Description
ItemSelected	ItemSelectionActionData	Item selected view action.
Triggered when a list item is selected either by user interaction or programmatically.
ItemDeselected	ItemSelectionActionData	Item deselected view action.
Triggered when a list item is deselected either by user interaction or programmatically. An item is deselected if another item is selected and CanMultiSelect is false. If CanMultiSelect is true an item is deselected when the user clicks on an selected item.
ListChanged	ListChangedActionData	List changed view action.
Triggered when the list changes (items added, removed or moved).
Cancel	none	Cancel view action.
Triggered by the EventSystem when a cancel event occurs.
Deselect	none	Deselect view action.
Triggered by the EventSystem when another view is selected.
Drop	none	Drop view action.
Triggered by the EventSystem when the view accepts a drop.
Move	none	Move view action.
Triggered by the EventSystem when a move event occurs.
Click	none	Click view action.
Triggered by the EventSystem when the user clicks/touches on the view.
BeginDrag	none	Drag view action.
Triggered by the EventSystem when the user presses mouse on and starts to drag over the view.
EndDrag	none	End drag view action.
Triggered by the EventSystem when the user stops dragging mouse over the view.
Drag	none	Drag view action.
Triggered by the EventSystem as the user drags the mouse over the view.
InitializePotentialDrag	none	Initialize potential drag view action.
Triggered by the EventSystem as the user initiates a potential drag over the view.
MouseDown	none	Mouse down view action.
Triggered by the EventSystem when the mouse/touch presses down over the view.
MouseEnter	none	Mouse enter view action.
Triggered by the EventSystem when the mouse enters the view.
MouseExit	none	Mouse exit view action.
Triggered by the EventSystem when the mouse exits the view.
MouseUp	none	Mouse up view action.
Triggered by the EventSystem when the mouse/thouch releases over the view.
Scroll	none	Scroll view action.
Triggered by the EventSystem when the user scrolls when the view is selected.
Select	none	Select view action.
Triggered by the EventSystem when the view is selected.
Submit	none	Submit view action.
Triggered by the EventSystem when the user submits while view is selected.
UpdateSelected	none	Update selected view action.
Triggered by the EventSystem when the object associated with this EventTrigger is updated.
Activated	none	Activated view action.
Triggered every time the view is activated. Also triggered once the view is intialized if it starts out activated.
Deactivated	none	Deactivated view action.
Triggered every time the view is deactivated. Also triggered once the view is intialized if it starts out deactivated.