Ribbon

Описание

Компонент Ribbon представляет собой ленту приложения, которая объединяет в себе функциональность главного меню и панели инструментов.

Лента приложения состоит из:

Вкладки могут быть обычными и контекстными. Контекстные вкладки отображаются по мере необходимости.

На вкладках расположены панели, на панелях - элементы управления.

Для экономии пространства содержимое вкладок может сворачиваться при нажатии на кнопку .

Размещать и настраивать ленту приложения можно как из API, так и из JSON.

Комментарии

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

Пример

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

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

Конструктор

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

Свойства

  Имя свойства Краткое описание
Controls Свойство Controls содержит набор элементов управления ленты инструментов.
IsAutoHiding Свойство IsAutoHiding определяет, свернута ли лента приложения.
IsAutoHidingEnabled Свойство IsAutoHidingEnabled определяет, доступна ли кнопка сворачивания ленты приложения.
MainButton Свойство MainButton устанавливает настройки для кнопки приложения.
MainMenu Свойство MainMenu устанавливает главное меню ленты приложения.
QuickAccessControls Свойство QuickAccessControls устанавливает кнопки панели быстрого доступа.
SelectedIndex Свойство SelectedIndex устанавливает индекс активной вкладки.
SelectedItem Свойство SelectedItem устанавливает активную вкладку ленты инструментов.
UseIntellisense Свойство UseIntellisense определяет наличие команд ленты инструментов.

Методы

  Имя метода Краткое описание
addCategory Метод addCategory добавляет вкладку на ленту приложения.
addQuickAccessControl Метод addQuickAccessControl добавляет кнопку на панель быстрого доступа.
beginUpdate Метод beginUpdate отключает перерисовку ленты инструментов до тех пор, пока не будет вызван метод endUpdate.
endUpdate Метод endUpdate включает перерисовку ленты инструментов и обновляет её.
getCategoriesByGroupName Метод getCategoriesByGroupName возвращает массив контекстных вкладок по имени группы.
getCategory Метод getCategory возвращает вкладку ленты инструментов по индексу.
getCategoryById Метод getCategoryById возвращает вкладку по идентификатору.
getControlById Метод getControlById возвращает элемент управления по идентификатору.
getCustomControlsContainer Метод getCustomControlsContainer возвращает контейнер для пользовательских элементов управления.
getHideButton Метод getHideButton возвращает кнопку сворачивания/разворачивания содержимого вкладок.
getImageList Метод getImageList возвращает объект PP.ImageList, содержащий путь к файлу с картинками.
getIsCategoryContentHidden Метод getIsCategoryContentHidden возвращает признак того, является ли вкладка скрытой.
getItems Метод getItems возвращает массив вкладок ленты приложения.
getMainButton Метод getMainButton возвращает кнопку приложения.
getPanelById Метод getPanelById возвращает панель по идентификатору.
getQuickAccessControls Метод getQuickAccessControls возвращает элементы управления панели быстрого доступа.
getSelectedItem Метод getSelectedItem возвращает активную вкладку.
removeQuickAccessControl Метод removeQuickAccessControl удаляет кнопку из панели быстрого доступа по индексу.
removeQuickAccessControlById Метод removeQuickAccessControlById удаляет кнопку из панели быстрого доступа по идентификатору.
setCategoriesVisibilityByGroupName Метод setCategoriesVisibilityByGroupName определяет, отображается ли группа контекстных вкладок.
setSettingsTo Метод setSettingsTo устанавливает JSON-объект с настройками для указанного элемента управления.
showCategoryContent Метод showCategoryContent раскрывает содержимое вкладок.
updateAutoComplete Метод updateAutoComplete обновляет результат поиска операций, введенных в поле быстрого запуска.

События

  Имя события Краткое описание
CategoryContentCollapsed Событие CategoryContentCollapsed наступает при сворачивании содержимого вкладок.
CategoryContentExpanded Событие CategoryContentExpanded наступает при разворачивании содержимого вкладок.
CategoryDeselected Событие CategoryDeselected наступает при закрытии вкладки.
CategorySelected Событие CategorySelected наступает при выборе вкладки.

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

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

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

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

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

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

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

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

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

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

См. также:

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