TreeListBox: компонент

Компонент TreeListBox служит для отображения дерева наследования объектов с постраничной навигацией.

Комментарии

Компонент реализован классом TreeListBox. Вершины реализованы в качестве массива объектов свойства TreeListBase.DataObject, работа с вершинами происходит через свойства типа: TreeListBase.NodeVisible. Коллекция заголовков реализована классом ListCaptions, состоящим из нескольких ListCaptions. Также содержит полосы прокрутки PP.Ui.ScrollBar.

Пример

Конструктор

Свойства

Методы

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

	Имя свойства	Краткое описание
	AutoScrollDelay	Свойство AutoScrollDelay определяет задержку между изменениями положения автопрокрутки.
	Captions	Свойство Captions определяет заголовки дерева.
	ContentVerticalAlign	Свойство ContentVerticalAlign определяет вертикальное выравнивание заголовков.
	DblClickExpand	Свойство DblClickExpand определяет режим раскрытия/закрытия вершин по двойному нажатию мыши.
	DragAndDropDelay	Свойство DragAndDropDelay определяет задержку перед началом включения режима перетаскивания.
	DragAndDropIndent	Свойство DragAndDropIndent определяет отступ разделительной линии, при использовании режима перетаскивания.
	DragAndDropMode	Свойство DragAndDropMode определяет режим перетаскивания.
	EnableAutoColumnSize	Свойство EnableAutoColumnSize определяет режим автоподгонки ширины колонок.
	EnableAutoScroll	Свойство EnableAutoScroll определяет режим автоматической прокрутки.
	EnableColumnsMenu	Свойство EnableColumnsMenu определяет видимость меню выбора столбцов.
	EnableDragAndDrop	Свойство EnableDragAndDrop определяет активность режима перетаскивания.
	EnableDragOutside	Свойство EnableDragOutside определяет возможность перетаскивания в другие деревья.
	EnableDropOutside	Свойство EnableDropOutside определяет возможность перетаскивания из других деревьев.
	EnableEdit	Свойство EnableEdit определяет режим редактирования ячеек.
	EnableKeyNavigation	Свойство EnableKeyNavigation определяет возможность использования клавиатуры для навигации в дереве.
	EnableRangeSelect	Свойство EnableRangeSelect определяет возможность отметки вершин диапазоном.
	EnableResizeColumns	Свойство EnableResizeColumns определяет возможность изменять ширину столбцов.
	EnableSearch	Свойство EnableSearch определяет возможность поиска в дереве.
	EnableSort	Свойство EnableSort определяет возможность сортировки.
	IconVerticalAlign	Свойство IconVerticalAlign определяет вертикальное выравнивание пиктограмм.
	ImageList	Свойство ImageList определяет изображение с пиктограммами для вершин.
	NodeDefaultStyle	Свойство NodeDefaultStyle определяет стиль вершин по умолчанию.
	PageStyle	Свойство PageStyle определяет стиль контейнера с вершинами.
	RightButtonSelect	Свойство RightButtonSelect определяет возможность выделения вершин правой кнопкой мыши.
	RowSelect	Свойство RowSelect определяет режим сплошной отметки строки.
	ScrollStep	Свойство ScrollStep определяет шаг прокрутки колесом мыши и автопрокруткой.
	ShowCaptions	Свойство ShowCaptions определяет признак отображения заголовков столбцов.
	ShowCheckBoxes	Свойство ShowCheckBoxes определяет признак отображения флажков.
	ShowGridLines	Свойство ShowGridLines определяет признак отображения линий сетки.
	ShowToolTips	Свойство ShowToolTips определяет признак отображения всплывающих подсказок.
	ShowTree	Свойство ShowTree определяет режим отображения структуры дерева в первом столбце.
	ShowTreeLines	Свойство ShowTreeLines определяет отображение линий структуры дерева.
	ScrollBarH	Свойство ScrollBarH определяет горизонтальную полосу прокрутки.
	ScrollBarV	Свойство ScrollBarV определяет вертикальную полосу прокрутки.

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

	Имя метода	Краткое описание
	clearHighlightedText	Метод clearHighlightedText убирает подсвечивание текста.
	areAllVisibleNodesLoaded	Метод areAllVisibleNodesLoaded определяет, загружены ли все видимые вершины.
	cancelEditing	Метод cancelEditing отменяет текущее редактирование.
	endDropFromOutside	Метод endDropFromOutside инициирует событие переноса вершины из внешнего дерева с указанными аргументами.
	getVisibleNodes	Метод getVisibleNodes возвращает ключи всех видимых вершин.
	highlightText	Метод highlightText подсвечивает указанные строки в элементах дерева.
	measureColumnContentWidth	Метод measureColumnContentWidth возвращает содержимое столбца.
	moveDrag	Метод moveDrag перемещает перетаскиваемую вершину в текущее положение курсора.
	removeHover	Метод removeHover убирает текущую подсветку от наведения.
	scrollToNode	Метод scrollToNode прокручивает дерево до вершины по ключу.
	scrollToPosition	Метод scrollToPosition прокручивает дерево до вершины по порядковому номеру.
	setHoveredNode	Метод setHoveredNode устанавливает подсветку от наведения мыши указанной вершине.
	startEditing	Метод startEditing включает режим редактирования содержимого вершины.
	stopEditing	Метод stopEditing заканчивает редактирование вершины.

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

	Имя события	Краткое описание
	CheckBoxClick	Событие CheckBoxClick наступает перед нажатием на флажок.
	NodeCellMouseOut	Событие NodeCellMouseOut наступает при уводе мыши с ячейки вершины.
	NodeCellMouseOver	Событие NodeCellMouseOver наступает при наведении мышью на ячейку вершины.
	NodeClick	Событие NodeClick наступает при щелчке мышью по вершине.
	NodeDblClick	Событие NodeDblClick наступает при двойном щелчке мышью по вершине.
	NodeDrag	Событие NodeDrag наступает при перемещении перетаскиваемой вершины по элементам дерева.
	NodeDragEnd	Событие NodeDragEnd наступает перед окончанием перемещения вершины.
	NodeDragFinished	Событие NodeDragFinished наступает после окончания перемещения вершины.
	NodeDragStart	Событие NodeDragStart наступает перед началом перемещения вершины.
	NodeEditCanceled	Событие NodeEditCanceled наступает при отмене редактирования ячейки.
	NodeEdited	Событие NodeEdited наступает после окончания редактирования ячейки.
	NodeEditing	Событие NodeEditing наступает перед редактированием ячейки.
	NodeMouseDown	Событие NodeMouseDown наступает при нажатии кнопки мыши на вершине.
	NodeMouseOut	Событие NodeMouseOut наступает при уходе курсора мыши с вершины.
	NodeMouseOver	Событие NodeMouseOver наступает при заходе курсора мыши на вершину.
	NodeMouseUp	Событие NodeMouseUp наступает при отпускании кнопки мыши на вершине.
	ToolTipShowing	Событие ToolTipShowing наступает при отображении всплывающей подсказки.
	VisibleNodesChange	Событие VisibleNodesChange наступает перед отображением новых вершин.
	VisibleNodesChanged	Событие VisibleNodesChanged наступает после отображения новых вершин.

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

	Имя свойства	Краткое описание
	AllowEmptySelection	Свойство AllowEmptySelection определяет возможность нулевой отметки.
	DataMappers	Свойство DataMappers определяет параметры сопоставления данных.
	DataObject	Свойство DataObject определяет источник данных дерева.
	ExpansionMode	Свойство ExpansionMode определяет режим раскрывания вершин.
	FocusedNode	Свойство FocusedNode определяет идентификатор находящейся в фокусе вершины.
	FilterColumn	Свойство FilterColumn определяет индекс столбца для проверки фильтра.
	FilterString	Свойство FilterString определяет текст фильтра.
	NodeChecked	Свойство NodeChecked определяет признак отметки флажка указанной вершины.
	NodeChildrenCount	Свойство NodeChildrenCount определяет количество наследников указанной вершины.
	NodeChildrenSelected	Свойство NodeChildrenSelected определяет количество выделенных наследников указанной вершины.
	NodeClass	Свойство NodeClass определяет CSS класс указанной вершины.
	NodeContent	Свойство NodeContent определяет содержимое вершины.
	NodeControls	Свойство NodeControls определяет элементы управления вершины.
	NodeData	Свойство NodeData определяет пользовательские данные указанной вершины.
	NodeEditable	Свойство NodeEditable определяет возможность редактирования указанной вершины.
	NodeExpanded	Свойство NodeExpanded определяет признак раскрытия указанной вершины.
	NodeFixedExpanded	Свойство NodeFixedExpanded определяет возможность раскрытия/закрытия указанной вершины.
	NodeFixedFocused	Свойство NodeFixedFocused определяет возможность фокусирования указанной вершины.
	NodeFixedSelected	Свойство NodeFixedSelected определяет возможность выделения указанной вершины.
	NodeFocused	Свойство NodeFocused определяет признак выбора в фокус указанной вершины.
	NodeImageIndex	Свойство NodeImageIndex определяет индекс пиктограммы указанной вершины.
	NodeIndex	Свойство NodeIndex определяет порядковый номер указанной вершины на текущем уровне.
	NodeParent	Свойство NodeParent определяет ключ родителя указанной вершины.
	NodeSelected	Свойство NodeSelected определяет признак выделения указанной вершины.
	NodeStyle	Свойство NodeStyle определяет стиль указанной вершины.
	NodeVisible	Свойство NodeVisible определяет признак видимости указанной вершины.
	RequestTimeout	Свойство RequestTimeout определяет задержку перед перерисовыванием дерева.
	SelectionMode	Свойство SelectionMode определяет режим выделения.
	SortColumn	Свойство SortColumn определяет столбец сортировки.
	SortDirection	Свойство SortDirection определяет направление сортировки.
	SortMethod	Свойство SortMethod определяет метод сортировки.

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

	Имя метода	Краткое описание
	beginUpdate	Метод beginUpdate устанавливает флаг блокировки обновления.
	checkExpansion	Метод checkExpansion проверяет корректность признака раскрытия вершин.
	checkSelection	Метод checkSelection проверяет корректность признака выделения вершин.
	clearNodes	Метод clearNodes удаляет все вершины дерева.
	deleteNode	Метод deleteNode удаляет указанную вершину из дерева.
	endUpdate	Метод beginUpdate снимает флаг блокировки обновления.
	find	Метод find возвращает ключ вершины, содержащей искомую строку в соответствующем столбце.
	findText	Метод findText ищет полное совпадение значения в первом столбце.
	focusNode	Метод focusNode устанавливает фокус на указанную вершину.
	getAllCheckedNodes	Метод getAllCheckedNodes возвращает массив вершин, в зависимости от статуса флажка.
	getAllExpandedNodes	Метод getAllExpandedNodes возвращает массив вершин, в зависимости от статуса экспандера.
	getAllNodes	Метод getAllNodes возвращает все вершины.
	getAllNodesCount	Метод getAllNodesCount возвращает количество вершин.
	getLastExpandedNode	Метод getLastExpandedNode возвращает ключ последней раскрытой вершины.
	getLastSelectedNode	Метод getLastSelectedNode возвращает ключ последней выделенной вершины.
	getNodeByPosition	Метод getNodeByPosition возвращает ключ вершины по её порядковому номеру.
	getNodeChildren	Метод getNodeChildren возвращает массив ключей потомков указанной вершины.
	getNodeChildrenVisible	Метод getNodeChildrenVisible возвращает признак видимости потомков указанной вершины.
	getNodeExist	Метод getNodeExist возвращает признак существования указанной вершины.
	getNodeIsFirst	Метод getNodeIsFirst возвращает признак того, что указанная вершина первая в списке.
	getNodeLevel	Метод getNodeLevel возвращает уровень указанной вершины.
	getNodePosition	Метод getNodePosition возвращает порядковый номер указанной вершины.
	getNodes	Метод getNodes возвращает массив предназначенных для отрисовки вершин.
	getNodesCount	Метод getNodesCount возвращает количество предназначенных для отрисовки вершин.
	getRequestItemByIndex	Метод getRequestItemByIndex возвращает индекс вершины и её родителя по порядковому номеру.
	getRequestParentByIndex	Метод getRequestParentByIndex возвращает индекс родителя по порядковому номеру вершины.
	getSelectedNodes	Метод getSelectedNodes возвращает выделенные вершины.
	isFilterActive	Метод isFilterActive возвращает признак использования фильтра.
	isHierarchicalDataObject	Метод isHierarchicalDataObject возвращает признак использования сопоставления данных «Children».
	isNodeExist	Метод isNodeExist возвращает признак существования указанной вершины.
	isPartialRequestPossible	Метод isPartialRequestPossible определяет возможность частичной загрузки ветвей.
	isSortActive	Метод isSortActive возвращает признак активности сортировки.
	isUpdating	Метод isUpdateing возвращает признак режима обновления.
	loadNodes	Метод loadNodes загружает вершины из объекта.
	moveNode	Метод moveNode перемещает указанную вершину.
	preserveSelection	Метод preserveSelection запоминает текущее выделение для метода setSelectedFromToIndex.
	refresh	Метод refresh обновляет дерево.
	removeFocus	Метод removeFocus убирает текущую фокусировку.
	requestData	Метод requestData запрашивает динамическую подгрузку дерева.
	setCheckedForAll	Метод setCheckedForAll устанавливает значение всем флажкам дерева.
	setCheckedForNodeAncestors	Метод setCheckedForNodeAncestors устанавливает значение флажкам каждого предка указанной вершины.
	setCheckedForNodes	Метод setCheckedForNodes устанавливает значение флажкам указанных вершин.
	setExpandedForAll	Метод setExpandedForAll устанавливает значения экспандеров всем вершинам.
	setExpandedForNodeAncestors	Метод setExpandedForNodeAncestors устанавливает значения экспандеров каждому предку указанной вершины.
	setExpandedForNodes	Метод setExpandedForNodes устанавливает значения экспандеров массиву вершин.
	setFilter	Метод setFilter устанавливает фильтр для дерева.
	setSelectedForAll	Метод setSelectedForAll устанавливает выделение всем вершинам.
	setSelectedForChildren	Метод setSelectedForChildren устанавливает выделение всем потомкам указанной вершины.
	setSelectedForLevel	Метод setSelectedForLevel устанавливает выделение всем вершинам указанного уровня.
	setSelectedForNodes	Метод setSelectedForNodes устанавливает выделение указанному массиву вершин.
	setSelectedFromToIndex	Метод setSelectedFromToIndex изменяет текущее выделение для диапазона вершин.
	setSort	Метод setSort устанавливает сортировку элементов дерева.
	updateDataObject	Метод updateDataObject создает пустой объект с данными при его отсутствии.
	updateIndexes	Метод updateIndexes обновляет видимые вершины.
	updateMappers	Метод updateMappers обновляет объекты сопоставления данных.
	updateNode	Метод updateNode обновляет указанную вершину.
	updateNodeStyle	Метод updateNodeStyle обновляет стили указанной вершины.
	updateTree	Метод updateTree перестраивает дерево.

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

	Имя события	Краткое описание
	CheckedChanged	Событие CheckedChanged наступает после смены состояния флажка.
	CheckedChanging	Событие CheckedChanging наступает перед сменой состояния флажка.
	DataRequest	Событие DataRequest наступает перед изменением сортировки.
	ExpansionChanged	Событие ExpansionChanged наступает после изменения значения экспандера.
	ExpansionChanging	Событие ExpansionChanging наступает перед изменением значения экспандера.
	FilterChanged	Событие FilterChanged наступает после изменения фильтра.
	FilterChanging	Событие FilterChanging наступает перед изменением фильтра.
	Finding	Событие Finding наступает перед применением поиска.
	Found	Событие Found наступает после применения поиска.
	FocusChanged	Событие FocusChanged наступает после изменения фокуса.
	FocusChanging	Событие FocusChanging наступает перед изменением фокуса.
	SelectionChanged	Событие SelectionChanged наступает после изменения выделения.
	SelectionChanging	Событие SelectionChanging наступает перед изменением выделения.
	SortChanged	Событие SortChanged наступает после изменения сортировки.
	SortChanging	Событие SortChanging наступает перед изменением сортировки.

Свойства, унаследованные от класса 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 обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

	Имя свойства	Краткое описание
	ActiveNode	Свойство ActiveNode определяет ключ раскрытой вершины.
	AnimationDuration	Свойство AnimationDuration определяет скорость анимации перелистывания.

	Имя метода	Краткое описание
	drillTo	Метод drillTo совершает переход к указанной вершине.
	getFullTreeHeight	Метод getFullTreeHeight возвращает полную высоту дерева с учетом рамки и отступов.

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

	Имя метода	Краткое описание
	clone	Метод clone создает копию объекта.
	dispose	Метод dispose уничтожает компонент.
	getHashCode	Метод getHashCode возвращает хэш-код объекта репозитория.
	getSettings	Метод getSettings возвращает настройки объекта репозитория.
	getTypeName	Метод getTypeName возвращает имя типа объекта без пространства имен, к которому он принадлежит.
	isEqual	Метод isEqual определяет, равен ли заданный объект текущему объекту репозитория.
	isLive	Метод isLive определяет действительность объекта репозитория.
	removeAllEvents	Метод removeAllEvents удаляет все обработчики событий объекта по заданному контексту.
	setSettings	Метод setSettings задает настройки объекта репозитория.
	defineProps	Метод defineProps создает методы get и set из массива имен для указанного класса.
	keys	Метод keys возвращает массив названий методов и свойств для указанного объекта.

TreeListBox

Описание