Класс `CMFCRibbonBar`

Статья
10/12/2023

Класс CMFCRibbonBar реализует панель ленты. Аналогичная реализация использовалась в Office 2007.

Дополнительные сведения см. в исходном коде, расположенном в папке mfc установки Visual Studio. Например, %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc.

Синтаксис

class CMFCRibbonBar : public CPane

Участники

Открытые конструкторы

Имя	Описание
`CMFCRibbonBar::CMFCRibbonBar`	Конструктор по умолчанию.

Открытые методы

Имя	Описание
`CMFCRibbonBar::ActivateContextCategory`	Активирует уже видимую категорию контекста.
`CMFCRibbonBar::AddCategory`	Добавляет на ленту новую категорию.
`CMFCRibbonBar::AddContextCategory`	Добавляет категорию контекста.
`CMFCRibbonBar::AddMainCategory`	Добавляет новую основную категорию ленты.
`CMFCRibbonBar::AddPrintPreviewCategory`
`CMFCRibbonBar::AddQATOnlyCategory`
`CMFCRibbonBar::AddToTabs`	Добавляет элемент ленты справа от панели ленты.
`CMFCRibbonBar::CreateEx`	Создает панель управления и присоединяет ее к объекту `CPane` . (Переопределяет `CPane::CreateEx`.)
`CMFCRibbonBar::Create`	Создает элемент управления панели ленты и прикрепляет его к панели ленты.
`CMFCRibbonBar::DeactivateKeyboardFocus`
`CMFCRibbonBar::DrawMenuImage`
`CMFCRibbonBar::DWMCompositionChanged`
`CMFCRibbonBar::EnableKeyTips`	Включает или отключает всплывающие подсказки для элемента управления ленты.
`CMFCRibbonBar::EnablePrintPreview`	Включите вкладку "Предварительный просмотр печати".
`CMFCRibbonBar::EnableToolTips`	Включает или отключает всплывающие подсказки и описания на панели ленты.
`CMFCRibbonBar::FindByData`	Поиск элемента ленты по указанным пользователем данным.
`CMFCRibbonBar::FindByID`	Находит элемент ленты с указанным идентификатором команды.
`CMFCRibbonBar::FindCategoryIndexByData`	Находит индекс категории ленты, содержащей определенные пользователем данные.
`CMFCRibbonBar::ForceRecalcLayout`
`CMFCRibbonBar::GetActiveCategory`	Возвращает указатель на активную категорию.
`CMFCRibbonBar::GetCaptionHeight`	Возвращает высоту заголовка. (Переопределяет `CBasePane::GetCaptionHeight`.)
`CMFCRibbonBar::GetCategory`	Возвращает указатель на категорию, расположенную по указанному индексу.
`CMFCRibbonBar::GetCategoryCount`	Возвращает число категорий ленты на панели ленты.
`CMFCRibbonBar::GetCategoryHeight`
`CMFCRibbonBar::GetCategoryIndex`	Возвращает индекс категории ленты.
`CMFCRibbonBar::GetContextName`	Извлекает имя заголовка категории контекста, указанного с помощью идентификатора.
`CMFCRibbonBar::GetDroppedDown`
`CMFCRibbonBar::GetElementsByID`	Возвращает массив, содержащий указатели на все элементы ленты с указанными идентификаторами.
`CMFCRibbonBar::GetApplicationButton`	Возвращает указатель на кнопку ленты.
`CMFCRibbonBar::GetFocused`	Возвращает элемент, имеющий фокус ввода.
`CMFCRibbonBar::GetHideFlags`
`CMFCRibbonBar::GetItemIDsList`
`CMFCRibbonBar::GetKeyboardNavigationLevel`
`CMFCRibbonBar::GetKeyboardNavLevelCurrent`
`CMFCRibbonBar::GetKeyboardNavLevelParent`
`CMFCRibbonBar::GetMainCategory`	Возвращает указатель на выбранную категорию ленты.
`CMFCRibbonBar::GetQATCommandsLocation`
`CMFCRibbonBar::GetQATDroppedDown`
`CMFCRibbonBar::GetQuickAccessCommands`	Заполняет список идентификаторами команд всех элементов, отображающихся на панели быстрого доступа.
`CMFCRibbonBar::GetQuickAccessToolbarLocation`
`CMFCRibbonBar::GetTabTrancateRatio`
`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`
`CMFCRibbonBar::GetTooltipFixedWidthRegular`
`CMFCRibbonBar::GetVisibleCategoryCount`
`CMFCRibbonBar::HideAllContextCategories`	Скрывает все видимые и активные категории.
`CMFCRibbonBar::HideKeyTips`
`CMFCRibbonBar::HitTest`	Находит указатель на элемент ленты, расположенный в указанной точке клиентских координат панели ленты.
`CMFCRibbonBar::IsKeyTipEnabled`	Определяет, включены ли ключевые подсказки.
`CMFCRibbonBar::IsMainRibbonBar`
`CMFCRibbonBar::IsPrintPreviewEnabled`	Определяет, включена ли вкладка "Предварительный просмотр печати".
`CMFCRibbonBar::IsQATEmpty`
`CMFCRibbonBar::IsQuickAccessToolbarOnTop`	Определяет, находится ли панель быстрого доступа над панелью ленты.
`CMFCRibbonBar::IsReplaceFrameCaption`	Определяет, заменяет панель ленты заголовок главного фрейма или добавляется под ним.
`CMFCRibbonBar::IsShowGroupBorder`
`CMFCRibbonBar::IsToolTipDescrEnabled`	Определяет, включены ли всплывающие описания.
`CMFCRibbonBar::IsToolTipEnabled`	Определяет, включены ли всплывающие подсказки для ленты.
`CMFCRibbonBar::IsTransparentCaption`
`CMFCRibbonBar::IsWindows7Look`	Указывает, оформлена ли лента в стиле Windows 7 (небольшая прямоугольная кнопка приложения).
`CMFCRibbonBar::LoadFromResource`	Перегружен. Загружает панель ленты из ресурсов приложения.
`CMFCRibbonBar::OnClickButton`
`CMFCRibbonBar::OnEditContextMenu`
`CMFCRibbonBar::OnRTLChanged`	(Переопределяет `CPane::OnRTLChanged`.)
`CMFCRibbonBar::OnSetAccData`	(Переопределяет `CBasePane::OnSetAccData`.)
`CMFCRibbonBar::OnShowRibbonContextMenu`
`CMFCRibbonBar::OnShowRibbonQATMenu`
`CMFCRibbonBar::OnSysKeyDown`
`CMFCRibbonBar::OnSysKeyUp`
`CMFCRibbonBar::PopTooltip`
`CMFCRibbonBar::PreTranslateMessage`	(Переопределяет `CBasePane::PreTranslateMessage`.)
`CMFCRibbonBar::RecalcLayout`	(Переопределяет `CPane::RecalcLayout`.)
`CMFCRibbonBar::RemoveAllCategories`	Удаляет все категории с панели ленты.
`CMFCRibbonBar::RemoveAllFromTabs`	Удаляет все элементы ленты из области вкладки.
`CMFCRibbonBar::RemoveCategory`	Удаляет категорию ленты, расположенную по указанному индексу.
`CMFCRibbonBar::SaveToXMLBuffer`	Сохраняет панель ленты в буфер.
`CMFCRibbonBar::SaveToXMLFile`	Сохраняет панель ленты в файл XML.
`CMFCRibbonBar::SetActiveCategory`	Назначает указанной категории ленты активное состояние.
`CMFCRibbonBar::SetActiveMDIChild`
`CMFCRibbonBar::SetElementKeys`	Задает указанные ключевые подсказки для всех элементов ленты, которые имеют указанный идентификатор команды.
`CMFCRibbonBar::SetApplicationButton`	Помещает на панель ленты кнопку приложения.
`CMFCRibbonBar::SetKeyboardNavigationLevel`
`CMFCRibbonBar::SetMaximizeMode`
`CMFCRibbonBar::SetQuickAccessCommands`	Добавляет один или несколько элементов ленты на панель быстрого доступа.
`CMFCRibbonBar::SetQuickAccessDefaultState`	Задает состояние панели быстрого доступа по умолчанию.
`CMFCRibbonBar::SetQuickAccessToolbarOnTop`	Помещает панель быстрого доступа над панелью ленты или под ней.
`CMFCRibbonBar::SetTooltipFixedWidth`
`CMFCRibbonBar::SetWindows7Look`	Включает или отключает оформление ленты в стиле Windows 7 (небольшая прямоугольная кнопка приложения).
`CMFCRibbonBar::ShowCategory`	Отображает или скрывает указанную категорию ленты.
`CMFCRibbonBar::ShowContextCategories`	Показывает или скрывает категории контекста с указанным идентификатором.
`CMFCRibbonBar::ShowKeyTips`
`CMFCRibbonBar::ToggleMimimizeState`	Переключает панель ленты между свернутым и развернутым состояниями.
`CMFCRibbonBar::TranslateChar`

Замечания

Корпорация Майкрософт представила ленту (Office Fluent Ribbon) вместе с выпуском Microsoft Office 2007. Эта панель ленты — это не просто новый элемент управления. Она представляет собой новый подход к пользовательскому интерфейсу. Лента — это панель с вкладками, которые называются категориями. Каждая категория делится на группы, содержащие различные элементы управления и кнопки команд.

Элементы, отображающиеся на панели ленты, разворачиваются и сворачиваются, чтобы оптимально задействовать доступное пространство. Например, если в группе ленты становится недостаточно места для отображения всех необходимых элементов, она превращается в кнопку, элементы которой показываются во всплывающем меню. Лента ведет себя как статическая (неперемещаемая) панель элементов управления, которую можно закрепить в верхней части фрейма.

С помощью класса CMFCRibbonStatusBar вы можете реализовать строку состояния, аналогичную используемой в Office 2007. Категория ленты содержит (и отображает) группу панелей ленты. Каждая панель ленты содержит один или несколько элементов ленты, производных от CMFCRibbonBaseElement.

Сведения о добавлении панели ленты в существующее приложение MFC см. в пошаговом руководстве по обновлению приложения MFC Scribble.

Иерархия наследования

Требования

Заголовок: afxribbonbar.h

`CMFCRibbonBar::ActivateContextCategory`

Активирует уже видимую категорию контекста.

BOOL ActivateContextCategory(UINT uiContextID);

Параметры

uiContextID
[in] Идентификатор категории контекста.

Возвращаемое значение

TRUE Значение , если категория контекста с uiContextID найдена и активирована; в противном случае FALSE.

`CMFCRibbonBar::AddCategory`

Создает и инициализирует новую категорию ленты для панели ленты.

CMFCRibbonCategory* AddCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage= CSize(16,
    16),
    CSize sizeLargeImage= CSize(32,
    32),
    int nInsertAt = -1,
    CRuntimeClass* pRTI= NULL);

Параметры

lpszName
[in] Имя категории ленты.

uiSmallImagesResID
[in] Идентификатор ресурса небольшого списка изображений для категории ленты.

uiLargeImagesResID
[in] Идентификатор ресурса большого списка изображений для категории ленты.

sizeSmallImage
[in] Задает размер небольших изображений для категории ленты.

sizeLargeImage
[in] Задает размер больших изображений для категории ленты.

nInsertAt
[in] Отсчитываемый от нуля индекс расположения категории.

pRTI
[in] Указатель на CMFCRibbonCategory класс времени выполнения класса для динамического создания категории ленты во время выполнения.

Возвращаемое значение

Указатель на новую категорию ленты, если метод выполнен успешно; NULLв противном случае .

Замечания

pRTI Если параметр не NULLзадан, новая категория ленты создается динамически с помощью класса времени выполнения.

Пример

В следующем примере показано, как использовать AddCategory метод в CMFCRibbonBar классе.

// Add "Home" category.
// CMFCRibbonBar m_wndRibbonBar
strTemp.LoadString(IDS_RIBBON_HOME);
CMFCRibbonCategory *pCategoryHome = m_wndRibbonBar.AddCategory(strTemp,
                                                               IDB_WRITESMALL, IDB_WRITELARGE);

`CMFCRibbonBar::AddContextCategory`

Создает и инициализирует новую категорию контекста для панели ленты.

CMFCRibbonCategory* AddContextCategory(
    LPCTSTR lpszName,
    LPCTSTR lpszContextName,
    UINT uiContextID,
    AFX_RibbonCategoryColor clrContext,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32),
    CRuntimeClass* pRTI = NULL);

Параметры

lpszName
[in] Имя категории.

lpszContextName
[in] Имя заголовка категории контекста.

uiContextID
[in] Идентификатор контекста.

clrContext
[in] Цвет заголовка категории контекста.

uiSmallImagesResID
[in] Идентификатор ресурса небольшого изображения категории контекста.

uiLargeImagesResID
[in] Идентификатор ресурса большого изображения категории контекста.

sizeSmallImage
[in] Размер небольшого изображения.

sizeLargeImage
[in] Размер большого изображения.

pRTI
[in] Указатель на класс среды выполнения.

Возвращаемое значение

Указатель на только что созданную категорию или NULL CreateObject если метод pRTI не может создать указанную категорию.

Замечания

Используйте эту функцию для добавления категории контекста. Категории контекста — это особый тип категории, которая может отображаться или скрыта во время выполнения в зависимости от текущего контекста приложения. Например, когда пользователь выбирает объект, можно отобразить специальные вкладки с категориями контекста, которые используются для изменения определенного выбранного объекта.

Цвет категории контекста может быть одним из следующих значений:

AFX_CategoryColor_None
AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet

`CMFCRibbonBar::AddMainCategory`

Создает новую основную категорию ленты для панели ленты.

CMFCRibbonMainPanel* AddMainCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

Параметры

lpszName
[in] Имя основной категории ленты.

uiSmallImagesResID
[in] Идентификатор ресурса небольших изображений.

uiLargeImagesResID
[in] Идентификатор ресурса больших изображений.

sizeSmallImage
[in] Размер небольших изображений.

sizeLargeImage
[in] Размер больших изображений.

Возвращаемое значение

Указатель на новую категорию основной ленты, если метод выполнен успешно; NULLв противном случае .

Замечания

Если основная категория ленты уже существует, она удаляется.

Пример

В следующем примере показано, как использовать AddMainCategory метод в CMFCRibbonBar классе.

// m_wndRibbonBar is declared as a protected member variable
// CMFCRibbonBar m_wndRibbonBar.
// strTemp is a CString variable.
strTemp.LoadString(IDS_RIBBON_FILE);
CMFCRibbonMainPanel *pMainPanel = m_wndRibbonBar.AddMainCategory(strTemp,
                                                                 IDB_FILESMALL, IDB_FILELARGE);

`CMFCRibbonBar::AddPrintPreviewCategory`

Создает категорию предварительного просмотра печати на панели ленты.

CMFCRibbonCategory* AddPrintPreviewCategory();

Возвращаемое значение

Указатель на новую категорию ленты, если метод выполнен успешно; NULLв противном случае .

Замечания

Этот метод создает категорию ленты и элементы управления, необходимые для предоставления предварительного просмотра печати.

`CMFCRibbonBar::AddQATOnlyCategory`

Создает категорию ленты панели быстрого доступа.

CMFCRibbonCategory* AddQATOnlyCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    CSize sizeSmallImage = CSize(16,
    16));

Параметры

lpszName
[in] Имя категории.

uiSmallImagesResID
[in] Идентификатор ресурса списка изображений для категории.

sizeSmallImage
[in] Размер изображений для элементов ленты в категории.

Возвращаемое значение

Указатель на новую категорию, если метод выполнен успешно; NULLв противном случае .

Замечания

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

`CMFCRibbonBar::AddToTabs`

Добавляет указанный элемент ленты в строку вкладок панели ленты.

void AddToTabs(CMFCRibbonBaseElement* pElement);

Параметры

pElement
[in] Указатель на элемент ленты.

Замечания

Элемент ленты размещается перед любыми системными кнопками.

`CMFCRibbonBar::CMFCRibbonBar`

Создает и инициализирует объект CMFCRibbonBar.

CMFCRibbonBar(BOOL bReplaceFrameCaption = TRUE);

Параметры

bReplaceFrameCaption
[in] TRUE для панели ленты для замены заголовка главного окна фрейма; FALSE Чтобы найти панель ленты под заголовком главного окна фрейма.

Замечания

`CMFCRibbonBar::Create`

Создает окно для панели ленты.

BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

Параметры

pParentWnd
[in] Указатель на родительское окно для панели ленты.

dwStyle
[in] Логическое сочетание стилей для нового окна.

nID
[in] Идентификатор нового окна.

Возвращаемое значение

TRUE Значение , если окно было создано; в противном случае FALSE.

Замечания

Пример

В следующем примере показано, как использовать Create метод CMFCRibbonBar класса.

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.Create(this, WS_CHILD | CBRS_TOP);

`CMFCRibbonBar::CreateEx`

Создает окно для панели ленты.

BOOL CreateEx(
    CWnd* pParentWnd,
    DWORD dwCtrlStyle = 0,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

Параметры

pParentWnd
[in] Указатель на родительское окно для панели ленты.

dwCtrlStyle
[in] Этот параметр не используется.

dwStyle
[in] Логическое сочетание стилей для нового окна.

nID
[in] Идентификатор нового окна.

Возвращаемое значение

TRUE Значение , если окно было создано; в противном случае FALSE.

Замечания

`CMFCRibbonBar::DeactivateKeyboardFocus`

Закрывает все элементы управления подсказкой на панели ленты.

void DeactivateKeyboardFocus(BOOL bSetFocus = TRUE);

Параметры

bSetFocus
[in] TRUE Чтобы задать фокус в родительском окне панели ленты.

Замечания

`CMFCRibbonBar::DrawMenuImage`

Рисует изображение для кнопки меню.

BOOL DrawMenuImage(
    CDC* pDC,
    const CMFCToolBarMenuButton* pMenuItem,
    const CRect& rectImage);

Параметры

pDC
[in] Указатель на контекст устройства для кнопки меню.

pMenuItem
[in] Указатель на кнопку меню панели инструментов.

rectImage
[in] Прямоугольник отображения для кнопки меню.

Возвращаемое значение

TRUE Значение FALSE.

Замечания

`CMFCRibbonBar::DWMCompositionChanged`

Настраивает отображение панели ленты при включении или отключении композиции диспетчера окон рабочего стола (DWM).

virtual void DWMCompositionChanged();

Замечания

`CMFCRibbonBar::EnableKeyTips`

Включает или отключает функцию подсказки для панели ленты.

void EnableKeyTips(BOOL bEnable = TRUE);

Параметры

bEnable
[in] TRUE для включения функции подсказки ключей; FALSE чтобы отключить функцию подсказок ключей.

Замечания

При включении этой функции подсказки клавиш отображаются при нажатии клавиш ALT или F10 . Когда пользователь нажимает клавиши ALT , подсказки клавиш отображаются с задержкой в 200 миллисекундах. Эта задержка позволяет выполнять сочетания клавиш, чтобы нажатие клавиши ALT не вмешивалось в другие сочетания, включающие клавишу ALT.

`CMFCRibbonBar::EnablePrintPreview`

Включает или отключает функцию предварительного просмотра печати.

void EnablePrintPreview(BOOL bEnable = TRUE);

Параметры

bEnable
[in] TRUE чтобы включить функцию предварительного просмотра печати; FALSE отключить функцию предварительного просмотра печати.

Замечания

Если bEnable есть FALSE и существует категория предварительного просмотра печати, она удаляется.

По умолчанию включена функция предварительного просмотра печати.

`CMFCRibbonBar::EnableToolTips`

Включает или отключает подсказки и необязательные описания подсказки на панели ленты.

void EnableToolTips(
    BOOL bEnable = TRUE,
    BOOL bEnableDescr = TRUE);

Параметры

bEnable
[in] TRUE для включения подсказок на панели ленты; FALSE Чтобы отключить подсказки на панели ленты.

bEnableDescr
[in] TRUE для включения описания подсказки в подсказке; FALSE Чтобы отключить описания подсказки в подсказке.

Замечания

Параметр bEnable определяет, отображаются ли подсказки при наведении указателя мыши на элемент ленты. Параметр bEnableDescr определяет, отображается ли дополнительный описательный текст с текстом подсказки.

`CMFCRibbonBar::FindByData`

Извлекает указатель на элемент ленты, если он содержит указанные данные и видимость.

CMFCRibbonBaseElement* FindByData(
    DWORD_PTR dwData,
    BOOL bVisibleOnly = TRUE) const;

Параметры

dwData
[in] Данные, связанные с элементом ленты.

bVisibleOnly
[in] TRUE поиск только видимых элементов ленты; FALSE для поиска всех элементов ленты.

Возвращаемое значение

Указатель на элемент ленты, если он содержит указанные данные и видимость; в противном случае NULL.

Замечания

Элемент ленты — это любой элемент управления, который можно добавить на ленту, например кнопку ленты, категорию ленты или ползунок ленты.

`CMFCRibbonBar::FindByID`

Извлекает указатель на элемент ленты с указанным идентификатором команды и значениями поиска.

CMFCRibbonBaseElement* FindByID(
    UINT uiCmdID,
    BOOL bVisibleOnly = TRUE,
    BOOL bExcludeQAT = FALSE) const;

Параметры

uiCmdID
[in] Идентификатор команды для элемента ленты.

bVisibleOnly
[in] TRUE поиск только видимых элементов ленты; FALSE для поиска всех элементов ленты.

bExcludeQAT
[in] TRUE для исключения элементов панели быстрого доступа из поиска; FALSEв противном случае .

Возвращаемое значение

Указатель на элемент ленты, если он имеет указанный идентификатор команды и значения поиска; NULLв противном случае .

Замечания

Элемент ленты — это любой элемент управления лентой, который можно добавить на ленту, например кнопку ленты, категорию ленты или ползунок ленты.

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

`CMFCRibbonBar::FindCategoryIndexByData`

Извлекает индекс категории ленты, содержащей указанные данные.

int FindCategoryIndexByData(DWORD dwData) const;

Параметры

dwData
[in] Данные, связанные с категорией ленты.

Возвращаемое значение

Отсчитываемый от нуля индекс категории ленты, если метод выполнен успешно; в противном случае - 1.

`CMFCRibbonBar::ForceRecalcLayout`

Изменяет макет всех элементов на панели ленты и родительском окне и перерисовывает все окно.

void ForceRecalcLayout();

Замечания

`CMFCRibbonBar::GetActiveCategory`

Извлекает указатель на активную категорию ленты.

CMFCRibbonCategory* GetActiveCategory() const;

Возвращаемое значение

Указатель на активную категорию ленты; или NULL если категория не активна.

Замечания

Категория активна, если она имеет фокус. По умолчанию активная категория является первой категорией в левой части панели ленты.

Основная категория отображается, когда пользователь нажимает кнопку приложения и не может быть активной категорией.

`CMFCRibbonBar::GetApplicationButton`

Извлекает указатель на кнопку приложения.

CMFCRibbonApplicationButton* GetApplicationButton() const;

Возвращаемое значение

Указатель на кнопку приложения; или NULL если кнопка не была задана.

`CMFCRibbonBar::GetCaptionHeight`

Извлекает высоту области заголовка для панели ленты.

int GetCaptionHeight() const;

Возвращаемое значение

Высота в пикселях области заголовка для панели ленты.

Замечания

`CMFCRibbonBar::GetCategory`

Извлекает указатель на категорию ленты по указанному индексу.

CMFCRibbonCategory* GetCategory(int nIndex) const;

Параметры

nIndex
[in] Отсчитываемый от нуля индекс категории ленты в списке категорий ленты, содержащихся на панели ленты.

Возвращаемое значение

Указатель на категорию ленты по указанному индексу; в противном случае, NULL если nIndex не было диапазона.

`CMFCRibbonBar::GetCategoryCount`

Извлекает количество категорий ленты на панели ленты.

int GetCategoryCount() const;

Возвращаемое значение

Количество категорий ленты на панели ленты.

`CMFCRibbonBar::GetCategoryHeight`

Извлекает высоту категории.

int GetCategoryHeight() const;

Возвращаемое значение

Высота категории.

Замечания

Высота категории включает высоту вкладки категорий.

`CMFCRibbonBar::GetCategoryIndex`

Извлекает индекс указанной категории ленты.

int GetCategoryIndex(CMFCRibbonCategory* pCategory) const;

Параметры

pCategory
[in] Указатель на категорию ленты.

Возвращаемое значение

Отсчитываемый от нуля индекс категории ленты, указанной pCategory; или -1, если категория ленты не найдена.

`CMFCRibbonBar::GetContextName`

Извлекает имя заголовка категории контекста, указанного идентификатором контекста.

BOOL GetContextName(
    UINT uiContextID,
    CString& strName) const;

Параметры

uiContextID
[in] Идентификатор контекста категории ленты.

strName
[out] Имя заголовка категории контекста.

Возвращаемое значение

TRUE Значение , если метод выполнен успешно; в противном случае, FALSE если uiContextID значение равно нулю или заголовку категории контекста не найдено.

`CMFCRibbonBar::GetDroppedDown`

Извлекает элемент ленты, который в настоящее время удален.

virtual CMFCRibbonBaseElement* GetDroppedDown();

Возвращаемое значение

Элемент ленты, который в настоящее время удален; или NULL если элемент ленты в настоящее время не удаляется.

Замечания

`CMFCRibbonBar::GetElementsByID`

Извлекает массив указателей на все элементы ленты с определенным идентификатором команды.

void GetElementsByID(
    UINT uiCmdID,
    CArray<CMFCRibbonBaseElement*,CMFCRibbonBaseElement*>& arButtons);

Параметры

uiCmdID
[in] Идентификатор команды элемента ленты.

arButtons
[out] Массив указателей на элементы ленты.

Замечания

Несколько элементов ленты могут иметь один и тот же идентификатор команды, так как некоторые элементы ленты можно скопировать на панель быстрого доступа.

`CMFCRibbonBar::GetHideFlags`

Извлекает флаги, указывающие, сколько из панели ленты отображается.

DWORD GetHideFlags() const;

Возвращаемое значение

Флаги, указывающие, сколько из панели ленты отображается.

Замечания

В следующей таблице перечислены возможные сочетания флагов для возвращаемого значения:

Флаг	Description
`AFX_RIBBONBAR_HIDE_ELEMENTS`	Панель ленты свернута по вертикали, и отображаются только вкладки категорий, основная кнопка и панель быстрого доступа.
`AFX_RIBBONBAR_HIDE_ALL`	Ширина панели ленты меньше минимальной ширины и полностью скрыта.

`CMFCRibbonBar::GetItemIDsList`

Извлекает идентификаторы команд для указанной коллекции элементов ленты на панели ленты.

void GetItemIDsList(CList<UINT, UINT>& lstItems,
    BOOL bHiddenOnly = FALSE) const;

Параметры

lstItems
[out] Список идентификаторов команд для элементов ленты, содержащихся на панели ленты.

bHiddenOnly
[in] TRUE для исключения отображаемых элементов ленты; FALSE для включения всех элементов ленты в панель ленты.

Замечания

`CMFCRibbonBar::GetKeyboardNavigationLevel`

Извлекает текущий уровень навигации, когда пользователь нажимает подсказки клавиш, содержащиеся на панели ленты.

int GetKeyboardNavigationLevel() const;

Возвращаемое значение

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

значение	Описание
-1	Подсказки ключей не отображаются.
0	Отображаются подсказки ключей.
1	Пользователь нажал отображаемую подсказку.

Замечания

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

Извлекает текущий объект навигации клавиатуры на панели ленты.

CObject* GetKeyboardNavLevelCurrent() const;

Возвращаемое значение

Текущий объект навигации по клавиатуре на панели ленты; в противном случае NULL , если в данный момент объект не отображает подсказки.

Замечания

Объект, который в настоящее время отображает подсказки клавиши, является текущим объектом навигации клавиатуры.

`CMFCRibbonBar::GetKeyboardNavLevelParent`

Извлекает родительский объект навигации клавиатуры на панели ленты.

CObject* GetKeyboardNavLevelParent() const;

Возвращаемое значение

Родительский объект навигации клавиатуры на панели ленты; в противном случае NULL.

Замечания

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

`CMFCRibbonBar::GetMainCategory`

Извлекает указатель на основную категорию ленты.

CMFCRibbonCategory* GetMainCategory() const;

Возвращаемое значение

Указатель на основную категорию ленты.

Замечания

Основная категория ленты содержит основную панель ленты.

`CMFCRibbonBar::GetQATCommandsLocation`

Извлекает прямоугольник отображения для раздела команд панели быстрого доступа.

CRect GetQATCommandsLocation() const;

Возвращаемое значение

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

Замечания

Раздел команд прямоугольника отображения не включает кнопку настройки.

`CMFCRibbonBar::GetQATDroppedDown`

Извлекает указатель на элемент ленты на панели быстрого доступа с раскрывающимся меню всплывающего окна.

CMFCRibbonBaseElement* GetQATDroppedDown();

Возвращаемое значение

Указатель на элемент ленты на панели быстрого доступа с раскрывающимся меню всплывающего меню.

Замечания

`CMFCRibbonBar::GetQuickAccessCommands`

Извлекает список идентификаторов команд для элементов ленты на панели быстрого доступа.

void GetQuickAccessCommands(CList<UINT,UINT>& lstCommands);

Параметры

lstCommands
[out] Список идентификаторов команд для элементов ленты на панели быстрого доступа.

Замечания

Список не содержит элементы ленты, которые являются разделителями элементов управления.

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

Извлекает прямоугольник отображения для панели быстрого доступа.

CRect GetQuickAccessToolbarLocation() const;

Возвращаемое значение

Прямоугольник отображения для панели быстрого доступа.

Замечания

`CMFCRibbonBar::GetTabTrancateRatio`

Извлекает уменьшение размера процента в ширину отображения вкладок категорий.

int GetTabTrancateRatio() const;

Возвращаемое значение

Процент уменьшения ширины отображаемых вкладок категорий.

Замечания

Вкладки категорий сокращаются по ширине, если на панели ленты недостаточно ширины.

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

Извлекает большой размер ширины подсказки для панели ленты.

int GetTooltipFixedWidthLargeImage() const;

Возвращаемое значение

Большой размер ширины подсказки в пикселях.

Замечания

Если ширина подсказки большого размера равна 0, ширина зависит.

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

Извлекает обычный размер ширины подсказки для панели ленты.

int GetTooltipFixedWidthRegular() const;

Возвращаемое значение

Обычный размер ширины подсказки в пикселях.

Замечания

Если размер регулярной ширины подсказки равен 0, ширина изменяется.

`CMFCRibbonBar::GetVisibleCategoryCount`

Извлекает количество видимых категорий на панели ленты.

int GetVisibleCategoryCount() const;

Возвращаемое значение

Количество видимых категорий на панели ленты.

Замечания

`CMFCRibbonBar::HideAllContextCategories`

Скрывает все категории контекста на панели ленты.

BOOL HideAllContextCategories();

Возвращаемое значение

TRUE Значение ,если по крайней мере одна категория контекста скрыта; FALSEв противном случае .

Замечания

Если категория контекста активна, активная категория сбрасывается на первую видимую категорию в списке категорий.

`CMFCRibbonBar::HideKeyTips`

Скрывает все подсказки клавиш на панели ленты.

void HideKeyTips();

Замечания

`CMFCRibbonBar::HitTest`

Извлекает указатель на элемент ленты, указанный расположением точки.

virtual CMFCRibbonBaseElement* HitTest(
    CPoint point,
    BOOL bCheckActiveCategory= FALSE,
    BOOL bCheckPanelCaption= FALSE);

Параметры

point
[in] Расположение точки в координатах панели ленты.

bCheckActiveCategory
[in] TRUE для поиска активной категории; FALSE не искать активную категорию.

bCheckPanelCaption
[in] TRUE чтобы проверить подпись панели ленты с точкой, расположенной в ней; FALSE не проверять подпись панели ленты с точкой, расположенной в ней. Дополнительные сведения см. в разделе "Примечания".

Возвращаемое значение

Указатель на элемент ленты, расположенный в указанной точке; в противном случае NULL , если точка не находится в элементе ленты.

Замечания

Подпись панели ленты с точкой, расположенной в ней, не проверяется, если bCheckActiveCategory параметр не является TRUE.

`CMFCRibbonBar::IsKeyTipEnabled`

Указывает, включена ли функция подсказки ключей.

BOOL IsKeyTipEnabled() const;

Возвращаемое значение

TRUE Значение FALSE.

`CMFCRibbonBar::IsMainRibbonBar`

Указывает, является ли панель ленты основной панелью ленты.

virtual BOOL IsMainRibbonBar() const;

Возвращаемое значение

Всегда возвращает значение TRUE.

Замечания

По умолчанию этот метод всегда возвращается TRUE. Переопределите этот метод, чтобы указать, является ли панель ленты основной панелью ленты.

`CMFCRibbonBar::IsPrintPreviewEnabled`

Указывает, включена ли функция предварительного просмотра печати.

BOOL IsPrintPreviewEnabled() const;

Возвращаемое значение

TRUE Значение , если включена функция предварительного просмотра печати; в противном случае FALSE.

`CMFCRibbonBar::IsQATEmpty`

Указывает, содержит ли панель быстрого доступа кнопки команд.

BOOL IsQATEmpty() const;

Возвращаемое значение

TRUE Значение , если панель быстрого доступа содержит кнопки команд; в противном случае FALSE.

Замечания

`CMFCRibbonBar::IsQuickAccessToolbarOnTop`

Указывает, находится ли панель быстрого доступа или находится под панелью ленты.

BOOL IsQuickAccessToolbarOnTop() const;

Возвращаемое значение

TRUE Значение , если панель быстрого доступа расположена на панели ленты; FALSE Значение , если панель быстрого доступа находится под панелью ленты.

`CMFCRibbonBar::IsReplaceFrameCaption`

Указывает, заменяет ли панель ленты или находится под заголовком главного окна фрейма.

BOOL IsReplaceFrameCaption() const;

Возвращаемое значение

TRUE Значение , если панель ленты заменяет заголовок главного окна кадра; FALSE Если панель ленты находится под заголовком главного окна фрейма.

`CMFCRibbonBar::IsShowGroupBorder`

Указывает, отображаются ли группы кнопок, расположенные на панели ленты, границу группы.

virtual BOOL IsShowGroupBorder(CMFCRibbonButtonsGroup* pGroup) const;

Параметры

pGroup
[in] Этот параметр не используется.

Возвращаемое значение

Всегда возвращает значение FALSE.

Замечания

По умолчанию этот метод всегда возвращается FALSE. Переопределите этот метод, чтобы указать, отображаются ли группы кнопок, расположенные на панели ленты, границу группы.

`CMFCRibbonBar::IsToolTipDescrEnabled`

Указывает, включены ли описания подсказки.

BOOL IsToolTipDescrEnabled() const;

Возвращаемое значение

TRUE Значение , если включены описания подсказки; FALSE Если описания подсказки отключены.

Замечания

Описания подсказки — это дополнительный описательный текст, отображаемый с текстом подсказки.

`CMFCRibbonBar::IsToolTipEnabled`

Указывает, включены ли подсказки или отключены для панели ленты.

BOOL IsToolTipEnabled() const;

Возвращаемое значение

TRUE Значение , если подсказки включены; FALSE Если подсказки отключены.

`CMFCRibbonBar::IsTransparentCaption`

Указывает, задано ли отображение для цветовой схемы Windows Aero.

BOOL IsTransparentCaption() const;

Возвращаемое значение

TRUE Значение , если цветовая схема — Windows Aero; в противном случае FALSE.

Замечания

`CMFCRibbonBar::OnClickButton`

Этот метод сохраняется для обратной совместимости с существующими приложениями и не должен использоваться для новой разработки.

virtual void OnClickButton(
    CMFCRibbonButton* pButton,
    CPoint point);

Параметры

pButton
[in] Указатель на кнопку, которая была нажата.

point
[in] Этот параметр не используется.

Замечания

`CMFCRibbonBar::OnEditContextMenu`

virtual void OnEditContextMenu(
    CMFCRibbonRichEditCtrl* pEdit,
    CPoint point);

Параметры

[входной] pEdit
[входной] point\

Замечания

`CMFCRibbonBar::OnRTLChanged`

Вызывается платформой при изменении направления макета.

virtual void OnRTLChanged(BOOL bIsRTL);

Параметры

bIsRTL
[in] TRUE Значение FALSE Значение , если макет находится слева направо.

Замечания

Этот метод настраивает макет всех элементов управления на панели ленты для нового направления макета.

`CMFCRibbonBar::OnSetAccData`

Этот метод является внутренним для Платформы и не предназначен для вызова из пользовательского кода.

BOOL OnSetAccData(long lVal);

Параметры

Long lVal Index of the accessible object.

Возвращаемое значение

S_OK в случае успешного выполнения; в противном случае FALSE или S_FALSE.

Замечания

`CMFCRibbonBar::OnShowRibbonContextMenu`

virtual BOOL OnShowRibbonContextMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

Параметры

[входной] pWnd
[входной] x
[входной] y
[входной] pHit\

Возвращаемое значение

Замечания

`CMFCRibbonBar::OnShowRibbonQATMenu`

virtual BOOL OnShowRibbonQATMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

Параметры

[входной] pWnd
[входной] x
[входной] y
[входной] pHit\

Возвращаемое значение

Замечания

`CMFCRibbonBar::OnSysKeyDown`

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

BOOL OnSysKeyDown(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

Параметры

pFrameWnd
[in] Указатель на родительское окно главной рамки панели ленты.

wParam
[in] Код виртуального ключа нажатия клавиши.

lParam
[in] Флаги состояния клавиатуры при нажатии клавиши.

Возвращаемое значение

TRUE Значение FALSE.

Замечания

`CMFCRibbonBar::OnSysKeyUp`

Вызывается платформой при выпуске клавиши F10, клавиши ALT или клавиши, которая была нажата при нажатии клавиши ALT.

BOOL OnSysKeyUp(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

Параметры

pFrameWnd
[in] Указатель на родительское окно главной рамки панели ленты.

wParam
[in] Код виртуального ключа выпуска ключа.

lParam
[in] Этот параметр не используется.

Возвращаемое значение

TRUE Значение FALSE.

Замечания

`CMFCRibbonBar::PopTooltip`

Удаляет подсказку из представления.

void PopTooltip();

Замечания

`CMFCRibbonBar::PreTranslateMessage`

Определяет, обрабатывается ли указанное сообщение панелью ленты.

virtual BOOL PreTranslateMessage(MSG* pMsg);

Параметры

pMsg
[in] Указатель на сообщение.

Возвращаемое значение

TRUE Значение , если сообщение было обработано панелью ленты; в противном случае FALSE.

Замечания

`CMFCRibbonBar::RecalcLayout`

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

virtual void RecalcLayout();

Замечания

После корректировки макета отображается панель ленты.

`CMFCRibbonBar::RemoveAllCategories`

Удаляет все категории ленты из панели ленты.

void RemoveAllCategories();

Замечания

Этот метод удаляет все категории ленты из памяти и из списка категорий.

`CMFCRibbonBar::RemoveAllFromTabs`

Удаляет все элементы ленты из области вкладки.

void RemoveAllFromTabs();

Замечания

Используйте эту функцию, если вы хотите удалить все элементы, добавленные в область вкладок, с помощью CMFCRibbonBar::AddToTabs метода.

`CMFCRibbonBar::RemoveCategory`

Удаляет указанную категорию ленты на панели ленты.

BOOL RemoveCategory(int nIndex);

Параметры

nIndex
[in] Отсчитываемый от нуля индекс категории в списке категорий ленты, содержащихся на панели ленты.

Возвращаемое значение

TRUE Значение , если указанная категория ленты удалена; в противном случае FALSE.

Замечания

Указанная категория ленты удаляется из памяти и из списка категорий.

`CMFCRibbonBar::SetActiveCategory`

Задает указанную категорию ленты в качестве активной категории.

BOOL SetActiveCategory(
    CMFCRibbonCategory* pCategory,
    BOOL bForceRestore= FALSE);

Параметры

pCategory
[in] Категория ленты, содержащаяся на панели ленты.

bForceRestore
[in] TRUE чтобы развернуть панель ленты, если она свернута; FALSE Чтобы отобразить активную категорию во всплывающем окне, если панель ленты свернута.

Возвращаемое значение

TRUE Значение FALSE.

Замечания

Основная категория ленты не может быть активной категорией.

Если категория, указанная pCategory не отображается, ее нельзя задать в качестве активной категории.

`CMFCRibbonBar::SetActiveMDIChild`

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

void SetActiveMDIChild(CWnd* pWnd);

Параметры

pWnd
[in] Указатель на дочернее окно MDI.

Замечания

`CMFCRibbonBar::SetApplicationButton`

Помещает на панель ленты кнопку приложения.

void SetApplicationButton(
    CMFCRibbonApplicationButton* pButton,
    CSize sizeButton);

Параметры

pButton
[in] Указатель на кнопку ленты приложения.

sizeButton
[in] Размер кнопки ленты приложения.

Замечания

Кнопка ленты приложения — это большая округленная кнопка, расположенная в левом верхнем углу элемента управления "Лента".

Пример

В следующем примере показано, как использовать SetApplicationButton метод в CMFCRibbonBar классе.

// Init main button:
// CMFCRibbonApplicationButton m_MainButton
m_MainButton.SetImage(IDB_MAIN);
m_MainButton.SetText(_T("\nf"));
m_MainButton.SetToolTipText(strTemp);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetApplicationButton(&m_MainButton, CSize(45, 45));

`CMFCRibbonBar::SetElementKeys`

Задает подсказки для всех элементов ленты с указанным идентификатором команды.

BOOL SetElementKeys(
    UINT uiCmdID,
    LPCTSTR lpszKeys,
    LPCTSTR lpszMenuKeys= NULL);

Параметры

uiCmdID
[in] Идентификатор команды элемента ленты.

lpszKeys
[in] Подсказка.

lpszMenuKeys
[in] Подсказка меню.

Возвращаемое значение

TRUE Значение , если заданы подсказки по крайней мере одного элемента ленты; в противном случае FALSE.

Замечания

Необязательная подсказка меню — для элементов ленты с кнопкой разделения, которая открывает всплывающее меню.

`CMFCRibbonBar::SetKeyboardNavigationLevel`

Задает уровень навигации клавиатуры, так как пользователь нажимает подсказки клавиш, содержащиеся на панели ленты.

void SetKeyboardNavigationLevel(
    CObject* pLevel,
    BOOL bSetFocus = TRUE);

Параметры

pLevel
[in] Указатель на текущий объект навигации клавиатуры.

bSetFocus
[in] TRUE Чтобы задать фокус клавиатуры на панели ленты.

Замечания

Навигация по клавиатуре панели ленты начинается, когда пользователь нажимает клавиши ALT или F10 . Пользователь выбирает следующий уровень навигации, нажав клавишу KEYTIP на панели ленты. Пользователь может вернуться на предыдущий уровень навигации, нажав клавишу ESCAPE.

`CMFCRibbonBar::SetMaximizeMode`

Настраивает панель ленты, когда размер окна дочернего окна с несколькими документами (MDI) вводит или оставляет максимальное состояние.

void SetMaximizeMode(
    BOOL bMax,
    CWnd* pWnd = NULL);

Параметры

bMax
[in] TRUE отображение системных кнопок дочернего окна MDI на панели ленты; FALSE чтобы удалить системные кнопки для дочернего окна MDI на панели ленты.

pWnd
[in] Указатель на главное окно фрейма для панели ленты.

Замечания

На панели ленты отображаются системные кнопки дочернего окна MDI в строке вкладок, когда развернуто дочернее окно MDI.

`CMFCRibbonBar::SetQuickAccessCommands`

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

void SetQuickAccessCommands(
    const CList<UINT,UINT>& lstCommands,
    BOOL bRecalcLayout=TRUE);

Параметры

lstCommands
[in] Список команд для размещения на панели быстрого доступа.

bRecalcLayout
[in] TRUE Если вы хотите перераскрыть ленту после добавления элементов ленты; FALSE иначе.

Пример

В следующем примере показано, как использовать SetQuickAccessCommands метод в CMFCRibbonBar классе.

// Add quick access commands to the toolbar
CList<UINT, UINT> lstQATCmds;

lstQATCmds.AddTail(ID_FILE_NEW);
lstQATCmds.AddTail(ID_FILE_OPEN);
lstQATCmds.AddTail(ID_FILE_SAVE);
lstQATCmds.AddTail(ID_FILE_PRINT_DIRECT);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessCommands(lstQATCmds);

`CMFCRibbonBar::SetQuickAccessDefaultState`

Задает панель быстрого доступа к состоянию по умолчанию.

void SetQuickAccessDefaultState(const CMFCRibbonQuickAccessToolBarDefaultState& state);

Параметры

state
[in] Состояние панели быстрого доступа по умолчанию.

Замечания

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

Пример

В следующем примере показано, как использовать SetQuickAccessDefaultState метод в CMFCRibbonBar классе.

CMFCRibbonQuickAccessToolBarDefaultState *qaToolBarState =
    new CMFCRibbonQuickAccessToolBarDefaultState();
qaToolBarState->AddCommand(ID_FILE_NEW, true);
qaToolBarState->AddCommand(ID_FILE_OPEN, true);
// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessDefaultState(*qaToolBarState);

`CMFCRibbonBar::SetQuickAccessToolbarOnTop`

Помещает панель быстрого доступа выше или ниже панели ленты.

void SetQuickAccessToolbarOnTop(BOOL bOnTop);

Параметры

bOnTop
[in] TRUE чтобы разместить панель быстрого доступа над панелью ленты; FALSE чтобы разместить панель быстрого доступа под панелью ленты.

`CMFCRibbonBar::SetTooltipFixedWidth`

Задает обычные и большие размеры фиксированной ширины подсказки для панели ленты.

void SetTooltipFixedWidth(
    int nWidthRegular,
    int nWidthLargeImage);

Параметры

nWidthRegular
[in] Ширина (в пикселях) регулярной подсказки фиксированного размера.

nWidthLargeImage
[in] Ширина в пикселях подсказки большого размера.

Замечания

Установка параметра в значение 0 приводит к тому, что соответствующая ширина изменяется.

`CMFCRibbonBar::ShowCategory`

Отображает или скрывает указанную категорию ленты.

void ShowCategory(
    int nIndex,
    BOOL bShow=TRUE);

Параметры

nIndex
[in] Индекс категории ленты.

bShow
[in] Значение , если TRUEотображается категория ленты; в противном случае скрыта категория ленты.

`CMFCRibbonBar::ShowContextCategories`

Показывает или скрывает категории контекста с указанным идентификатором.

void ShowContextCategories(
    UINT uiContextID,
    BOOL bShow=TRUE);

Параметры

uiContextID
[in] Идентификатор категории контекста.

bShow
[in] Значение , если TRUEотображается категория с указанным идентификатором; в противном случае скрытие категорий с указанным идентификатором.

`CMFCRibbonBar::ShowKeyTips`

Отображает подсказки для каждого элемента ленты на панели ленты.

void ShowKeyTips();

Замечания

`CMFCRibbonBar::ToggleMimimizeState`

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

void ToggleMimimizeState();

Замечания

Ошибка в имени метода является известной проблемой.

В свернутом состоянии элемент управления лентой скрыт и отображаются только вкладки. Когда пользователь щелкает вкладку, элемент управления лентой отображается в виде всплывающего окна. Окно закрывается, когда пользователь щелкает или выполняет команду.

`CMFCRibbonBar::TranslateChar`

Определяет, обрабатывается ли указанный код символа нажатия клавиш строкой ленты.

virtual BOOL TranslateChar(UINT nChar);

Параметры

nChar
[in] Код символа нажатия клавиш пользователя.

Возвращаемое значение

TRUE Значение FALSE.

Замечания

Функция подсказки клавиш позволяет пользователям перемещаться по панели ленты с помощью клавиатуры.

`CMFCRibbonBar::GetFocused`

Возвращает элемент, имеющий фокус ввода.

virtual CMFCRibbonBaseElement* GetFocused();

Возвращаемое значение

Указатель на элемент с фокусом или NULL.

Замечания

`CMFCRibbonBar::IsWindows7Look`

Указывает, имеет ли лента внешний вид Windows 7 (небольшая прямоугольная кнопка приложения).

BOOL IsWindows7Look() const;

Возвращаемое значение

TRUE Значение , если лента имеет вид Windows 7; в противном случае FALSE.

Замечания

`CMFCRibbonBar::LoadFromResource`

Перегружен. Загружает панель ленты из ресурсов приложения.

virtual BOOL LoadFromResource(
    UINT uiXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

virtual BOOL LoadFromResource(
    LPCTSTR lpszXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

Параметры

uiXMLResID
Указывает идентификатор ресурса xml-строки с сведениями о панели ленты.

lpszResType
Указывает тип ресурса, расположенного по адресу uiXMLResID.

hInstance
Обработайте модуль, исполняемый файл которого содержит ресурс. Если hInstance это NULLтак, система загружает ресурс из модуля, который использовался для создания текущего процесса.

lpszXMLResID
Указывает идентификатор ресурса (в строковой форме) с сведениями о панели ленты.

Возвращаемое значение

TRUE Значение , если загрузка выполнена успешно; в противном случае FALSE.

Замечания

`CMFCRibbonBar::SaveToXMLBuffer`

Сохраняет панель ленты в буфер.

UINT SaveToXMLBuffer(LPBYTE* ppBuffer) const;

Параметры

ppBuffer
Когда эта функция возвращается, указывает на буфер, ppBuffer выделенный этим методом, и содержит сведения о панели ленты в формате XML.

Возвращаемое значение

Значение TRUE в случае успешного выполнения; в противном случае — значение FALSE.

Замечания

`CMFCRibbonBar::SaveToXMLFile`

Сохраняет панель ленты в XML-файл.

BOOL SaveToXMLFile(LPCTSTR lpszFilePath) const;

Параметры

lpszFilePath
Задает выходной файл.

Возвращаемое значение

Значение TRUE в случае успешного выполнения; в противном случае — значение FALSE.

Замечания

`CMFCRibbonBar::SetWindows7Look`

Включает или отключает внешний вид Windows 7 (небольшая прямоугольная кнопка приложения) для ленты.

void SetWindows7Look(
    BOOL bWindows7Look,
    BOOL bRecalc = TRUE);

Параметры

bWindows7Look
TRUE задает внешний вид Windows 7; FALSE иначе.

bRecalc
TRUE пересчитывает макет ленты; FALSE иначе.

Замечания

См. также

Диаграмма иерархии
Классы
CPane Класс
CMFCRibbonCategory Класс
CMFCRibbonPanel Класс
CMFCRibbonBaseElement Класс
Пошаговое руководство. Обновление приложения Scribble MFC

Поделиться через

Класс CMFCRibbonBar

Синтаксис

Участники

Открытые конструкторы

Открытые методы

Замечания

Иерархия наследования

Требования

CMFCRibbonBar::ActivateContextCategory

Параметры

Возвращаемое значение

CMFCRibbonBar::AddCategory

Параметры

Возвращаемое значение

Замечания

Пример

CMFCRibbonBar::AddContextCategory

Параметры

Возвращаемое значение

Замечания

CMFCRibbonBar::AddMainCategory

Параметры

Возвращаемое значение

Замечания

Пример

CMFCRibbonBar::AddPrintPreviewCategory

Возвращаемое значение

Замечания

CMFCRibbonBar::AddQATOnlyCategory

Параметры

Возвращаемое значение

Замечания

CMFCRibbonBar::AddToTabs

Параметры

Замечания

CMFCRibbonBar::CMFCRibbonBar

Параметры

Замечания

CMFCRibbonBar::Create

Параметры

Возвращаемое значение

Замечания

Пример

CMFCRibbonBar::CreateEx

Параметры

Возвращаемое значение

Замечания

CMFCRibbonBar::DeactivateKeyboardFocus

Параметры

Замечания

CMFCRibbonBar::DrawMenuImage

Параметры

Возвращаемое значение

Замечания

CMFCRibbonBar::DWMCompositionChanged

Замечания

CMFCRibbonBar::EnableKeyTips

Параметры

Замечания

CMFCRibbonBar::EnablePrintPreview

Параметры

Замечания

CMFCRibbonBar::EnableToolTips

Параметры

Замечания

CMFCRibbonBar::FindByData

Параметры

Возвращаемое значение

Замечания

CMFCRibbonBar::FindByID

Параметры

Возвращаемое значение

Замечания

CMFCRibbonBar::FindCategoryIndexByData

Параметры

Возвращаемое значение

CMFCRibbonBar::ForceRecalcLayout

Замечания

CMFCRibbonBar::GetActiveCategory

Класс `CMFCRibbonBar`

`CMFCRibbonBar::ActivateContextCategory`

`CMFCRibbonBar::AddCategory`

`CMFCRibbonBar::AddContextCategory`

`CMFCRibbonBar::AddMainCategory`

`CMFCRibbonBar::AddPrintPreviewCategory`

`CMFCRibbonBar::AddQATOnlyCategory`

`CMFCRibbonBar::AddToTabs`

`CMFCRibbonBar::CMFCRibbonBar`

`CMFCRibbonBar::Create`

`CMFCRibbonBar::CreateEx`

`CMFCRibbonBar::DeactivateKeyboardFocus`

`CMFCRibbonBar::DrawMenuImage`

`CMFCRibbonBar::DWMCompositionChanged`

`CMFCRibbonBar::EnableKeyTips`

`CMFCRibbonBar::EnablePrintPreview`

`CMFCRibbonBar::EnableToolTips`

`CMFCRibbonBar::FindByData`

`CMFCRibbonBar::FindByID`

`CMFCRibbonBar::FindCategoryIndexByData`

`CMFCRibbonBar::ForceRecalcLayout`

`CMFCRibbonBar::GetActiveCategory`

`CMFCRibbonBar::GetApplicationButton`

`CMFCRibbonBar::GetCaptionHeight`

`CMFCRibbonBar::GetCategory`

`CMFCRibbonBar::GetCategoryCount`

`CMFCRibbonBar::GetCategoryHeight`

`CMFCRibbonBar::GetCategoryIndex`

`CMFCRibbonBar::GetContextName`

`CMFCRibbonBar::GetDroppedDown`

`CMFCRibbonBar::GetElementsByID`

`CMFCRibbonBar::GetHideFlags`

`CMFCRibbonBar::GetItemIDsList`

`CMFCRibbonBar::GetKeyboardNavigationLevel`

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

`CMFCRibbonBar::GetKeyboardNavLevelParent`

`CMFCRibbonBar::GetMainCategory`

`CMFCRibbonBar::GetQATCommandsLocation`

`CMFCRibbonBar::GetQATDroppedDown`

`CMFCRibbonBar::GetQuickAccessCommands`

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

`CMFCRibbonBar::GetTabTrancateRatio`

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

`CMFCRibbonBar::GetVisibleCategoryCount`