ToolBarButton

Описание

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

Комментарии

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

Пример

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

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

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

Текст к кнопке устанавливается в свойстве 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 предназначено для хранения любых пользовательских данных.
Enabled Свойство Enabled определяет признак доступности компонента для использования.
Height Свойство Height определяет высоту компонента.
IsRTL Свойство IsRTL определяет признак расположения элементов компонента по правому краю.
IsVisible Свойство IsVisible определяет признак отображения компонента.
Left Свойство Left определяет отступ слева при размещении компонента внутри GridPanel.
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-класс к компоненту.
addEventHandler Метод addEventHandler добавляет обработчик события на DOM-вершину.

addStateClass

Метод addStateClass добавляет CSS-класс к компоненту и удаляет прежний CSS-класс.

addToNode

Метод addToNode добавляет компонент в указанную вершину.
bindEvents Метод bindEvents подписывает элемент на все стандартные события.

getAnchorFlags

Метод getAnchorFlags возвращает JSON-объект с настройками текущей позиции компонента.

getClass

Метод getClass возвращает текущие css-классы компонента.

getCssStyle

Метод getCssStyle возвращает стили для указанной вершины.

getDomNode

Метод getDomNode возвращает главную DOM-вершину компонента.

getFocused

Метод getFocused определяет наличие фокуса у компонента.
getIsBinded Метод getIsBinded возвращает признак подписи элемента на события DOM-вершины.

hide

Метод hide скрывает элемент управления.

hideToolTip

Метод hideToolTip очищает таймаут появления подсказки и скрывает её, если она был показана.
refreshStyle Метод refreshStyle обновляет CSS-стили элемента.

removeClass

Метод removeClass удаляет CSS-класс из компонента.
removeEventHandler Метод removeEventHandler удаляет обработчик события DOM-вершины.
removeFromDOM Метод removeFromDOM удаляет вершину из DOM-структуры.

removeStateClasses

Метод removeStateClasses удаляет CSS-классы компонента.

setDraggable

Метод setDraggable устанавливает возможность перетаскивания компонента на HTML-странице.

setFocus

Метод setFocus устанавливает фокус компонента.

setIsHovered

Метод setIsHovered настраивает отображение компонента только при наведении на него курсора.

setSize

Метод setSize устанавливает размеры компонента.

show

Метод show отображает элемент управления.
unBindEvents Метод unBindEvents отписывает элемент от всех стандартных событий.

updatePosition

Метод updatePosition корректирует размер и положение при абсолютном позиционировании на основе текущих параметров.

updateSize

Метод updateSize обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

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

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

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

  Имя свойства Краткое описание

Id

Свойство Id определяет идентификатор объекта репозитория.

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

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

См. также:

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