Класс CMFCRibbonPanel

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

Дополнительные сведения см. в исходном коде, расположенном в папке VC\atlmfc\src\mfc установки Visual Studio.

Синтаксис

class CMFCRibbonPanel : public CObject

Участники

Защищенные конструкторы

Имя Описание
CMFCRibbonPanel::CMFCRibbonPanel Создает и инициализирует объект CMFCRibbonPanel.

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

Имя Описание
CMFCRibbonPanel::Add Добавляет элемент ленты на панель.
CMFCRibbonPanel::AddSeparator Добавляет разделитель на панель ленты.
CMFCRibbonPanel::AddToolBar Добавляет панель инструментов на панель ленты.
CMFCRibbonPanel::FindByData
CMFCRibbonPanel::FindByID Возвращает элемент, определяемый указанным идентификатором команды.
CMFCRibbonPanel::GetCaptionHeight
CMFCRibbonPanel::GetCount Возвращает количество элементов на панели ленты.
CMFCRibbonPanel::GetData Возвращает определяемые пользователем данные, связанные с панелью.
CMFCRibbonPanel::GetDefaultButton
CMFCRibbonPanel::GetDroppedDown
CMFCRibbonPanel::GetElement Возвращает элемент ленты, расположенный по указанному индексу.
CMFCRibbonPanel::GetElements Извлекает все элементы, содержащиеся на панели ленты.
CMFCRibbonPanel::GetElementsByID
CMFCRibbonPanel::GetFocused Возвращает элемент, имеющий фокус ввода.
CMFCRibbonPanel::GetGalleryRect Возвращает ограничивающий прямоугольник элемента Gallery.
CMFCRibbonPanel::GetHighlighted
CMFCRibbonPanel::GetIndex
CMFCRibbonPanel::GetItemIDsList
CMFCRibbonPanel::GetName
CMFCRibbonPanel::GetParentButton
CMFCRibbonPanel::GetParentCategory Возвращает родительскую категорию панели ленты.
CMFCRibbonPanel::GetParentMenuBar
CMFCRibbonPanel::GetPreferedMenuLocation
CMFCRibbonPanel::GetPressed
CMFCRibbonPanel::GetRect
CMFCRibbonPanel::GetVisibleElements Получает массив видимых элементов.
CMFCRibbonPanel::HasElement
CMFCRibbonPanel::HitTest
CMFCRibbonPanel::HitTestEx
CMFCRibbonPanel::Insert Вставляет элемент ленты в заданное положение.
CMFCRibbonPanel::InsertSeparator Вставляет разделитель в заданное положение.
CMFCRibbonPanel::IsCenterColumnVert Указывает, должны ли все элементы панели быть по центру (выровнены) по вертикали.
CMFCRibbonPanel::IsCollapsed
CMFCRibbonPanel::IsHighlighted
CMFCRibbonPanel::IsJustifyColumns Указывает, имеют ли все столбцы панели одинаковую ширину.
CMFCRibbonPanel::IsMainPanel
CMFCRibbonPanel::IsMenuMode
CMFCRibbonPanel::MakeGalleryItemVisible Прокручивает коллекцию, чтобы сделать указанный элемент ленты видимым.
CMFCRibbonPanel::OnKey
CMFCRibbonPanel::RecalcWidths
CMFCRibbonPanel::Remove Удаляет и при необходимости удаляет элемент, расположенный по указанному индексу.
CMFCRibbonPanel::RemoveAll Удаляет все элементы из панели ленты.
CMFCRibbonPanel::Replace Заменяет один элемент другим на основе соответствующих значений индекса.
CMFCRibbonPanel::ReplaceByID Заменяет один элемент другим на основе указанного идентификатора команды.
CMFCRibbonPanel::SetCenterColumnVert Упорядочивает панель для выравнивания элементов по вертикали по столбцам.
CMFCRibbonPanel::SetData Связывает пользовательские данные с панелью ленты.
CMFCRibbonPanel::SetElementMenu Назначает всплывающее меню элементу с заданным идентификатором команды.
CMFCRibbonPanel::SetElementRTC Добавляет элемент ленты, указанный предоставленными сведениями о классе среды выполнения, на панель ленты.
CMFCRibbonPanel::SetElementRTCByID Добавляет элемент ленты, указанный предоставленными сведениями о классе среды выполнения, на панель ленты.
CMFCRibbonPanel::SetFocused Задает фокус на указанный элемент ленты.
CMFCRibbonPanel::SetJustifyColumns Включает или отключает обоснование столбца.
CMFCRibbonPanel::SetKeys Задает сочетание клавиш, отображающее панель ленты.
CMFCRibbonPanel::ShowPopup

Замечания

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

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

Пример

В следующем примере показано, как настроить CMFCRibbonPanel объект с помощью различных методов в CMFCRibbonPanel классе. В примере показано, как задать сочетание клавиш, отображающее панель ленты, выровнять элементы в панели по вертикали по столбцу и включить обоснование столбца. Этот фрагмент кода является частью примера демонстрации MS Office 2007.

// CMFCRibbonCategory* pCategory
// CMFCToolBarImages m_PanelImages
CMFCRibbonPanel *pPanelClipboard = pCategory->AddPanel(_T("Clipboard"), m_PanelImages.ExtractIcon(1));
pPanelClipboard->SetKeys(_T("zc"));
pPanelClipboard->SetCenterColumnVert();
pPanelClipboard->SetJustifyColumns();

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

CObject

CMFCRibbonPanel

Требования

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

CMFCRibbonPanel::Add

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

virtual void Add(CMFCRibbonBaseElement* pElem);

Параметры

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

Замечания

CMFCRibbonPanel::AddSeparator

Добавляет разделитель на панель ленты.

virtual void AddSeparator();

Замечания

Вызовите этот метод, чтобы добавить разделитель на панель ленты. Разделитель будет добавлен рядом с элементом ленты, добавленным предыдущим вызовом CMFCRibbonPanel::Add. Чтобы вставить разделитель в заданной позиции, вызовите CMFCRibbonPanel::InsertSeparator.

CMFCRibbonPanel::AddToolBar

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

CMFCRibbonButtonsGroup* AddToolBar(
UINT uiToolbarResID,
UINT uiColdResID = 0,
UINT uiHotResID = 0,
UINT uiDisabledResID = 0);

Параметры

uiToolbarResID
[in] Указывает идентификатор ресурса добавляемой панели инструментов.

uiColdResID
[in] Указывает идентификатор ресурса холодных образов панели инструментов.

uiHotResID
[in] Указывает идентификатор ресурса горячих образов панели инструментов.

uiDisabledResID
[in] Указывает идентификатор ресурса отключенных изображений панели инструментов.

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

Вызовите этот метод, чтобы добавить панель инструментов на панель ленты. Панель инструментов будет добавлена рядом с элементом ленты, добавленным предыдущим вызовом CMFCRibbonPanel::Add.

Замечания

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

CMFCRibbonPanel::CMFCRibbonPanel

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

CMFCRibbonPanel(
LPCTSTR lpszName = NULL,
HICON hIcon = NULL);

CMFCRibbonPanel(CMFCRibbonGallery* pPaletteButton);

Параметры

lpszName
[in] Имя панели ленты.

hIcon
[in] Обработайте значок кнопки по умолчанию для панели ленты.

pPaletteButton
[in] Указатель на коллекцию лент для панели ленты.

CMFCRibbonPanel::FindByData

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

CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData) const;

Параметры

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

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

Указатель на элемент ленты, если метод выполнен успешно; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

CMFCRibbonPanel::FindByID

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

CMFCRibbonBaseElement* FindByID(UINT uiCmdID) const;

Параметры

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

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

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

CMFCRibbonPanel::GetCaptionHeight

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

int GetCaptionHeight() const;

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

Высота (в пикселях) подпись панели ленты.

Замечания

CMFCRibbonPanel::GetCount

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

int GetCount() const;

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

Количество элементов ленты, содержащихся на панели ленты.

CMFCRibbonPanel::GetData

Возвращает определяемые пользователем данные, связанные с панелью.

DWORD_PTR GetData() const;

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

Определяемые пользователем данные, связанные с панелью.

CMFCRibbonPanel::GetDefaultButton

Извлекает кнопку по умолчанию для панели ленты.

CMFCRibbonButton& GetDefaultButton();

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

Кнопка по умолчанию для панели ленты.

Замечания

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

CMFCRibbonPanel::GetDroppedDown

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

CMFCRibbonBaseElement* GetDroppedDown() const;

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

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

Замечания

Тестируются только элементы ленты, содержащиеся на панели ленты.

CMFCRibbonPanel::GetElement

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

CMFCRibbonBaseElement* GetElement(int nIndex) const;

Параметры

Nindex
[in] Указывает отсчитываемый от нуля индекс извлекаемого элемента.

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

Допустимый указатель на базовый элемент ленты, расположенный в позиции nIndex на панели ленты, или NULL, если в указанном индексе нет элемента.

CMFCRibbonPanel::GetElements

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

void GetElements(CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Параметры

arElements
[out] Массив для заполнения всеми элементами ленты, содержащимися на панели ленты.

Замечания

CMFCRibbonPanel::GetElementsByID

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

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

Параметры

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

arElements
[in] Массив элементов ленты.

Замечания

Тестируются только элементы ленты, содержащиеся на панели ленты.

CMFCRibbonPanel::GetHighlighted

Извлекает элемент ленты, выделенный на панели ленты.

CMFCRibbonBaseElement* GetHighlighted() const;

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

Указатель на элемент ленты, выделенный на панели ленты.

Замечания

CMFCRibbonPanel::GetIndex

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

virtual int GetIndex(CMFCRibbonBaseElement* pElem) const;

Параметры

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

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

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

Замечания

CMFCRibbonPanel::GetItemIDsList

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

void GetItemIDsList(CList<UINT, UINT>& lstItems) const;

Параметры

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

Замечания

CMFCRibbonPanel::GetName

Извлекает имя панели ленты.

LPCTSTR GetName() const;

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

Имя панели ленты.

Замечания

CMFCRibbonPanel::GetParentButton

CMFCRibbonBaseElement* GetParentButton() const;

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

Замечания

CMFCRibbonPanel::GetParentCategory

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

CMFCRibbonCategory* GetParentCategory() const;

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

Указатель на категорию ленты, содержащую эту панель ленты.

CMFCRibbonPanel::GetParentMenuBar

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

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

Замечания

CMFCRibbonPanel::GetPreferedMenuLocation

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

virtual BOOL GetPreferedMenuLocation(CRect& rect);

Параметры

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

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

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

Замечания

Этот метод всегда возвращает ЗНАЧЕНИЕ FALSE. Переопределите этот метод, чтобы получить предпочтительный прямоугольник отображения для всплывающего меню панели ленты.

CMFCRibbonPanel::GetPressed

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

CMFCRibbonBaseElement* GetPressed() const;

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

Указатель на элемент ленты, если пользователь в данный момент нажимает его; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

CMFCRibbonPanel::GetRect

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

const CRect& GetRect() const;

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

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

Замечания

CMFCRibbonPanel::HasElement

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

BOOL HasElement(const CMFCRibbonBaseElement* pElem) const;

Параметры

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

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

ЗНАЧЕНИЕ TRUE, если панель ленты содержит указанный элемент ленты; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonPanel::Highlight

Задает цвет выделения для выбранной панели ленты и для элемента ленты, указанного точкой.

virtual void Highlight(
BOOL bHighlight,
CPoint point);

Параметры

bHighlight
[in] ЗНАЧЕНИЕ TRUE, чтобы выделить панель ленты; Значение FALSE для разбиять панель ленты.

point
[in] Координаты x и y указателя относительно левого верхнего угла окна.

Замечания

CMFCRibbonPanel::HitTest

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

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

Параметры

point
[in] Координаты x и y указателя относительно левого верхнего угла окна.

bCheckPanelCaption
[in] Значение TRUE для проверки подпись панели ленты; в противном случае — ЗНАЧЕНИЕ FALSE.

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

Указатель на элемент ленты, если в нем находится указанная точка; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

Тестируются только элементы ленты, содержащиеся на панели ленты.

CMFCRibbonPanel::HitTestEx

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

virtual int HitTestEx(CPoint point) const;

Параметры

point
[in] Координаты x и y указателя относительно левого верхнего угла окна.

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

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

Замечания

Тестируются только элементы ленты, содержащиеся на панели ленты.

CMFCRibbonPanel::Insert

Вставляет указанный элемент ленты в указанное положение в массив элементов ленты, содержащихся на панели ленты.

virtual BOOL Insert(
CMFCRibbonBaseElement* pElem,
int nIndex);

Параметры

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

Nindex
[in] Отсчитываемое от нуля значение от -1 до количества элементов ленты, содержащихся в массиве.

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

ЗНАЧЕНИЕ TRUE, если элемент ленты был успешно вставлен; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

Если значение nIndex равно -1 или nIndex равно числу элементов ленты в массиве, то указанный элемент ленты добавляется в конец массива. Если значение nIndex выходит за пределы диапазона, метод завершится ошибкой.

CMFCRibbonPanel::InsertSeparator

Вставляет разделитель в заданное положение.

virtual BOOL InsertSeparator(int nIndex);

Параметры

Nindex
[in] Указывает отсчитываемый от нуля индекс, в который вставляется разделитель.

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

ЗНАЧЕНИЕ TRUE, если разделитель успешно вставлен; в противном случае — ЗНАЧЕНИЕ FALSE.

Замечания

Вызовите этот метод для вставки разделителя в положение, указанное nIndex. Чтобы вставить разделитель рядом с последним добавленным элементом ленты, вызовите CMFCRibbonPanel::AddSeparator.

CMFCRibbonPanel::IsCenterColumnVert

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

BOOL IsCenterColumnVert() const;

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

ЗНАЧЕНИЕ TRUE, если вертикальные позиции элементов ленты расположены в прямоугольнике отображения; в противном случае ЗНАЧЕНИЕ FALSE.

CMFCRibbonPanel::IsCollapsed

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

BOOL IsCollapsed() const;

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

ЗНАЧЕНИЕ TRUE, если размер дисплея панели ленты свернут в горизонтальном направлении; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

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

CMFCRibbonPanel::IsHighlighted

Указывает, выделен ли экран панели ленты.

BOOL IsHighlighted() const;

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

ЗНАЧЕНИЕ TRUE, если выделено отображение панели ленты; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

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

CMFCRibbonPanel::IsJustifyColumns

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

BOOL IsJustifyColumns() const;

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

ЗНАЧЕНИЕ TRUE, если размеры отображаемых элементов ленты, которые находятся в одном столбце на панели ленты, имеют одинаковую ширину; в противном случае ЗНАЧЕНИЕ FALSE.

CMFCRibbonPanel::IsMainPanel

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

virtual BOOL IsMainPanel() const;

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

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

Замечания

Этот метод всегда возвращает ЗНАЧЕНИЕ FALSE. Переопределите этот метод, чтобы указать, является ли панель ленты главной панелью ленты.

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

CMFCRibbonPanel::IsMenuMode

BOOL IsMenuMode() const;

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

Замечания

CMFCRibbonPanel::OnKey

virtual BOOL OnKey(UINT nChar);

Параметры

[in] Nchar

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

Замечания

CMFCRibbonPanel::RecalcWidths

Пересчитывает ширину каждой конфигурации макета отображения для панели ленты.

virtual void RecalcWidths(
CDC* pDC,
int nHeight);

Параметры

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

nHeight
[in] Высота панели ленты.

Замечания

Панель ленты изменяет конфигурацию макета по мере изменения доступной ширины.

CMFCRibbonPanel::Remove

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

BOOL Remove(
int nIndex,
BOOL bDelete = TRUE);

Параметры

Nindex
[in] Указывает отсчитываемый от нуля индекс элемента, который удаляется из панели ленты.

bDelete
[in] ЗНАЧЕНИЕ TRUE для удаления элемента; в противном случае — ЗНАЧЕНИЕ FALSE.

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

ЗНАЧЕНИЕ TRUE, если элемент удален и удален (если bDelete имеет значение TRUE); ЗНАЧЕНИЕ FALSE, если элемент не был удален или отсутствует элемент ленты, расположенный в nIndex.

Замечания

Вызовите этот метод, чтобы удалить элемент из панели ленты.

CMFCRibbonPanel::RemoveAll

Удаляет все элементы ленты на панели ленты.

void RemoveAll();

Замечания

Все элементы ленты удаляются с панели ленты и уничтожаются.

CMFCRibbonPanel::Replace

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

BOOL Replace(
int nIndex,
CMFCRibbonBaseElement* pElem);

Параметры

Nindex
[in] Указывает отсчитываемый от нуля индекс элемента для замены.

pElem
[in, out] Допустимый указатель на элемент, заменяющий исходный элемент.

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

ЗНАЧЕНИЕ TRUE, если исходный элемент ленты был успешно заменен новым элементом ленты; ЗНАЧЕНИЕ FALSE, если элемент ленты не был заменен или отсутствует элемент в указанном индексе.

Замечания

Чтобы заменить элемент ленты идентификатором команды, вызовите CMFCRibbonPanel::ReplaceByID.

CMFCRibbonPanel::ReplaceByID

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

BOOL ReplaceByID(
UINT uiCmdID,
CMFCRibbonBaseElement* pElem);

Параметры

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

pElem
[in, out] Допустимый указатель на элемент, заменяющий исходный элемент.

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

ЗНАЧЕНИЕ TRUE, если исходный элемент ленты был успешно заменен новым элементом ленты; ЗНАЧЕНИЕ FALSE, если элемент ленты не был заменен или не существует элемента с указанным идентификатором команды.

Замечания

Чтобы заменить элемент ленты на основе позиции, вызовите CMFCRibbonPanel::Replace.

CMFCRibbonPanel::SetCenterColumnVert

Включает или отключает центрирование вертикальных позиций элементов ленты в прямоугольнике отображения.

void SetCenterColumnVert(BOOL bSet = TRUE);

Параметры

bSet
[in] ЗНАЧЕНИЕ TRUE для центра вертикальных позиций элементов ленты в прямоугольнике отображения; ЗНАЧЕНИЕ FALSE, чтобы отключить эту функцию.

Замечания

CMFCRibbonPanel::SetData

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

void SetData(DWORD_PTR dwData);

Параметры

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

Замечания

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

CMFCRibbonPanel::SetElementMenu

Назначает всплывающее меню элементу с заданным идентификатором команды.

BOOL SetElementMenu(
UINT uiCmdID,
HMENU hMenu,
BOOL bIsDefautCommand = FALSE,
BOOL bRightAlign = FALSE);

BOOL SetElementMenu(
UINT uiCmdID,
UINT uiMenuResID,
BOOL bIsDefautCommand = FALSE,
BOOL bRightAlign = FALSE);

Параметры

uiCmdID
[in] Указывает идентификатор команды элемента ленты, в котором добавляется меню.

hMenu
[in] Задает дескриптор в меню Windows, добавляемого на панель ленты.

bIsDefautCommand
[in] Значение TRUE, чтобы указать, что команда, связанная с элементом ленты, должна выполняться, если элемент ленты щелкается. В этом случае меню открывается только в том случае, если пользователь щелкает стрелку рядом с элементом ленты. Значение FALSE, чтобы указать, что команда, связанная с элементом ленты, не должна выполняться, если элемент ленты щелкается. В этом случае всплывающее меню отображается независимо от того, где пользователь щелкает элемент.

bRightAlign
[in] ЗНАЧЕНИЕ TRUE, чтобы указать, что всплывающее меню выровнено по правому краю; в противном случае — ЗНАЧЕНИЕ FALSE.

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

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

ЗНАЧЕНИЕ TRUE, если меню назначено элементу ленты; в противном случае — ЗНАЧЕНИЕ FALSE.

Замечания

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

CMFCRibbonPanel::SetElementRTC

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

CMFCRibbonBaseElement* SetElementRTC(
int nIndex,
CRuntimeClass* pRTC);

Параметры

Nindex
[in] Указывает отсчитываемый от нуля индекс добавляемого элемента ленты.

pRTC
[in, out] Указатель на сведения о классе среды выполнения для элемента ленты, добавленного на панель ленты.

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

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

Замечания

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

CMFCRibbonPanel::SetElementRTCByID

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

CMFCRibbonBaseElement* SetElementRTCByID(
UINT uiCmdID,
CRuntimeClass* pRTC);

Параметры

uiCmdID
[in] Указывает идентификатор команды добавляемого элемента ленты.

pRTC
[in, out] Указатель на сведения о классе среды выполнения, связанные с элементом ленты, добавленным на панель ленты.

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

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

Замечания

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

Пример

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

// Load and add toolbar with standard buttons. This toolbar
// should display a custom color button with id ID_CHAR_COLOR:

pPanel->AddToolBar(IDR_MAINFRAME,
    IDB_MAINFRAME256);

CMFCRibbonColorButton* pColorButton =
(CMFCRibbonColorButton*)pPanel->SetElementRTCByID(
ID_CHAR_COLOR,
    RUNTIME_CLASS (CMFCRibbonColorButton));

// SetElementRTCByID sets runtime class and returns a pointer
// to the newly created custom button,
    which can be set up immediately:
pColorButton->EnableAutomaticButton(_T("Automatic"),
    RGB (0,
    0,
    0));

CMFCRibbonPanel::SetJustifyColumns

Включает или отключает корректировку ширины элементов ленты в одном столбце.

void SetJustifyColumns(BOOL bSet = TRUE);

Параметры

bSet
[in] ЗНАЧЕНИЕ TRUE, чтобы изменить ширину элементов ленты в том же столбце на ширину самого большого элемента ленты в столбце; Значение FALSE, чтобы отключить эту настройку ширины.

Замечания

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

CMFCRibbonPanel::SetKeys

Задает подсказку для кнопки по умолчанию панели ленты.

void SetKeys(LPCTSTR lpszKeys);

Параметры

lpszKeys
[in] Подсказка для кнопки по умолчанию панели ленты.

Замечания

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

CMFCRibbonPanel::ShowPopup

Создает и отображает всплывающее меню для панели ленты.

CMFCRibbonPanelMenu* ShowPopup(CMFCRibbonDefaultPanelButton* pButton = NULL);

Параметры

pButton
[in] Указатель на кнопку по умолчанию для панели ленты.

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

Указатель на всплывающее меню для панели ленты, если метод выполнен успешно; в противном случае ЗНАЧЕНИЕ NULL.

Замечания

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

CMFCRibbonPanel::SetFocused

Задает фокус на указанный элемент ленты.

void SetFocused(CMFCRibbonBaseElement* pNewFocus);

Параметры

pNewFocus
Указатель на элемент ленты, который получает фокус.

Замечания

CMFCRibbonPanel::MakeGalleryItemVisible

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

void MakeGalleryItemVisible(CMFCRibbonBaseElement* pItem);

Параметры

pItem
Указатель на элемент ленты для отображения.

Замечания

CMFCRibbonPanel::IsWindows7Look

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

BOOL IsWindows7Look() const;

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

ЗНАЧЕНИЕ TRUE, если родительская лента имеет вид Windows 7; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonPanel::GetVisibleElements

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

void GetVisibleElements(
CArray<CMFCRibbonBaseElement*,
CMFCRibbonBaseElement*>& arElements);

Параметры

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

Замечания

CMFCRibbonPanel::GetGalleryRect

Возвращает ограничивающий прямоугольник элемента Коллекции.

CRect GetGalleryRect();

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

Размер и положение элемента Коллекции на этой панели.

Замечания

CMFCRibbonPanel::GetFocused

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

CMFCRibbonBaseElement* GetFocused() const;

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

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

Замечания

См. также

Диаграмма иерархии
Классы
Класс CObject
Класс CMFCRibbonCategory
Класс CMFCRibbonBaseElement