ListBox

Description

The ListBox component is a list.

Comments

The component is implemented by the ListBox class.

Example

The component looks as follows:

Elements of the list are instances of ListItem and IconListItem components. The list may contain icons as it is shown on the picture above. Icons are contained in the file the address of which is specified in parameters of the ImageList non-visual component.

Example of creating the ListBox component.

The list may be located vertically or horizontally. The horizontal list looks as follows:

Elements of this horizontal list are icons implemented by the IconListItem class.

Example of creating the horizontal list.

Elements from one list may be transferred to another list with the help of the Drag&Drop mechanism.

Example of creating the ListBox component with the Drag&Drop mechanism.

Constructor

	Constructor name	Brief description
	ListBox	The ListBox constructor creates an instance of the ListBox.

Properties

	Property name	Brief description
	EmptySelection	The EmptySelection property determines whether an empty set of elements can be selected.
	EnableEdit	The EnableEdit property determines whether list elements can be edited.
	EnableKeyboard	The EnableKeyboard property determines whether the user can select list elements using Up and Down keys.
	ImageList	The ImageList property determines a set of icons for the ListBox component.
	IsScrollToSelected	The IsScrollToSelected property determines whether the list is scrolled up to the selected element.
	Items	The Items property contains an array of list elements.
	MultiSelect	The MultiSelect property determines whether multiple selection is available for list elements.
	Orientation	The Orientation property determines orientation of the ListBox component.
	SelectedIndex	The SelectedIndex property determines index of the selected list line.
	SelectedItem	The SelectedItem property determines the selected list element.
	SelectOnMouseDown	The SelectOnMouseDown property determines whether elements are selected on the mouse click.

Methods

	Method name	Brief description
	addItem	The addItem method adds a new element to list.
	beginUpdate	The beginUpdate method determines whether the list is updated.
	clear	The clear method removes all elements from the list.
	clearSelection	The clearSelection method is used to reset selection.
	endUpdate	The endUpdate method removes whether the list is updated.
	filterByText	The filterByText method filters list elements by string.
	getActiveItem	The getActiveItem method returns the selected list element.
	getItemByPoint	The getItemByPoint method returns list element by the specified coordinates.
	getLastItemClick	The getLastItemClick method returns the last selected list element.
	getLayoutItems	The getLayoutItems method returns an array of list elements.
	getScrollBox	The getScrollBox method returns scrolling region of elements list.
	getSelectedItems	The getSelectedItems method returns array of selected list elements.
	insertItem	The insertItem method adds an element to the position of the elements list set by the index parameter.
	removeItem	The removeItem method removes the element of the list by the specified index.
	scrollToItem	The scrollToItem method scrolls the list up to the item element.
	scrollToSelected	The scrollToSelected method scrolls the list up to the selected list element.
	selectItemById	The selectItemById method selects the element with the specified Id identifier.
	setSelectedFocus	The setSelectedFocus method sets focus on the element index.

Events

	Event name	Brief description
	ItemClick	The ItemClick event occurs when a list element is left-clicked.
	ItemDeselected	The ItemDeselected event occurs on removing selection from list element.
	ItemEdited	The ItemEdited event occurs after completing editing of list element.
	ItemEditing	The ItemEditing event occurs on starting editing of list element.
	ItemMouseDown	The ItemMouseDown event occurs on pressing and holding down the mouse button on the element.
	ItemSelected	The ItemSelected event occurs on selecting a list element.
	SelectableSelected	The SelectableSelected event occurs on any click on the list iteelement.

Properties inherited from the class Control

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the left mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.

Properties inherited from the class Object

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

DHTML Components