Класс CMFCRibbonBaseElement

Статья
10/12/2023

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

Синтаксис

class CMFCRibbonBaseElement : public CObject

Участники

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

Имя	Описание
`CMFCRibbonBaseElement`	Формирует объект `CMFCRibbonBaseElement`.

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

Имя	Описание
CMFCRibbonBaseElement::AddToKeyList	Добавляет подсказку для элемента ленты в массив подсказок ключей.
CMFCRibbonBaseElement::AddToListBox	Добавляет элемент ленты в указанное поле списка команд ленты.
CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar	Указывает, можно ли добавить элемент ленты на панель быстрого доступа.
CMFCRibbonBaseElement::CanBeCompacted	Указывает, может ли размер элемента ленты быть компактным.
CMFCRibbonBaseElement::CanBeStretched	Указывает, может ли высота элемента ленты увеличиваться вертикально до высоты строки ленты.
CMFCRibbonBaseElement::CanBeStretchedHorizontally	Указывает, может ли измениться ширина элемента ленты.
CMFCRibbonBaseElement::CleanUpSizes	Очищает параметры измерения для элемента ленты.
CMFCRibbonBaseElement::ClosePopupMenu	Закрывает всплывающее меню для элемента ленты.
CMFCRibbonBaseElement::CopyFrom	Копирует состояние указанного `CMFCRibbonBaseElement` объекта в текущий объект.
CMFCRibbonBaseElement::D ebergctrl	Уничтожает элемент ленты.
CMFCRibbonBaseElement::D rawImage	Рисует изображение элемента ленты.
CMFCRibbonBaseElement::Find	Возвращает указанный указатель на элемент ленты, если он указывает на текущий объект.
CMFCRibbonBaseElement::FindByData	Извлекает указатель на элемент ленты, если он содержит указанные данные.
CMFCRibbonBaseElement::FindByID	Извлекает указатель на элемент ленты, если этот элемент определяется указанным идентификатором команды.
CMFCRibbonBaseElement::FindByOriginal	Извлекает указатель на элемент ленты, если его исходный элемент ленты соответствует указанному элементу ленты.
CMFCRibbonBaseElement::GetCompactSize	Возвращает компактный размер элемента ленты.
CMFCRibbonBaseElement::GetData	Извлекает определяемые пользователем данные, связанные с элементом ленты.
CMFCRibbonBaseElement::GetDescription	Возвращает описание элемента ленты.
CMFCRibbonBaseElement::GetDroppedDown	Извлекает указатель на элемент ленты, если его всплывающее меню удаляется вниз.
CMFCRibbonBaseElement::GetElements	Добавляет текущий элемент ленты в указанный массив.
CMFCRibbonBaseElement::GetElementsByID	Добавляет текущий элемент ленты в указанный массив, если текущий элемент ленты содержит указанный идентификатор команды.
CMFCRibbonBaseElement::GetHighlighted	Извлекает указатель на элемент ленты, если он выделен.
CMFCRibbonBaseElement::GetID	Возвращает идентификатор команды элемента ленты.
CMFCRibbonBaseElement::GetImageSize	Возвращает размер изображения элемента ленты.
CMFCRibbonBaseElement::GetIntermediateSize	Возвращает размер элемента ленты в промежуточное состояние.
CMFCRibbonBaseElement::GetKeys	Возвращает подсказку ключа, связанную с элементом ленты.
CMFCRibbonBaseElement::GetKeyTipRect	Извлекает прямоугольник границы ключа для элемента ленты.
CMFCRibbonBaseElement::GetKeyTipSize	Извлекает размер текста подсказки.
CMFCRibbonBaseElement::GetLocationInGroup	Указывает расположение отображения элемента ленты в группе ленты.
CMFCRibbonBaseElement::GetMenuKeys	Возвращает подсказки ключей, связанные с кнопкой.
CMFCRibbonBaseElement::GetNotifyID	Извлекает идентификатор команды уведомления для элемента ленты.
CMFCRibbonBaseElement::GetOriginal	Извлекает исходный элемент ленты.
CMFCRibbonBaseElement::GetParentCategory	Извлекает категорию ленты для элемента ленты.
CMFCRibbonBaseElement::GetParentPanel	Извлекает панель ленты, содержащую элемент ленты.
CMFCRibbonBaseElement::GetParentRibbonBar	Извлекает родительскую панель ленты для элемента ленты.
CMFCRibbonBaseElement::GetParentWnd	Извлекает родительское окно для элемента ленты.
CMFCRibbonBaseElement::GetPressed	Извлекает указатель на элемент ленты, если пользователь в данный момент нажимает его.
CMFCRibbonBaseElement::GetQuickAccessToolBarID	Извлекает идентификатор команды элемента ленты при его расположении на панели быстрого доступа.
CMFCRibbonBaseElement::GetRect	Возвращает ограничивающий прямоугольник элемента ленты.
CMFCRibbonBaseElement::GetRegularSize	Возвращает стандартный размер элемента ленты.
CMFCRibbonBaseElement::GetSize	Возвращает текущий размер элемента ленты.
CMFCRibbonBaseElement::GetText	Возвращает текст, связанный с элементом ленты.
CMFCRibbonBaseElement::GetToolTipText	Возвращает текст всплывающей подсказки элемента ленты.
CMFCRibbonBaseElement::GetTopLevelRibbonBar	Извлекает панель ленты верхнего уровня для элемента ленты.
CMFCRibbonBaseElement::HasCompactMode	Задает, доступен ли для элемента ленты компактный режим.
CMFCRibbonBaseElement::HasFocus	Указывает, имеет ли родительский элемент фокус клавиатуры.
CMFCRibbonBaseElement::HasIntermediateMode	Задает, доступен ли для элемента ленты промежуточный режим.
CMFCRibbonBaseElement::HasLargeMode	Указывает, имеет ли элемент ленты большой режим.
CMFCRibbonBaseElement::HasMenu	Указывает, имеет ли элемент ленты меню.
CMFCRibbonBaseElement::HitTest	Извлекает указатель на элемент ленты, если указанная точка находится в ней.
CMFCRibbonBaseElement::IsAlignByColumn	Указывает, выравнивается ли элемент ленты по вертикали с другими элементами ленты.
CMFCRibbonBaseElement::IsAlwaysLargeImage	Указывает, всегда ли размер изображения элемента ленты велик.
CMFCRibbonBaseElement::IsAutoRepeatMode	Указывает, находится ли элемент ленты в режиме автоматического повтора.
CMFCRibbonBaseElement::IsChecked	Указывает, проверяется ли элемент ленты.
CMFCRibbonBaseElement::IsCompactMode	Указывает, находится ли элемент ленты в компактном режиме.
CMFCRibbonBaseElement::IsDefaultMenuLook
CMFCRibbonBaseElement::IsDisabled	Указывает, отключен ли элемент ленты.
CMFCRibbonBaseElement::IsDroppedDown	Определяет, отображает ли элемент ленты всплывающее меню и удаляется.
CMFCRibbonBaseElement::IsFocused	Указывает, имеет ли элемент ленты фокус.
CMFCRibbonBaseElement::IsGalleryIcon	Указывает, содержится ли элемент ленты в коллекции лент.
CMFCRibbonBaseElement::IsHighlighted	Указывает, выделен ли элемент ленты.
CMFCRibbonBaseElement::IsIntermediateMode	Указывает, является ли текущий образ элемента ленты промежуточным размером.
CMFCRibbonBaseElement::IsLargeMode	Указывает, имеет ли текущий образ для элемента ленты большой размер.
CMFCRibbonBaseElement::IsMenuMode	Указывает, содержится ли элемент ленты в меню.
CMFCRibbonBaseElement::IsPressed	Указывает, щелкнул ли пользователь элемент ленты.
CMFCRibbonBaseElement::IsQATMode	Указывает, содержится ли элемент ленты на панели быстрого доступа.
CMFCRibbonBaseElement::IsSeparator	Указывает, является ли элемент ленты разделителем отображения.
CMFCRibbonBaseElement::IsShowGroupBorder	Указывает, содержится ли элемент ленты в группе, отображающей общую границу.
CMFCRibbonBaseElement::IsShowTooltipOnBottom	Указывает, отображается ли подсказка под элементом ленты.
CMFCRibbonBaseElement::IsTabStop	Указывает, можно ли выбрать элемент ленты с помощью клавиатуры.
CMFCRibbonBaseElement::IsTextAlwaysOnRight	Указывает, отображается ли текст элемента ленты справа.
CMFCRibbonBaseElement::IsVisible	Указывает, отображается ли элемент ленты в данный момент.
CMFCRibbonBaseElement::IsWholeRowHeight	Указывает, совпадает ли размер экрана элемента ленты с высотой отображения панели ленты, содержащей ее.
CMFCRibbonBaseElement::NotifyCommand	Отправляет уведомление команды в родительское окно элемента ленты.
CMFCRibbonBaseElement::NotifyHighlightListItem	Уведомляет родительское окно панели ленты, когда пользователь выделяет элемент ленты, расположенный в списке.
CMFCRibbonBaseElement::OnAddToQAToolbar	Добавляет элемент ленты на указанную панель быстрого доступа.
CMFCRibbonBaseElement::OnAfterChangeRect	Обновляет подсказку для элемента ленты.
CMFCRibbonBaseElement::OnAutoRepeat	Обновляет элемент ленты в ответ на устойчивые входные данные пользователя.
CMFCRibbonBaseElement::OnCalcTextSize	Вычисляет размер текста для элемента ленты.
CMFCRibbonBaseElement::OnChangeMenuHighlight	Вызывается платформой при изменении выделения элемента ленты, расположенного в меню.
CMFCRibbonBaseElement::OnDraw	Вызывается платформой для отрисовки элемента ленты.
CMFCRibbonBaseElement::OnDrawKeyTip	Вызывается платформой для рисования подсказки для элемента ленты.
CMFCRibbonBaseElement::OnDrawMenuImage	Вызывается платформой при рисовании изображения меню для элемента ленты.
CMFCRibbonBaseElement::OnDrawOnList	Вызывается платформой для рисования элемента ленты в поле списка команд.
CMFCRibbonBaseElement::OnKey	Вызывается платформой, когда пользователь нажимает подсказку, а элемент ленты имеет фокус.
CMFCRibbonBaseElement::OnMenuKey
CMFCRibbonBaseElement::OnRTLChanged	Вызывается платформой при изменении направления макета.
CMFCRibbonBaseElement::OnShow	Вызывается платформой для отображения или скрытия элемента ленты.
CMFCRibbonBaseElement::OnShowPopupMenu	Вызывается платформой, когда элемент ленты будет отображать всплывающее меню.
CMFCRibbonBaseElement::P ostMenuCommand
CMFCRibbonBaseElement::Redraw	Обновляет отображение элемента ленты.
CMFCRibbonBaseElement::SetACCData	Задает данные специальных возможностей для элемента ленты.
CMFCRibbonBaseElement::SetCompactMode	Задает размер дисплея для элемента ленты.
CMFCRibbonBaseElement::SetData	Связывает элемент данных с элементом ленты.
CMFCRibbonBaseElement::SetDefaultMenuLook
CMFCRibbonBaseElement::SetDescription	Задает описание элемента ленты.
CMFCRibbonBaseElement::SetID	Задает идентификатор команды элемента ленты.
CMFCRibbonBaseElement::SetInitialMode	Задает начальный размер отображения элемента ленты.
CMFCRibbonBaseElement::SetKeys	Задает подсказку для элемента ленты.
CMFCRibbonBaseElement::SetOriginal	Задает исходный элемент ленты для элемента ленты.
CMFCRibbonBaseElement::SetParentCategory	Задает родительскую категорию для элемента ленты.
CMFCRibbonBaseElement::SetParentMenu	Задает контейнер родительского меню для элемента ленты.
CMFCRibbonBaseElement::SetParentRibbonBar	Задает родительскую панель ленты для элемента ленты.
CMFCRibbonBaseElement::SetRect	Задает размеры прямоугольника для элемента ленты.
CMFCRibbonBaseElement::SetText	Задает текст элемента ленты.
CMFCRibbonBaseElement::SetTextAlwaysOnRight	Задает текст для элемента ленты, отображаемого справа.
CMFCRibbonBaseElement::SetToolTipText	Задает текст подсказки для элемента ленты.
CMFCRibbonBaseElement::SetVisible	Задает состояние видимости элемента ленты.
CMFCRibbonBaseElement::StretchHorizontally	Растяжение ширины элемента ленты.
CMFCRibbonBaseElement::StretchToWholeRow	Изменяет высоту отображения элемента ленты на указанную высоту строки.
CMFCRibbonBaseElement::UpdateTooltipInfo	Обновляет текст подсказки с помощью ресурса команды для элемента ленты.

Защищенные методы

Имя	Описание
CMFCRibbonBaseElement::OnProcessKey	Вызывается платформой, когда пользователь нажимает ярлык.
CMFCRibbonBaseElement::OnSetFocus	Вызывается платформой, когда элемент ленты получает или теряет фокус ввода.

Замечания

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

Размер изображения элемента ленты определяется элементом RibbonImageType , который может быть одним из следующих значений:

RibbonImageLarge
RibbonImageSmall

В зависимости от его размера элемент ленты отображает небольшое или большое изображение.

Пример

В приведенном ниже примере демонстрируется использование различных методов класса CMFCRibbonBaseElement . В примере показано, как получить CMFCRibbonBaseElement объект из CMFCRibbonStatusBar класса, задать описание элемента ленты, задать текст, задать подсказку и задать текст подсказки для элемента ленты. Этот фрагмент кода входит в состав примера Draw Client.

// CMFCRibbonStatusBar m_wndStatusBar
CMFCRibbonBaseElement *pPane = m_wndStatusBar.FindByID(nID);

pPane->SetDescription(_T("a pane"));
// CString strText
pPane->SetText(strText);
pPane->SetKeys(_T("p"));
pPane->SetToolTipText(_T("this is a pane"));

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

CObject

CMFCRibbonBaseElement

Требования

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

CMFCRibbonBaseElement::AddToKeyList

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

virtual void AddToKeyList(
    CArray<CMFCRibbonKeyTip*, CMFCRibbonKeyTip*>& arElems);

Параметры

arElems
[in] Ссылка на CArray подсказок ключей.

Замечания

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

CMFCRibbonBaseElement::AddToListBox

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

virtual int AddToListBox(
    CMFCRibbonCommandsListBox* pWndListBox,
    BOOL bDeep);

Параметры

pWndListBox
[in] Указатель на поле списка команд.

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

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

Отсчитываемый от нуля индекс добавленного элемента ленты.

Замечания

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

CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar

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

virtual BOOL CanBeAddedToQuickAccessToolBar() const;

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

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

Замечания

CMFCRibbonBaseElement::CanBeCompacted

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

virtual BOOL CanBeCompacted() const;

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

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

Замечания

Размер элемента ленты может быть компактным, промежуточным или большим.

CMFCRibbonBaseElement::CanBeStretched

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

virtual BOOL CanBeStretched();

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

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

Замечания

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

CMFCRibbonBaseElement::CanBeStretchedHorizontally

Указывает, может ли измениться ширина элемента ленты.

virtual BOOL CanBeStretchedHorizontally();

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

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

Замечания

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

CMFCRibbonBaseElement::CleanUpSizes

Очищает параметры измерения для элемента ленты.

virtual void CleanUpSizes();

Замечания

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

CMFCRibbonBaseElement::ClosePopupMenu

Закрывает всплывающее меню для элемента ленты.

virtual void ClosePopupMenu();

Замечания

CMFCRibbonBaseElement::CopyFrom

Копирует состояние указанного CMFCRibbonBaseElement в текущий объект.

virtual void CopyFrom(const CMFCRibbonBaseElement& src);

Параметры

src
[in] Исходный объект CMFCRibbonBaseElement .

Замечания

CMFCRibbonBaseElement::D ebergctrl

Уничтожает элемент ленты.

virtual void DestroyCtrl();

Замечания

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

CMFCRibbonBaseElement::D rawImage

Рисует изображение элемента ленты.

virtual void DrawImage(
    CDC* pDC,
    RibbonImageType type,
    CRect rectImage);

Параметры

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

type
[in] Перечисленное значение типа изображения. Список возможных значений см. в разделе "Примечания".

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

Замечания

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

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

значение	Описание
`RibbonImageLarge`	Размер изображения большого размера пикселя 32x32.
`RibbonImageSmall`	Небольшой размер изображения пикселей размером 16x16.

CMFCRibbonBaseElement::Find

Возвращает указанный указатель, если он указывает на текущий объект.

virtual CMFCRibbonBaseElement* Find(const CMFCRibbonBaseElement* pElement);

Параметры

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

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

Указатель на элемент ленты, если pElement указывает на текущий объект; в противном случае — ЗНАЧЕНИЕ NULL.

Замечания

CMFCRibbonBaseElement::FindByData

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

virtual CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData);

Параметры

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

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

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

Замечания

CMFCRibbonBaseElement::FindByID

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

virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);

Параметры

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

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

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

Замечания

CMFCRibbonBaseElement::FindByOriginal

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

virtual CMFCRibbonBaseElement* FindByOriginal(CMFCRibbonBaseElement* pOriginal);

Параметры

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

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

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

Замечания

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

CMFCRibbonBaseElement::GetCompactSize

Возвращает компактный размер элемента ленты.

virtual CSize GetCompactSize(CDC* pDC);

Параметры

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

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

Компактный размер элемента ленты.

Примечание.

Компактный размер означает, что элемент ленты усечен (он отображает небольшое изображение или изображение без текста).

CMFCRibbonBaseElement::GetData

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

DWORD_PTR GetData() const;

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

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

CMFCRibbonBaseElement::GetDescription

Возвращает описание элемента ленты.

virtual CString GetDescription() const;

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

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

CMFCRibbonBaseElement::GetDroppedDown

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

virtual CMFCRibbonBaseElement* GetDroppedDown();

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

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

Замечания

CMFCRibbonBaseElement::GetElements

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

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

Параметры

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

Замечания

CMFCRibbonBaseElement::GetElementsByID

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

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

Параметры

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

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

Замечания

CMFCRibbonBaseElement::GetHighlighted

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

virtual CMFCRibbonBaseElement* GetHighlighted();

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

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

Замечания

CMFCRibbonBaseElement::GetID

Возвращает идентификатор команды элемента ленты.

UINT GetID() const;

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

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

CMFCRibbonBaseElement::GetImageSize

Возвращает размер изображения элемента ленты.

virtual CSize GetImageSize(RibbonImageType R) const;

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

Размер изображения элемента ленты.

CMFCRibbonBaseElement::GetIntermediateSize

Возвращает размер элемента ленты в промежуточное состояние.

virtual CSize GetIntermediateSize(CDC* pDC);

Параметры

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

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

Размер элемента ленты в его промежуточном состоянии.

CMFCRibbonBaseElement::GetKeys

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

LPCTSTR GetKeys() const;

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

Подсказка, связанная с элементом ленты.

CMFCRibbonBaseElement::GetKeyTipRect

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

virtual CRect GetKeyTipRect(
    CDC* pDC,
    BOOL bIsMenu);

Параметры

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

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

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

Всегда возвращает прямоугольник с 0 значениями.

Замечания

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

CMFCRibbonBaseElement::GetKeyTipSize

Извлекает размер текста подсказки.

virtual CSize GetKeyTipSize(CDC* pDC);

Параметры

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

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

Размер текста подсказки.

Замечания

CMFCRibbonBaseElement::GetLocationInGroup

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

RibbonElementLocation GetLocationInGroup() const;

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

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

значение	Описание
`RibbonElementNotInGroup`	Элемент ленты не содержится в группе ленты.
`RibbonElementSingleInGroup`	Элемент ленты отображается как единственный элемент в группе ленты.
`RibbonElementFirstInGroup`	Элемент ленты отображается в левом конце группы ленты.
`RibbonElementLastInGroup`	Элемент ленты отображается в правом конце группы ленты.
`RibbonElementMiddleInGroup`	Элемент ленты не отображается в любой части группы ленты.

Замечания

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

CMFCRibbonBaseElement::GetMenuKeys

Возвращает подсказку меню для элемента ленты.

LPCTSTR GetMenuKeys() const;

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

Подсказка меню, связанная с элементом ленты.

Замечания

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

CMFCRibbonBaseElement::GetNotifyID

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

virtual UINT GetNotifyID();

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

Идентификатор команды уведомления.

Замечания

CMFCRibbonBaseElement::GetOriginal

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

CMFCRibbonBaseElement* GetOriginal() const;

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

Указатель на исходный элемент ленты.

Замечания

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

CMFCRibbonBaseElement::GetParentCategory

Извлекает категорию ленты для элемента ленты.

CMFCRibbonCategory* GetParentCategory() const;

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

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

Замечания

CMFCRibbonBaseElement::GetParentPanel

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

virtual CMFCRibbonPanel* GetParentPanel() const;

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

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

Замечания

CMFCRibbonBaseElement::GetParentRibbonBar

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

CMFCRibbonBar* GetParentRibbonBar() const;

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

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

Замечания

CMFCRibbonBaseElement::GetParentWnd

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

virtual CWnd* GetParentWnd() const;

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

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

Замечания

Родительское окно элемента ленты — класс CMFCRibbonBar или CMFCRibbonPanelMenuBar.

CMFCRibbonBaseElement::GetPressed

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

virtual CMFCRibbonBaseElement* GetPressed();

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

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

Замечания

CMFCRibbonBaseElement::GetQuickAccessToolBarID

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

virtual UINT GetQuickAccessToolBarID() const;

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

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

Замечания

CMFCRibbonBaseElement::GetRect

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

CRect GetRect() const;

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

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

CMFCRibbonBaseElement::GetRegularSize

Возвращает стандартный размер элемента ленты.

virtual CSize GetRegularSize(CDC* pDC) = 0;

Параметры

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

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

Обычный размер элемента ленты.

Замечания

Примечание.

Обычный размер — это максимальный возможный размер элемента ленты.

CMFCRibbonBaseElement::GetSize

Возвращает текущий размер элемента ленты.

virtual CSize GetSize(CDC* pDC);

Параметры

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

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

Текущий размер элемента ленты.

CMFCRibbonBaseElement::GetText

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

LPCTSTR GetText() const;

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

Текст, связанный с элементом ленты.

CMFCRibbonBaseElement::GetToolTipText

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

virtual CString GetToolTipText() const;

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

Текст подсказки элемента ленты.

CMFCRibbonBaseElement::GetTopLevelRibbonBar

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

CMFCRibbonBar* GetTopLevelRibbonBar() const;

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

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

Замечания

CMFCRibbonBaseElement::HasCompactMode

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

virtual BOOL HasCompactMode() const;

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

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

Замечания

Примечание.

В компактном режиме элемент отображает только небольшое изображение.

CMFCRibbonBaseElement::HasIntermediateMode

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

virtual BOOL HasIntermediateMode() const;

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

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

Замечания

CMFCRibbonBaseElement::HasLargeMode

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

virtual BOOL HasLargeMode() const;

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

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

Замечания

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

CMFCRibbonBaseElement::HasMenu

Указывает, имеет ли элемент ленты меню.

virtual BOOL HasMenu() const;

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

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

Замечания

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

CMFCRibbonBaseElement::HitTest

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

virtual CMFCRibbonBaseElement* HitTest(CPoint point);

Параметры

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

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

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

Замечания

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

CMFCRibbonBaseElement::IsAlignByColumn

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

virtual BOOL IsAlignByColumn() const;

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

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

Замечания

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

CMFCRibbonBaseElement::IsAlwaysLargeImage

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

virtual BOOL IsAlwaysLargeImage() const;

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

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

Замечания

Размер большого изображения составляет 32 x 32 пикселя.

CMFCRibbonBaseElement::IsAutoRepeatMode

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

virtual BOOL IsAutoRepeatMode(int& nDelay) const;

Параметры

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

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

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

Замечания

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

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

CMFCRibbonBaseElement::IsChecked

Указывает, проверяется ли элемент ленты.

virtual BOOL IsChecked() const;

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

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

CMFCRibbonBaseElement::IsCompactMode

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

BOOL IsCompactMode() const;

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

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

CMFCRibbonBaseElement::IsDefaultMenuLook

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

BOOL IsDefaultMenuLook() const;

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

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

Замечания

CMFCRibbonBaseElement::IsDisabled

Указывает, отключен ли элемент ленты.

virtual BOOL IsDisabled() const;

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

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

CMFCRibbonBaseElement::IsDroppedDown

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

virtual BOOL IsDroppedDown() const;

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

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

CMFCRibbonBaseElement::IsFocused

Указывает, имеет ли элемент ленты фокус.

virtual BOOL IsFocused() const;

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

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

CMFCRibbonBaseElement::IsGalleryIcon

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

virtual BOOL IsGalleryIcon() const;

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

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

Замечания

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

CMFCRibbonBaseElement::IsHighlighted

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

virtual BOOL IsHighlighted() const;

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

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

Замечания

CMFCRibbonBaseElement::IsIntermediateMode

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

BOOL IsIntermediateMode() const;

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

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

Замечания

Промежуточный размер изображения составляет 16 x 16 пикселей.

CMFCRibbonBaseElement::IsLargeMode

Указывает, является ли текущий образ элемента ленты большим размером.

BOOL IsLargeMode() const;

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

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

Замечания

Размер большого изображения составляет 32 x 32 пикселя.

CMFCRibbonBaseElement::IsMenuMode

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

BOOL IsMenuMode() const;

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

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

Замечания

CMFCRibbonBaseElement::IsPressed

Указывает, щелкнул ли пользователь элемент ленты.

virtual BOOL IsPressed() const;

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

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

CMFCRibbonBaseElement::IsQATMode

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

BOOL IsQATMode() const;

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

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

Замечания

CMFCRibbonBaseElement::IsSeparator

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

virtual BOOL IsSeparator() const;

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

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

Замечания

CMFCRibbonBaseElement::IsShowGroupBorder

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

BOOL IsShowGroupBorder() const;

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

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

Замечания

CMFCRibbonBaseElement::IsShowTooltipOnBottom

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

virtual BOOL IsShowTooltipOnBottom() const;

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

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

Замечания

CMFCRibbonBaseElement::IsTabStop

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

virtual BOOL IsTabStop() const;

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

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

Замечания

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

CMFCRibbonBaseElement::IsTextAlwaysOnRight

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

BOOL IsTextAlwaysOnRight() const;

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

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

Замечания

CMFCRibbonBaseElement::IsVisible

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

BOOL IsVisible() const;

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

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

Замечания

CMFCRibbonBaseElement::IsWholeRowHeight

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

virtual BOOL IsWholeRowHeight() const;

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

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

Замечания

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

CMFCRibbonBaseElement::NotifyCommand

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

BOOL NotifyCommand(BOOL bWithDelay = FALSE);

Параметры

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

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

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

Замечания

CMFCRibbonBaseElement::NotifyHighlightListItem

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

virtual void NotifyHighlightListItem(int nIndex);

Параметры

nIndex
[in] Индекс элемента ленты в списке.

Замечания

CMFCRibbonBaseElement::OnAddToQAToolbar

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

virtual BOOL OnAddToQAToolbar(CMFCRibbonQuickAccessToolBar& qat);

Параметры

qat
[in] Панель быстрого доступа.

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

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

Замечания

CMFCRibbonBaseElement::OnAfterChangeRect

Обновляет подсказку для элемента ленты.

virtual void OnAfterChangeRect(CDC* pDC);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::OnAutoRepeat

Обновляет элемент ленты в ответ на устойчивые входные данные пользователя.

virtual BOOL OnAutoRepeat();

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

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

Замечания

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

CMFCRibbonBaseElement::OnCalcTextSize

Вычисляет размер текста для элемента ленты.

virtual void OnCalcTextSize(CDC* pDC);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::OnChangeMenuHighlight

Вызывается платформой при изменении выделения элемента ленты, расположенного в меню.

virtual void OnChangeMenuHighlight(CMFCRibbonPanelMenuBar* pPanelMenuBar
    CMFCRibbonBaseElement* pHot);

Параметры

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

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

Замечания

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

CMFCRibbonBaseElement::OnDraw

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

virtual void OnDraw(CDC* pDC) = 0;

Параметры

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

Замечания

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

CMFCRibbonBaseElement::OnDrawKeyTip

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

virtual void OnDrawKeyTip(
    CDC* pDC,
    const CRect& rect,
    BOOL bIsMenu);

Параметры

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

rect
[in] Прямоугольник границы для подсказки.

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

Замечания

CMFCRibbonBaseElement::OnDrawMenuImage

Вызывается платформой при рисовании изображения меню для элемента ленты.

virtual BOOL OnDrawMenuImage(
    CDC* pDC,
    CRect rect);

Параметры

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

rect
[in] Прямоугольник изображения меню.

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

Всегда возвращает значение TRUE, чтобы указать, что изображение нарисовано.

Замечания

CMFCRibbonBaseElement::OnDrawOnList

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

virtual void OnDrawOnList(
    CDC* pDC,
    CString strText,
    int nTextOffset,
    CRect rect,
    BOOL bIsSelected,
    BOOL bHighlighted);

Параметры

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

strText
[in] Отображаемый текст.

nTextOffset
[in] Расстояние в пикселях от левой части поля списка до отображаемого текста.

rect
[in] Прямоугольник отображения для элемента ленты.

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

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

Замечания

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

CMFCRibbonBaseElement::OnKey

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

virtual BOOL OnKey(BOOL bIsMenuKey);

Параметры

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

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

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

Замечания

CMFCRibbonBaseElement::OnMenuKey

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

virtual BOOL OnMenuKey(UINT nUpperChar);

Параметры

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

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

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

Замечания

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

CMFCRibbonBaseElement::OnProcessKey

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

virtual BOOL OnProcessKey(UINT nChar);

Параметры

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

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

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

Замечания

Переопределите этот метод, если требуется, чтобы элемент ленты обрабатывал сочетания клавиш.

CMFCRibbonBaseElement::OnRTLChanged

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

virtual void OnRTLChanged(BOOL bIsRTL);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::OnSetFocus

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

virtual void OnSetFocus(BOOL B);

Замечания

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

CMFCRibbonBaseElement::OnShow

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

virtual void OnShow(BOOL bShow);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::OnShowPopupMenu

Вызывается платформой перед тем, как элемент ленты отображает всплывающее меню.

virtual void OnShowPopupMenu();

Замечания

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

CMFCRibbonBaseElement::P ostMenuCommand

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

void PostMenuCommand(UINT uiCmdId);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::Redraw

Обновляет отображение элемента ленты.

virtual void Redraw();

Замечания

Этот метод перерисовывает прямоугольник отображения для элемента ленты путем вызова CWnd::RedrawWindow с набором флагов RDW_INVALIDATE, RDW_ERASE и RDW_UPDATENOW флагов.

CMFCRibbonBaseElement::SetACCData

Задает данные специальных возможностей для элемента ленты.

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Параметры

pParent
Родительское окно для элемента ленты.

data
Данные специальных возможностей для элемента ленты.

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

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

Замечания

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

CMFCRibbonBaseElement::SetCompactMode

Задает размер дисплея для элемента ленты.

virtual void SetCompactMode(BOOL bCompactMode = TRUE);

Параметры

bCompactMode
[in] ЗНАЧЕНИЕ TRUE, чтобы уменьшить размер отображения элемента ленты; Значение FALSE для увеличения размера дисплея элемента ленты.

Замечания

В следующей таблице приведена сводка логики для этого метода.

bCompactMode	Текущий размер элемента ленты	Новый размер элемента ленты
TRUE	Compact	Без изменения.
TRUE	Средний уровень	Сжать, если это возможно.
TRUE	Большой	Промежуточный, если это возможно.
FALSE	Compact	Промежуточный, если это возможно; в противном случае большое.

CMFCRibbonBaseElement::SetData

Связывает элемент данных с элементом ленты.

void SetData(DWORD_PTR dwData);

Параметры

dwData
[in] Значение данных.

CMFCRibbonBaseElement::SetDefaultMenuLook

Задает элемент ленты для отображения в виде всплывающей команды.

void SetDefaultMenuLook(BOOL bIsDefaultMenuLook = TRUE);

Параметры

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

Замечания

CMFCRibbonBaseElement::SetDescription

Задает описание элемента ленты.

virtual void SetDescription(LPCTSTR lpszText);

Параметры

lpszText
[in] Описание элемента ленты.

Замечания

Платформа отображает новое описание в строке состояния или в подсказке или под кнопкой меню.

CMFCRibbonBaseElement::SetID

Задает идентификатор команды элемента ленты.

virtual void SetID(UINT nID);

Параметры

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

CMFCRibbonBaseElement::SetInitialMode

Задает начальный размер отображения элемента ленты.

virtual void SetInitialMode(BOOL bOneRow = FALSE);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::SetKeys

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

virtual void SetKeys(
    LPCTSTR lpszKeys,
    LPCTSTR lpszMenuKeys=NULL);

Параметры

lpszKeys
[in] Подсказка для элемента ленты.

lpszMenuKeys
[in] Подсказка для всплывающего меню элемента ленты.

CMFCRibbonBaseElement::SetOriginal

Задает исходный элемент ленты для элемента ленты.

virtual void SetOriginal(CMFCRibbonBaseElement* pOriginal);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::SetParentCategory

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

virtual void SetParentCategory(CMFCRibbonCategory* pParent);

Параметры

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

Замечания

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

CMFCRibbonBaseElement::SetParentMenu

Задает контейнер родительского меню для элемента ленты.

virtual void SetParentMenu(CMFCRibbonPanelMenuBar* pMenuBar);

Параметры

pMenuBar
[in] Родительское меню.

Замечания

CMFCRibbonBaseElement::SetParentRibbonBar

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

virtual void SetParentRibbonBar(CMFCRibbonBar* pRibbonBar);

Параметры

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

Замечания

CMFCRibbonBaseElement::SetRect

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

void SetRect(CRect rect);

Параметры

rect
[in] Размеры прямоугольника.

Замечания

CMFCRibbonBaseElement::SetText

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

virtual void SetText(LPCTSTR lpszText);

Параметры

lpszText
[in] Текст и подсказка для элемента ленты.

Замечания

Чтобы задать подсказку для элемента ленты, добавьте последовательность escape-обхода новой строки, за которой следуют символы ключа в lpszText.

Пример

//Set the text for the ribbon element
SetText(_T("Margins"))
//Set the text and a single-letter keytip
SetText(_T("Margins\nm"))
//Set the text and a multiple-letter keytip
SetText(_T("Line Numbers\nln"))

CMFCRibbonBaseElement::SetTextAlwaysOnRight

Задает текст для элемента ленты, отображаемого справа.

virtual void SetTextAlwaysOnRight(BOOL bSet = TRUE);

Параметры

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

Замечания

CMFCRibbonBaseElement::SetToolTipText

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

virtual void SetToolTipText(LPCTSTR lpszText);

Параметры

lpszText
[in] Текст подсказки.

CMFCRibbonBaseElement::SetVisible

Задает видимость элемента ленты.

void SetVisible(BOOL bIsVisible);

Параметры

bIsVisible
[in] ЗНАЧЕНИЕ TRUE для отображения элемента ленты; Значение FALSE для скрытия элемента ленты.

Замечания

CMFCRibbonBaseElement::StretchHorizontally

Растяжение ширины элемента ленты.

virtual void StretchHorizontally();

Замечания

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

CMFCRibbonBaseElement::StretchToWholeRow

Изменяет высоту отображения элемента ленты на указанную высоту строки.

virtual BOOL StretchToWholeRow(
    CDC* pDC,
    int nHeight);

Параметры

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

nHeight
[in] Высота строки.

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

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

Замечания

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

CMFCRibbonBaseElement::UpdateTooltipInfo

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

virtual void UpdateTooltipInfo();

Замечания

CMFCRibbonBaseElement::HasFocus

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

virtual BOOL HasFocus() const;

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

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

Замечания

См. также

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

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

Класс CMFCRibbonBaseElement

Синтаксис

Участники

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

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

Защищенные методы

Замечания

Пример

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

Требования

CMFCRibbonBaseElement::AddToKeyList

Параметры

Замечания

CMFCRibbonBaseElement::AddToListBox

Параметры

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

Замечания

CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar

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

Замечания

CMFCRibbonBaseElement::CanBeCompacted

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

Замечания

CMFCRibbonBaseElement::CanBeStretched

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

Замечания

CMFCRibbonBaseElement::CanBeStretchedHorizontally

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

Замечания

CMFCRibbonBaseElement::CleanUpSizes

Замечания

CMFCRibbonBaseElement::ClosePopupMenu

Замечания

CMFCRibbonBaseElement::CopyFrom

Параметры

Замечания

CMFCRibbonBaseElement::D ebergctrl

Замечания

CMFCRibbonBaseElement::D rawImage

Параметры

Замечания

CMFCRibbonBaseElement::Find

Параметры

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

Замечания

CMFCRibbonBaseElement::FindByData

Параметры

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

Замечания

CMFCRibbonBaseElement::FindByID

Параметры

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

Замечания

CMFCRibbonBaseElement::FindByOriginal

Параметры

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

Замечания

CMFCRibbonBaseElement::GetCompactSize

Параметры

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

CMFCRibbonBaseElement::GetData

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

CMFCRibbonBaseElement::GetDescription

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

CMFCRibbonBaseElement::GetDroppedDown

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

Замечания

CMFCRibbonBaseElement::GetElements

Параметры

Замечания

CMFCRibbonBaseElement::GetElementsByID

Параметры

Замечания

CMFCRibbonBaseElement::GetHighlighted

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

Замечания

CMFCRibbonBaseElement::GetID

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

CMFCRibbonBaseElement::GetImageSize