CMFCRibbonEdit 类
实现功能区栏上的编辑控件。
语法
class CMFCRibbonEdit : public CMFCRibbonButton
成员
公共构造函数
| 名称 | 描述 |
|---|---|
| CMFCRibbonEdit::CMFCRibbonEdit | 构造 CMFCRibbonEdit 对象。 |
公共方法
| 名称 | 描述 |
|---|---|
| CMFCRibbonEdit::CanBeStretched | 指示 CMFCRibbonEdit 控件的高度是否可以垂直增加到功能区行的高度。 |
| CMFCRibbonEdit::CMFCRibbonEdit | 构造 CMFCRibbonEdit 对象。 |
| CMFCRibbonEdit::CopyFrom | 将指定 CMFCRibbonEdit 对象的状态复制到当前 CMFCRibbonEdit 对象。 |
| CMFCRibbonEdit::CreateEdit | 为 CMFCRibbonEdit 对象创建新文本框。 |
| CMFCRibbonEdit::DestroyCtrl | 销毁 CMFCRibbonEdit 对象。 |
| CMFCRibbonEdit::DropDownList | 出现下拉列表框。 |
| CMFCRibbonEdit::EnableSpinButtons | 启用并设置文本框的旋转按钮范围。 |
| CMFCRibbonEdit::GetCompactSize | 检索 CFMCRibbonEdit 对象的紧凑大小。 |
| CMFCRibbonEdit::GetEditText | 检索文本框中的文本。 |
| CMFCRibbonEdit::GetIntermediateSize | 检索 CMFCRibbonEdit 对象的中间大小。 |
| CMFCRibbonEdit::GetTextAlign | 检索文本框中的文本对齐方式。 |
| CMFCRibbonEdit::GetWidth | 检索 CMFCRibbonEdit 控件的宽度（以像素为单位）。 |
| CMFCRibbonEdit::HasCompactMode | 指示 CMFCRibbonEdit 控件的显示大小是否可为紧凑型。 |
| CMFCRibbonEdit::HasFocus | 指示 CMFCRIbbonEdit 控件是否具有焦点。 |
| CMFCRibbonEdit::HasLargeMode | 指示 CMFCRibbonEdit 控件的显示大小是否可以很大。 |
| CMFCRibbonEdit::HasSpinButtons | 指示文本框是否具有旋转按钮。 |
| CMFCRibbonEdit::IsHighlighted | 指示 CMFCRibbonEdit 控件是否突出显示。 |
| CMFCRibbonEdit::OnAfterChangeRect | 当 CMFCRibbonEdit 控件的显示矩形大小发生变化时由框架调用。 |
| CMFCRibbonEdit::OnDraw | 由框架调用以绘制 CMFCRibbonEdit 控件。 |
| CMFCRibbonEdit::OnDrawLabelAndImage | 由框架调用以绘制 CMFCRibbonEdit 控件的标签和图像。 |
| CMFCRibbonEdit::OnDrawOnList | 由框架调用以在命令列表框中绘制 CMFCRibbonEdit 控件。 |
| CMFCRibbonEdit::OnEnable | 由框架调用以启用或禁用 CMFCRibbonEdit 控件。 |
| CMFCRibbonEdit::OnHighlight | 指针进入或离开 CMFCRibbonEdit 控件的边界时由框架调用。 |
| CMFCRibbonEdit::OnKey | 当用户按下按键提示且 CMFCRibbonEdit 控件具有焦点时由框架调用。 |
| CMFCRibbonEdit::OnLButtonDown | 当用户在控件上按下鼠标左键时，由框架调用以更新 CMFCRibbonEdit 控件。 |
| CMFCRibbonEdit::OnLButtonUp | 当用户松开鼠标左键时由框架调用。 |
| CMFCRibbonEdit::OnRTLChanged | 当布局改变方向时，由框架调用以更新 CMFCRibbonEdit 控件。 |
| CMFCRibbonEdit::OnShow | 由框架调用以显示或隐藏 CMFCRibbonEdit 控件。 |
| CMFCRibbonEdit::Redraw | 更新 CMFCRibbonEdit 控件的显示。 |
| CMFCRibbonEdit::SetACCData | 设置 CMFCRibbonEdit 对象的可访问性数据。 |
| CMFCRibbonEdit::SetEditText | 设置文本框中的文本。 |
| CMFCRibbonEdit::SetTextAlign | 设置文本框的文本对齐方式。 |
| CMFCRibbonEdit::SetWidth | 为 CMFCRibbonEdit 控件设置文本框的宽度。 |
备注
示例
以下示例演示如何构造 CMFCRibbonEdit 对象、在编辑控件旁边显示旋转按钮以及设置编辑控件的文本。 此代码片段是 MS Office 2007 演示示例的一部分。
CMFCRibbonEdit *pEditIndentLeft = new CMFCRibbonEdit(ID_PAGELAYOUT_INDENT_LEFT, 72, _T("Left:\nil"), 13);
// specify the min and max value of the spin button control
pEditIndentLeft->EnableSpinButtons(0, 1000);
// set the text of the edit control
pEditIndentLeft->SetEditText(_T("0"));
要求
标头：afxRibbonEdit.h
CMFCRibbonEdit::CanBeStretched
指示 CMFCRibbonEdit 控件的高度是否可以垂直增加到功能区行的高度。
virtual BOOL CanBeStretched();
返回值
始终返回 FALSE。
注解
CMFCRibbonEdit::CMFCRibbonEdit
构造 CMFCRibbonEdit 对象。
CMFCRibbonEdit(
UINT nID,
int nWidth,
LPCTSTR lpszLabel = NULL,
int nImage = -1);
CMFCRibbonEdit();
参数
nID
[in] CMFCRibbonEdit 控件的命令 ID。
nWidth
[in] CMFCRibbonEdit 控件文本框的宽度（以像素为单位）。
lpszLabel
[in] CMFCRibbonEdit 控件的标签。
nImage
[in] 要用于 CMFCRibbonEdit 控件的小图像的索引。 小图像的集合由父级功能区类别维护。
备注
CMFCRibbonEdit 控件不使用大图像。
CMFCRibbonEdit::CopyFrom
将指定 CMFCRibbonEdit 对象的状态复制到当前 CMFCRibbonEdit 对象。
virtual void CopyFrom(const CMFCRibbonBaseElement& src);
参数
src
[in] 源 CMFCRibbonEdit 对象。
备注
src 参数必须是 CMFCRibbonEdit 类型。
CMFCRibbonEdit::CreateEdit
为 CMFCRibbonEdit 对象创建新文本框。
virtual CMFCRibbonRichEditCtrl* CreateEdit(
CWnd* pWndParent,
DWORD dwEditStyle);
参数
pWndParent
[in] 指向 CMFCRibbonEdit 对象的父窗口的指针。
dwEditStyle
[in] 指定文本框的样式。 可以将”备注”部分中列出的窗口样式与 Windows SDK 中所述的编辑控件样式结合起来。
返回值
如果方法成功，则为指向新组文本框的指针；否则为 NULL。
备注
替代派生类中的此方法以创建自定义文本框。
将以下窗口样式应用于文本框：
WS_CHILD
WS_VISIBLE
WS_DISABLED
WS_GROUP
WS_TABSTOP
CMFCRibbonEdit::DestroyCtrl
销毁 CMFCRibbonEdit 对象。
virtual void DestroyCtrl();
备注
CMFCRibbonEdit::DropDownList
出现下拉列表框。
virtual void DropDownList();
注解
默认情况下，此方法不执行任何操作。 替代此方法以显示下拉列表框。
CMFCRibbonEdit::EnableSpinButtons
启用并设置文本框的旋转按钮范围。
void EnableSpinButtons(
int nMin,
int nMax);
参数
nMin
[in] 旋转按钮的最小值。
nMax
[in] 旋转按钮的最大值。
备注
旋转按钮显示向上和向下箭头，使用户能够在一组固定值中移动。
CMFCRibbonEdit::GetCompactSize
检索 CMFCRibbonEdit 对象的紧凑大小。
virtual CSize GetCompactSize(CDC* pDC);
参数
pDC
[in] 指向 CMFCRibbonEdit 对象的设备上下文的指针。
返回值
CMFCRibbonEdit 对象的紧凑大小。
备注
CMFCRibbonEdit::GetEditText
检索文本框中的文本。
CString GetEditText() const;
返回值
文本框中的文本。
备注
CMFCRibbonEdit::GetIntermediateSize
检索 CMFCRibbonEdit 对象的中间大小。
virtual CSize GetIntermediateSize(CDC* pDC);
参数
pDC
[in] 指向 CMFCRibbonEdit 对象的设备上下文的指针。
返回值
CMFCRibbonEdit 对象的中间大小。
注解
CMFCRibbonEdit::GetTextAlign
检索文本框中的文本对齐方式。
int GetTextAlign() const;
返回值
文本对齐枚举值。 有关可能的值，请参阅“注解”部分。
备注
返回的值是以下编辑控件样式之一：
ES_LEFT，用于左对齐
ES_CENTER，用于居中对齐
ES_RIGHT，用于右对齐
有关这些样式的详细信息，请参阅编辑控件样式。
CMFCRibbonEdit::GetWidth
检索 CMFCRibbonEdit 控件的宽度（以像素为单位）。
int GetWidth(BOOL bInFloatyMode = FALSE) const;
参数
bInFloatyMode
[in] 如果 CMFCRibbonEdit 控件处于浮动模式，则为 TRUE；否则为 FALSE。
返回值
CMFCRibbonEdit 控件的宽度（以像素为单位）。
备注
CMFCRibbonEdit::HasCompactMode
指示 CMFCRibbonEdit 控件的显示大小是否可为紧凑型。
virtual BOOL HasCompactMode() const;
返回值
始终返回 TRUE。
备注
默认情况下，此方法始终返回 TRUE。 替代此方法以指示显示大小是否可为紧凑型。
CMFCRibbonEdit::HasFocus
指示 CMFCRibbonEdit 控件是否具有焦点。
virtual BOOL HasFocus() const;
返回值
如果 CMFCRibbonEdit 控件具有焦点，则为 TRUE；否则为 FALSE。
备注
CMFCRibbonEdit::HasLargeMode
指示 CMFCRibbonEdit 控件的显示大小是否可为大型。
virtual BOOL HasLargeMode() const;
返回值
始终返回 FALSE。
备注
默认情况下，此方法始终返回 FALSE。 替代此方法以指示显示大小是否可为大型。
CMFCRibbonEdit::HasSpinButtons
指示文本框是否具有旋转按钮。
virtual BOOL HasSpinButtons() const;
返回值
如果文本框有旋转按钮，则为 TRUE；否则为 FALSE。
注解
CMFCRibbonEdit::IsHighlighted
指示 CMFCRibbonEdit 控件是否具有焦点。
virtual BOOL IsHighlighted() const;
返回值
如果 CMFCRibbonEdit 控件突出显示，则为 TRUE；否则为 FALSE。
备注
CMFCRibbonEdit::OnAfterChangeRect
当 CMFCRibbonEdit 控件的显示矩形大小发生变化时由框架调用。
virtual void OnAfterChangeRect(CDC* pDC);
参数
pDC
[in] 指向 CMFCRibbonEdit 控件的设备上下文的指针。
注解
CMFCRibbonEdit::OnDraw
由框架调用以绘制 CMFCRibbonEdit 控件。
virtual void OnDraw(CDC* pDC);
参数
pDC
[in] 指向 CMFCRibbonEdit 控件的设备上下文的指针。
注解
CMFCRibbonEdit::OnDrawLabelAndImage
由框架调用以绘制 CMFCRibbonEdit 控件的标签和图像。
virtual void OnDrawLabelAndImage(CDC* pDC);
参数
pDC
[in] 指向 CMFCRibbonEdit 控件的设备上下文的指针。
备注
CMFCRibbonEdit::OnDrawOnList
由框架调用以在命令列表框中绘制 CMFCRibbonEdit 控件。
virtual void OnDrawOnList(
CDC* pDC,
CString strText,
int nTextOffset,
CRect rect,
BOOL bIsSelected,
BOOL bHighlighted);
参数
pDC
[in] 指向 CMFCRibbonEdit 控件的设备上下文的指针。
strText
[in] 显示文本。
nTextOffset
[in] 从列表框左侧到显示文本的距离（以像素为单位）。
rect
[in ] CMFCRibbonEdit 控件的显示矩形。
bIsSelected
[in] 未使用此参数。
bHighlighted
[in] 未使用此参数。
注解
命令列表框显示功能区控件，使用户能够自定义快速访问工具栏。
CMFCRibbonEdit::OnEnable
由框架调用以启用或禁用 CMFCRibbonEdit 控件。
virtual void OnEnable(BOOL bEnable);
参数
bEnable
[in] TRUE 用于启用控件；FALSE 用于禁用控件。
备注
CMFCRibbonEdit::OnHighlight
指针进入或离开 CMFCRibbonEdit 控件的边界时由框架调用。
virtual void OnHighlight(BOOL bHighlight);
参数
bHighlight
[in] 如果指针位于控件的 CMFCRibbonEdit 边界中，则为 TRUE；否则为 FALSE。
备注
CMFCRibbonEdit::OnKey
当用户按下按键提示且 CMFCRibbonEdit 控件具有焦点时由框架调用。
virtual BOOL OnKey(BOOL bIsMenuKey);
参数
bIsMenuKey
[in] 如果快捷键提示显示弹出菜单，则返回 TRUE；否则返回 FALSE。
返回值
如果已处理事件，则返回 TRUE；否则返回 FALSE。
备注
CMFCRibbonEdit::OnLButtonDown
当用户在控件上按下鼠标左键时，由框架调用以更新 CMFCRibbonEdit 控件。
virtual void OnLButtonDown(CPoint point);
参数
point
[in] 未使用此参数。
注解
CMFCRibbonEdit::OnLButtonUp
当用户松开鼠标左键时由框架调用。
virtual void OnLButtonUp(CPoint point);
参数
point
[in] 未使用此参数。
注解
CMFCRibbonEdit::OnRTLChanged
当布局改变方向时，由框架调用以更新 CMFCRibbonEdit 控件。
virtual void OnRTLChanged(BOOL bIsRTL);
参数
bIsRTL
[in] 如果布局为从右到左，则为 TRUE；如果布局为从左到右，则为 FALSE。
备注
CMFCRibbonEdit::OnShow
由框架调用以显示或隐藏 CMFCRibbonEdit 控件。
virtual void OnShow(BOOL bShow);
参数
bShow
[in] True 用于显示控件；FALSE 用于隐藏控件。
注解
CMFCRibbonEdit::Redraw
更新 CMFCRibbonEdit 控件的显示。
virtual void Redraw();
备注
此方法通过直接调用设置了 RDW_INVALIDATE、RDW_ERASE 和 RDW_UPDATENOW 标志的 CWnd::RedrawWindow 来重绘 CMFCRibbonEdit 对象的显示矩形。
CMFCRibbonEdit::SetACCData
设置 CMFCRibbonEdit 对象的可访问性数据。
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
参数
pParent
指向 CMFCRibbonEdit 对象的父窗口的指针。
data
CMFCRibbonEdit 对象的可访问性数据。
返回值
始终返回 TRUE。
备注
CMFCRibbonEdit::SetEditText
设置文本框中的文本。
void SetEditText(CString strText);
参数
strText
[in] 文本框的文本。
CMFCRibbonEdit::SetTextAlign
设置文本框的文本对齐方式。
void SetTextAlign(int nAlign);
参数
nAlign
[in] 文本对齐枚举值。 有关可能的值，请参阅“注解”部分。
备注
参数 nAlign 是以下编辑控件样式之一：
ES_LEFT，用于左对齐
ES_CENTER，用于居中对齐
ES_RIGHT，用于右对齐
有关这些样式的详细信息，请参阅编辑控件样式。
CMFCRibbonEdit::SetWidth
设置 CMFCRibbonEdit 控件文本框的宽度。
void SetWidth(
int nWidth,
BOOL bInFloatyMode = FALSE);
参数
nWidth
[in] 文本框的宽度（以像素为单位）。
bInFloatyMode
TRUE 用于设置浮动模式的宽度；FALSE 用于设置常规模式的宽度。
备注
CMFCRibbonEdit 控件根据其显示模式提供两种宽度：浮动模式和常规模式。
另请参阅
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈