ToolBarButton

Описание

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

Комментарии

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

Пример

В данном примере представлена панель инструментов, на которой расположены различные виды кнопок: переключатели, флажки, кнопка с раскрывающимся меню.

Кнопки добавляются на панель при помощи метода ToolBar.addItem. Принадлежность кнопки к группе флажков и переключателей определяют, соответственно, свойства IsToggle и GroupName. Раскрывающееся меню кнопки задается свойством Menu.

Кнопка может содержать пиктограмму. Установить пиктограмму для кнопки можно двумя способами:

• В свойстве ToolBar.ImageList задать набор пиктограмм и при помощи свойств RowIndex и ColumnIndex установить координаты нужной пиктограммы.

• С помощью свойства ImageUrl указать путь нужной пиктограмме.

Текст к кнопке устанавливается в свойстве Content.

Основное событие кнопки - событие смены состояния.

Пример размещения компонента ToolBarButton

Пример создания группы переключателей

Пример создания флажков

Пример создания кнопки с раскрывающимся меню

Конструктор

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

Свойства

	Имя свойства	Краткое описание
	ColumnIndex	Свойство ColumnIndex устанавливает индекс столбца, в котором размещается пиктограмма.
	GroupName	Свойство GroupName устанавливает имя для группы переключателей.
	ImageUrl	Свойство ImageUrl устанавливает путь к изображению кнопки.
	IsChecked	Свойство IsChecked устанавливает состояние кнопки.
	IsToggle	Свойство IsToggle определяет, является ли кнопка флажком.
	Menu	Свойство Menu устанавливает дочернее меню компонента.
	Parent	Свойство Parent устанавливает родительский элемент компонента - экземпляр класса ToolBar.
	RowIndex	Свойство RowIndex устанавливает индекс строки, в котором размещается пиктограмма.

Методы

	Имя метода	Краткое описание
	getColumnIndex	Метод getColumnIndex возвращает значение свойства ColumnIndex.
	getRowIndex	Метод getRowIndex возвращает значение свойства RowIndex.
	refreshCorners	Метод refreshCorners скругляет все углы кнопки панели инструментов.
	setIsHovered	Метод setIsHovered устанавливает признак того, что курсор наведен на кнопку.
	setRoundedCorners	Метод setRoundedCorners устанавливает вариант скругления углов для кнопки.

События

	Имя события	Краткое описание
	StateChanged	Событие StateChanged наступает при смене состояния кнопки.

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

	Имя свойства	Краткое описание
	ColumnIndex	Свойство ColumnIndex устанавливает индекс столбца с пиктограммой, выбранной из файла с картинками, реализованного классом ImageList.
	EnableEdit	Свойство EnableEdit определяет возможность редактирования содержимого кнопки.
	ImageList	Свойство ImageList определяет файл с картинками, откуда будет выбрана пиктограмма для кнопки.
	ImagePosition	Свойство ImagePosition определяет положение изображения кнопки.
	ImageUrl	Свойство ImageUrl определяет путь к изображению кнопки.
	IsPressed	Свойство IsPressed устанавливает признак того, что кнопка находится в нажатом состоянии.
	IsRetinaAvailable	Свойство IsRetinaAvailable определяет признак возможности работы на устройстве с дисплеем Retina.
	IsToogleButton	Свойство IsToogleButton определяет, можно ли переключать состояния кнопки (нажать/отжать).
	Menu	Свойство Menu определяет дочернее меню компонента.
	MenuArrowPosition	Свойство MenuArrowPosition устанавливает позицию стрелки дочернего меню компонента.
	MenuDropPosition	Свойство MenuDropPosition устанавливает позицию открытия дочернего меню компонента.
	RowIndex	Свойство RowIndex устанавливает индекс строки с пиктограммой, выбранной из файла с картинками, реализованного классом ImageList.
	UseWrapping	Свойство UseWrapping осуществляет перенос текста на 2 строки.

Примечание. Для свойства UseWrapping по умолчанию установлено значение true.

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

	Имя метода	Краткое описание
	hasImage	Метод hasImage возвращает признак того, содержит ли кнопка изображение.
	setIsHovered	Метод setIsHovered устанавливает признак того, что курсор наведен на кнопку.

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

Примечание. Свойство Height неактуально.

Методы, унаследованные от класса 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-компоненты