ListBox

Описание

Компонент ListBox представляет собой список.

Комментарии

Компонент реализован классом ListBox.

Пример

Компонент имеет следующий вид:

Элементами списка являются экземпляры компонентов ListItem и IconListItem. Список может содержать пиктограммы, как показано на рисунке выше. Пиктограммы содержатся в файле, адрес которого установлен в параметрах невизуального компонента ImageList.

Пример создания компонента ListBox.

Список может быть расположен вертикально и горизонтально. Горизонтальный список выглядит следующим образом:

Элементами данного горизонтального списка являются пиктограммы, реализованные классом IconListItem.

Пример создания горизонтального списка.

Элементы из одного списка можно переносить в другой список при помощи механизма Drag&Drop.

Пример создания компонента ListBox с механизмом Drag&Drop.

Конструктор

	Имя конструктора	Краткое описание
	ListBox	Конструктор ListBox создает экземпляр компонента ListBox.

Свойства

	Имя свойства	Краткое описание
	EmptySelection	Свойство EmptySelection определяет возможность выбора пустого множества элементов.
	EnableEdit	Свойство EnableEdit определяет возможность редактирования элементов списка.
	EnableKeyboard	Свойство EnableKeyboard определяет возможность выделять элементы списка при помощи клавиш «Вверх/вниз».
	ImageList	Свойство ImageList определяет набор пиктограмм для компонента ListBox.
	IsScrollToSelected	Свойство IsScrollToSelected определяет признак прокручивания списка до выделенного элемента.
	Items	Свойство Items содержит массив элементов списка.
	MultiSelect	Свойство MultiSelect определяет, доступен ли множественный выбор элементов списка.
	Orientation	Свойство Orientation определяет ориентацию компонента ListBox.
	SelectedIndex	Свойство SelectedIndex определяет индекс выделенной строки списка.
	SelectedItem	Свойство SelectedItem определяет выделенный элемент списка.
	SelectOnMouseDown	Свойство SelectOnMouseDown определяет признак выделения элементов при клике мыши.

Методы

	Имя метода	Краткое описание
	addItem	Метод addItem добавляет новый элемент в список.
	beginUpdate	Метод beginUpdate устанавливает признак того, что список обновляется.
	clear	Метод clear удаляет все элементы из списка.
	clearSelection	Метод clearSelection предназначен для сброса выделения.
	endUpdate	Метод endUpdate убирает признак того, что список обновляется.
	filterByText	Метод filterByText осуществляет фильтрацию элементов списка по строке.
	getActiveItem	Метод getActiveItem возвращает выделенный элемент списка.
	getItemByPoint	Метод getItemByPoint возвращает элемент списка по заданным координатам.
	getLastItemClick	Метод getLastItemClick возвращает последний выделенный элемент списка.
	getLayoutItems	Метод getLayoutItems возвращает массив элементов списка.
	getScrollBox	Метод getScrollBox возвращает область прокрутки списка элементов.
	getSelectedItems	Метод getSelectedItems возвращает массив выделенных элементов списка.
	insertItem	Метод insertItem добавляет элемент в позицию списка элементов, заданную параметром index.
	removeItem	Метод removeItem удаляет элемент списка по указанному индексу.
	scrollToItem	Метод scrollToItem прокручивает список до элемента item.
	scrollToSelected	Метод scrollToSelected прокручивает список до выделенного элемента списка.
	selectItemById	Метод selectItemById выделяет элемент с указанным идентификатором Id.
	setSelectedFocus	Метод setSelectedFocus устанавливает фокус по индексу элемента.

События

	Имя события	Краткое описание
	ItemClick	Событие ItemClick наступает при клике левой кнопкой мыши на элемент списка.
	ItemDeselected	Событие ItemDeselected наступает при снятии отметки с элемента списка.
	ItemEdited	Событие ItemEdited наступает после завершения редактирования элемента списка.
	ItemEditing	Событие ItemEditing наступает при начале редактирования элемента списка.
	ItemMouseDown	Событие ItemMouseDown наступает при зажатии кнопки мыши на элементе.
	ItemSelected	Событие ItemSelected наступает при выделении элемента списка.
	SelectableSelected	Событие SelectableSelected наступает при любом клике на элементе списка.

Свойства, унаследованные от класса Control

	Имя свойства	Краткое описание
	Anchors	Свойство Anchors определяет позицию компонента, размещенного внутри контейнера.
	Animation	Свойство Animation устанавливает параметры анимации для компонента.
	Bottom	Свойство Bottom устанавливает отступ снизу при размещении компонента внутри LayoutPanel.
	Content	Свойство Content устанавливает содержимое компонента.
	ContextMenu	Свойство ContextMenu устанавливает контекстное меню для компонента.
	Data	Свойство Data предназначено для хранения любых пользовательских данных.
	DataContext	Свойство DataContext содержит объект с данными.
	Enabled	Свойство Enabled устанавливает, является ли компонент доступным для использования.
	Height	Свойство Height устанавливает высоту компонента.
	IsResizable	Свойство IsResizable определяет, можно ли изменять размеры компонента.
	IsRTL	Свойство IsRTL устанавливает направление текста справа налево.
	IsVisible	Свойство IsVisible определяет, отображается ли компонент.
	Left	Свойство Left устанавливает отступ слева при размещении компонента внутри GridPanel.
	Offset	Свойство Offset определяет координаты корневой DOM-вершины элемента управления.
	Opacity	Свойство Opacity определяет прозрачность компонента.
	Parent	Свойство Parent определяет родительский компонент элемента управления.
	ParentNode	Свойство ParentNode устанавливает родительскую DOM-вершину.
	ResourceKey	Свойство ResourceKey устанавливает ресурсный ключ для компонента.
	Right	Свойство Right устанавливает отступ справа при размещении компонента внутри LayoutPanel.
	Rotate	Свойство Rotate устанавливает угол поворота компонента.
	ShowToolTip	Свойство ShowToolTip определяет, включена ли возможность отображать всплывающую подсказку компонента.
	Style	Свойство Style устанавливает стиль для компонента.
	TabIndex	Свойство TabIndex задает последовательность перехода элемента управления внутри контейнера.
	Tag	Свойство Tag устанавливает JSON-объект, ассоциированный с компонентом.
	ToolTip	Свойство ToolTip определяет текст всплывающей подсказки компонента.
	Top	Свойство Top устанавливает отступ сверху при размещении компонента внутри GridPanel.
	Value	Свойство Value задает значение компоненту.
	Width	Свойство Width устанавливает ширину компонента.

Методы, унаследованные от класса Control

	Имя метода	Краткое описание
	addClass	Метод addClass добавляет CSS-класс к компоненту.
	addEvent	Метод addEvent добавляет обработчик события на DOM-вершину.
	addEventHandler	Метод addEventHandler добавляет обработчик события на DOM-вершину.
	addEvents	Метод addEvents добавляет массив обработчиков событий на DOM-вершину.
	addStateClass	Метод addStateClass добавляет CSS-класс к компоненту и удаляет прежний CSS-класс.
	addStyleBySelector	Метод addStyleBySelector создает блок со стилем с указанным css-селектором.
	addToNode	Метод addToNode добавляет компонент в указанную вершину.
	bindEvents	Метод bindEvents подписывает элемент на все стандартные события.
	clearStylesCache	Метод clearStylesCache очищает кэш стилей компонента.
	getAnchorFlags	Метод getAnchorFlags возвращает JSON-объект с настройками текущей позиции компонента.
	getClass	Метод getClass возвращает текущие css-классы компонента.
	getCssStyle	Метод getCssStyle возвращает стили для указанной вершины.
	getDomNode	Метод getDomNode возвращает главную DOM-вершину компонента.
	getFocused	Метод getFocused определяет наличие фокуса у компонента.
	getFunctionByName	Метод getFunctionByName возвращает функцию по имени.
	getIsBinded	Метод getIsBinded возвращает признак подписи элемента на события DOM-вершины.
	hasClass	Метод hasClass определяет, задан ли для корневой DOM-вершины элемента управления указанный CSS-класс.
	hide	Метод hide скрывает элемент управления.
	hideToolTip	Метод hideToolTip очищает таймаут появления подсказки и скрывает ее, если она был показана.
	isResingNow	Метод isResingNow определяет, изменяются ли в данный момент размеры компонента.
	refreshBindingProperty	Метод refreshBindingProperty обновляет привязанное свойство по имени.
	refreshItemsStyle	Метод refreshItemsStyle обновляет CSS-стили дочерних элементов.
	refreshStyle	Метод refreshStyle обновляет CSS-стили элемента.
	removeClass	Метод removeClass удаляет CSS-класс из компонента.
	removeEvent	Метод removeEvent удаляет обработчик события у DOM-вершины.
	removeEventHandler	Метод removeEventHandler удаляет обработчик события DOM-вершины.
	removeFromDOM	Метод removeFromDOM удаляет вершину из DOM-структуры.
	removeStateClasses	Метод removeStateClasses удаляет CSS-классы компонента.
	setDraggable	Метод setDraggable устанавливает возможность перетаскивания компонента на html-странице.
	setFocus	Метод setFocus устанавливает фокус компонента.
	setIsHovered	Метод setIsHovered отображает компонент как при наведении на него курсора.
	setIsPressed	Метод setIsPressed отображает компонент как при клике по нему.
	setOpacityIE8	Метод setOpacityIE8 устанавливает значение прозрачности компонента в браузере InternetExplorer 8.
	setSize	Метод setSize устанавливает размеры компонента.
	show	Метод show отображает элемент управления.
	unBindEvents	Метод unBindEvents отписывает элемент от всех стандартных событий.
	updatePosition	Метод updatePosition корректирует размер и положение при абсолютном позиционировании на основе текущих параметров.
	updateSize	Метод updateSize обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

События, унаследованные от класса Control

	Имя события	Краткое описание
	Drag	Событие Drag наступает при нажатии и удерживании клавиши мыши.
	DragEnd	Событие DragEnd наступает при окончании перетаскивания компонента.
	DragStart	Событие DragStart наступает, когда начинается перетаскивание компонента.
	OnContextMenu	Событие OnContextMenu наступает при вызове контекстного меню компонента.
	SizeChanged	Событие SizeChanged наступает после изменения размеров компонента.
	SizeChanging	Событие SizeChanging наступает во время изменения размеров компонента.

Свойства, унаследованные от класса Object

	Имя свойства	Краткое описание
	Data	Свойство Data ассоциирует произвольный объект с данным компонентом.
	Id	Свойство Id устанавливает идентификатор компонента.
	Settings	Свойство Settings задает параметры компонента.

Методы, унаследованные от класса Object

	Имя метода	Краткое описание
	clone	Метод clone создает копию объекта. Не реализован в PP.Ui.Control.
	dispose	Метод dispose уничтожает компонент.
	getTypeName	Метод getTypeName возвращает имя типа объекта без пространства имён, к которому он принадлежит.

См. также:

DHTML-компоненты