CMFCRibbonBaseElement 类
CMFCRibbonBaseElement 类是可以添加到功能区栏的所有元素的基类。 功能区元素的示例包括功能区按钮、功能区复选框和功能区组合框。
语法
class CMFCRibbonBaseElement : public CObject
成员
公共构造函数
| 名称 | 描述 |
|---|---|
CMFCRibbonBaseElement |
构造 CMFCRibbonBaseElement 对象。 |
公共方法
受保护方法
| 名称 | 描述 |
|---|---|
| CMFCRibbonBaseElement::OnProcessKey | 当用户按快捷键时，由框架调用。 |
| CMFCRibbonBaseElement::OnSetFocus | 当功能区元素接收或失去输入焦点时，由框架调用。 |
注解
CMFCRibbonBaseElement 类定义了所有功能区元素共有的属性，包括命令 ID、文本标签、工具提示文本、元素说明和状态（可以是已聚焦、已突出显示、已按下、已禁用、已选中或已下拉）。
功能区元素的图像大小由 RibbonImageType 成员定义，可以是以下值之一：
RibbonImageLargeRibbonImageSmall
功能区元素将根据其大小显示小图或大图。
示例
下面的示例演示了如何使用 CMFCRibbonBaseElement 类中的各种方法。 该示例演示了如何从 CMFCRibbonStatusBar 类中获取 CMFCRibbonBaseElement 对象、设置功能区元素的说明、设置文本、设置快捷键提示以及设置功能区元素的工具提示文本。 此代码片段属于 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"));
继承层次结构
要求
标头： 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::DestroyCtrl
销毁功能区元素。
virtual void DestroyCtrl();
备注
默认情况下，此方法不执行任何操作。 替代派生类中的此方法以销毁功能区元素。
CMFCRibbonBaseElement::DrawImage
绘制功能区元素的图像。
virtual void DrawImage(
CDC* pDC,
RibbonImageType type,
CRect rectImage);
参数
pDC
[in] 指向设备上下文的指针。
type
[in] 映像类型枚举值。 有关可能值的列表，请参阅“注解”部分。
rectImage
[in] 图像矩形。
注解
默认情况下，此方法不执行任何操作。 替代派生类中的此方法以绘制功能区元素图像。
下表列出了 type 参数可能的值：
| 值 | 说明 |
|---|---|
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
如果指定命令 ID 标识功能区元素，则检索指向该功能区元素的指针。
virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);
参数
uiCmdID
[in] 功能区元素的命令 ID。
返回值
如果指定命令 ID 标识了功能区元素，则返回指向该功能区元素的指针；否则返回 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
如果当前功能区元素包含指定的命令 ID，则向指定的数组添加当前功能区元素。
virtual void GetElementsByID(
UINT uiCmdID,
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
参数
uiCmdID
[in] 功能区元素的命令 ID。
arElements
[in] 功能区元素数组。
注解
CMFCRibbonBaseElement::GetHighlighted
如果功能区元素突出显示，则检索指向该功能区元素的指针。
virtual CMFCRibbonBaseElement* GetHighlighted();
返回值
如果突出显示功能区元素，则返回指向该功能区元素的指针；否则返回 NULL。
注解
CMFCRibbonBaseElement::GetID
返回功能区元素的命令 ID。
UINT GetID() const;
返回值
功能区元素的命令 ID。
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。
返回值
始终返回一个没有值的矩形。
备注
替代派生类中的此方法以返回快捷键提示边界矩形。
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
检索功能区元素的通知命令 ID。
virtual UINT GetNotifyID();
返回值
通知命令 ID。
备注
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
当功能区元素位于快速访问工具栏中时，检索该功能区元素的命令 ID。
virtual UINT GetQuickAccessToolBarID() const;
返回值
当功能区元素位于快速访问工具栏中时，返回该功能区元素的命令 ID。
备注
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] 未使用此参数。
pHot
[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::PostMenuCommand
关闭功能区元素的弹出菜单，并向父菜单发送关闭消息。
void PostMenuCommand(UINT uiCmdId);
参数
uiCmdId
[in] 不使用参数。
备注
仅当功能区元素位于弹出菜单上时，才会发送关闭消息。
CMFCRibbonBaseElement::Redraw
更新功能区元素的显示。
virtual void Redraw();
注解
此方法通过调用设置了 RDW_INVALIDATE、RDW_ERASE 和 RDW_UPDATENOW 标志的 CWnd::RedrawWindow 来重绘功能区元素的显示矩形。
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 | 精简 | 未进行更改。 |
| TRUE | 中级 | 压缩（若可能。） |
| TRUE | 大 | 中等（若可能。） |
| FALSE | 精简 | 中等（若可能）；否则为大。 |
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
设置功能区元素的命令 ID。
virtual void SetID(UINT nID);
参数
nID
[in] 命令 ID。
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] 设置功能区元素的文本和快捷键提示。
备注
若要设置功能区元素的快捷键提示，请将后跟快捷键提示字符的换行符转义序列追加到 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。