共用方式為


CMFCRibbonCategory 類別

類別 CMFCRibbonCategory 會實作功能區索引標籤,其中包含一組 功能區面板

語法

class CMFCRibbonCategory : public CObject

成員

受保護的建構函式

名稱 描述
CMFCRibbonCategory::CMFCRibbonCategory 建構函式。

公用方法

名稱 描述
CMFCRibbonCategory::AddHidden 將隱藏專案新增至功能區類別目錄。
CMFCRibbonCategory::AddPanel 將新的面板新增至功能區類別。
CMFCRibbonCategory::CopyFrom
CMFCRibbonCategory::FindByData
CMFCRibbonCategory::FindByID
CMFCRibbonCategory::FindPanelWithElem
CMFCRibbonCategory::GetContextID 傳回功能區類別的內容識別碼。
CMFCRibbonCategory::GetData 傳回與功能區類別相關聯的使用者定義數據。
CMFCRibbonCategory::GetDroppedDown
CMFCRibbonCategory::GetElements
CMFCRibbonCategory::GetElementsByID
CMFCRibbonCategory::GetFirstVisibleElement 取得屬於功能區類別的第一個可見專案。
CMFCRibbonCategory::GetFocused 傳回具有焦點的項目。
CMFCRibbonCategory::GetHighlighted 傳回醒目提示的專案。
CMFCRibbonCategory::GetImageCount
CMFCRibbonCategory::GetImageSize
CMFCRibbonCategory::GetItemIDsList
CMFCRibbonCategory::GetLastVisibleElement 取得屬於功能區類別的最後一個可見專案
CMFCRibbonCategory::GetLargeImages 傳回功能區類別目錄所使用之大型影像清單的參考。
CMFCRibbonCategory::GetMaxHeight
CMFCRibbonCategory::GetName
CMFCRibbonCategory::GetPanel 傳回位於指定索引之功能區面板的指標。
CMFCRibbonCategory::GetPanelCount 傳回功能區類別中的功能區面板數目。
CMFCRibbonCategory::GetPanelFromPoint
CMFCRibbonCategory::GetPanelIndex 傳回指定功能區面板的索引。
CMFCRibbonCategory::GetParentButton
CMFCRibbonCategory::GetParentMenuBar
CMFCRibbonCategory::GetParentRibbonBar
CMFCRibbonCategory::GetRect
CMFCRibbonCategory::GetSmallImages 傳回類別所使用之小型影像清單的參考。
CMFCRibbonCategory::GetTabColor 傳回功能區類別索引標籤的目前色彩。
CMFCRibbonCategory::GetTabRect
CMFCRibbonCategory::GetTextTopLine
CMFCRibbonCategory::GetVisibleElements 取得屬於功能區類別的所有可見專案。
CMFCRibbonCategory::HighlightPanel
CMFCRibbonCategory::HitTest
CMFCRibbonCategory::HitTestEx
CMFCRibbonCategory::HitTestScrollButtons
CMFCRibbonCategory::IsActive
CMFCRibbonCategory::IsVisible 判斷功能區類別是否可見。
CMFCRibbonCategory::IsWindows7Look 指出父功能區是否有 Windows 7 樣式的外觀(小型矩形應用程式按鈕)
CMFCRibbonCategory::NotifyControlCommand
CMFCRibbonCategory::OnCancelMode
CMFCRibbonCategory::OnDraw
CMFCRibbonCategory::OnDrawImage
CMFCRibbonCategory::OnDrawMenuBorder
CMFCRibbonCategory::OnKey 當使用者按下鍵盤按鈕時,由架構呼叫。
CMFCRibbonCategory::OnLButtonDown
CMFCRibbonCategory::OnLButtonUp
CMFCRibbonCategory::OnMouseMove
CMFCRibbonCategory::OnRTLChanged
CMFCRibbonCategory::OnScrollHorz
CMFCRibbonCategory::OnUpdateCmdUI
CMFCRibbonCategory::RecalcLayout
CMFCRibbonCategory::RemovePanel
CMFCRibbonCategory::ReposPanels
CMFCRibbonCategory::SetCollapseOrder 定義功能區類別中存在的功能區面板折疊順序。
CMFCRibbonCategory::SetData 將使用者定義的數據儲存在功能區類別中。
CMFCRibbonCategory::SetKeys 將按鍵提示指派給功能區類別目錄。
CMFCRibbonCategory::SetName
CMFCRibbonCategory::SetTabColor 設定功能區類別的色彩。

備註

一般而言,您可以藉由呼叫 CMFCRibbonBar::AddCategory 間接建立功能區類別,以傳回新建立功能區類別的指標。 您可以呼叫 CMFCRibbonCategory::AddPanel,將面板新增至類別。

類別 CMFCRibbonTab 會繪製功能區類別。 其衍生自 CMFCRibbonBaseElement 類別

下列範例示範如何建立功能區類別,並將面板新增至其中。

// Create a new ribbon category and get a pointer to it`
CMFCRibbonCategory* pCategory = m_wndRibbonBar.AddCategory
    (_T("&Write"),           // Category name
    IDB_WRITE,               // Category small images (16 x 16)
    IDB_WRITE_LARGE);        // Category large images (32 x 32)

// Add a panel to the new category
CMFCRibbonPanel* pPanel = pCategory->AddPanel (
    _T("Clipboard"),                // Panel name
    m_PanelIcons.ExtractIcon (0));  // Panel icon

下圖顯示 RibbonApp 範例應用程式的 Home 類別圖。

RibbonApp 範例應用程式的首頁類別。

繼承階層架構

CObject

CMFCRibbonCategory

需求

標頭: afxribboncategory.h

CMFCRibbonCategory::AddHidden

將指定的功能區專案加入至自訂對話框上顯示的功能區項目陣列。

void AddHidden(CMFCRibbonBaseElement* pElem);

參數

pElem
[in]功能區專案的指標。

備註

自訂對話框上的功能區元素是您可以新增至快速存取工具列的命令。

CMFCRibbonCategory::AddPanel

建立功能區類別的功能區面板。

CMFCRibbonPanel* AddPanel(
    LPCTSTR lpszPanelName,
    HICON hIcon = 0,
    CRuntimeClass* pRTI = NULL);

參數

lpszPanelName
[in]新功能區面板名稱的指標。

hIcon
[in]處理新功能區面板的預設圖示。

pRTI
[in]自定義功能區面板的運行時間類別資訊的指標。

傳回值

如果方法成功,則為新功能區面板的指標;否則,如果未建立面板,則為 NULL。

備註

如果您要建立自訂功能區面板,您必須在 pRTI指定其執行時間類別資訊。 自定義功能區面板類別必須衍生自 CMFCRibbonPanel 類別。

當沒有足夠的空間顯示功能區元素時,會顯示功能區面板的預設圖示。

範例

下列範例示範如何在 類別中使用 AddPanel CMFCRibbonCategory 方法。

// Create "Favorites" panel:
strTemp.LoadString(IDS_RIBBON_FAVORITES);
// CMFCRibbonCategory* pCategoryCustom
CMFCRibbonPanel *pPanelFavorites = pCategoryCustom->AddPanel(strTemp,
                                                             m_PanelImages.ExtractIcon(15));

CMFCRibbonCategory::CMFCRibbonCategory

建構和初始化 CMFCRibbonCategory 物件。

CMFCRibbonCategory(
    CMFCRibbonBar* pParenrRibbonBar,
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

參數

pParenrRibbonBar
[in]功能區類別的父功能區列指標。

lpszName
[in]功能區類別的名稱。

uiSmallImagesResID
[in]功能區類別中功能區元素所使用的小型影像影像清單資源標識符。

uiLargeImagesResID
[in]功能區類別中功能區元素所使用的大型影像影像清單資源標識符。

sizeSmallImage
[in]功能區類別中功能區元素的預設小型影像大小。

sizeLargeImage
[in]功能區類別中功能區元素的預設大型影像大小。

CMFCRibbonCategory::CopyFrom

將指定 CMFCRibbonCategory 的狀態複製到目前的 CMFCRibbonCategory 物件。

virtual void CopyFrom(CMFCRibbonCategory& src);

參數

src
[in]來源 CMFCRibbonCategory 物件。

備註

CMFCRibbonCategory::FindByData

擷取與指定數據相關聯的功能區專案。

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

參數

dwData
[in]與功能區專案相關聯的數據。

bVisibleOnly
[in]TRUE 表示在搜尋中包含快速存取功能區元素;FALSE 表示在搜尋中排除快速存取功能區元素。

傳回值

如果方法成功,則為功能區專案的指標;否則為 NULL。

備註

CMFCRibbonCategory::FindByID

擷取與指定命令標識符相關聯的功能區專案。

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

參數

uiCmdID
[in]與功能區項目相關聯的命令標識碼。

bVisibleOnly
[in]TRUE 表示在搜尋中包含快速存取功能區元素;FALSE 表示在搜尋中排除快速存取功能區元素。

傳回值

如果方法成功,則為功能區專案的指標;否則為 NULL。

備註

CMFCRibbonCategory::FindPanelWithElem

擷取包含指定功能區專案的功能區面板。

CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);

參數

pElement
[in]功能區專案的指標。

傳回值

如果方法成功,則為功能區面板的指標;否則為 NULL。

備註

CMFCRibbonCategory::GetContextID

擷取功能區類別的內容標識碼。

UINT GetContextID() const;

傳回值

功能區類別的內容識別碼。

備註

如果功能區類別不是內容功能區類別,則內容識別碼為 0。

CMFCRibbonCategory::GetData

擷取與功能區類別相關聯的使用者定義數據。

DWORD_PTR GetData() const;

傳回值

與功能區類別相關聯的使用者定義數據。

CMFCRibbonCategory::GetDroppedDown

擷取目前顯示其快捷功能表的功能區專案的指標。

CMFCRibbonBaseElement* GetDroppedDown();

傳回值

如果方法成功,則為功能區專案的指標;否則為 NULL。

備註

CMFCRibbonCategory::GetElements

擷取功能區類別中的所有功能區專案。

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

參數

arElements
[in, out] 功能區專案的 CArray 參考。

備註

專為在快速存取工具列上使用而設計的功能區元素會包含在陣列中。

CMFCRibbonCategory::GetElementsByID

擷取與指定命令標識符相關聯的所有功能區專案。

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

參數

uiCmdID
[in]與功能區項目相關聯的命令標識碼。

arElements
[in, out] 功能區專案的 CArray 參考。

備註

專為在快速存取工具列上使用而設計的功能區元素會包含在陣列中。

CMFCRibbonCategory::GetFirstVisibleElement

擷取屬於功能區類別的第一個可見專案。

CMFCRibbonBaseElement* GetFirstVisibleElement() const;

傳回值

第一個可見專案的指標;如果類別沒有任何可見的元素,可能是 NULL。

備註

CMFCRibbonCategory::GetFocused

傳回具有焦點的項目。

CMFCRibbonBaseElement* GetFocused();

傳回值

焦點專案或 NULL 的指標。

備註

CMFCRibbonCategory::GetHighlighted

傳回醒目提示的專案。

CMFCRibbonBaseElement* GetHighlighted();

傳回值

反白顯示的元素指標,如果沒有反白顯示任何專案,則為 NULL。

備註

CMFCRibbonCategory::GetImageCount

擷取功能區類別中包含的指定影像清單中的影像數目。

int GetImageCount(BOOL bIsLargeImage) const;

參數

bIsLargeImage
[in]TRUE 表示大型映射清單中的影像數目;FALSE 代表小型影像清單中的影像數目。

傳回值

指定影像清單中的影像數目。

備註

CMFCRibbonCategory::GetImageSize

擷取功能區類別中包含的指定影像清單中的影像大小。

CSize GetImageSize(BOOL bIsLargeImage) const;

參數

bIsLargeImage
[in]大型影像的大小為 TRUE;FALSE 表示小型影像的大小。

傳回值

指定影像清單中的影像大小。

備註

擷取的大小包含全域影像縮放比例。

CMFCRibbonCategory::GetItemIDsList

擷取功能區類別中所含功能區元素的命令標識碼。

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

參數

lstItems
[out]功能區類別中功能區元素的命令標識符清單。

bHiddenOnly
[in]TRUE 表示排除功能區類別中功能區面板上顯示的功能區元素;FALSE,以在功能區類別中包含所有功能區元素。

備註

CMFCRibbonCategory::GetLargeImages

擷取功能區類別中包含的大型影像清單。

CMFCToolBarImages& GetLargeImages();

傳回值

功能區類別中包含的大型影像清單。

CMFCRibbonCategory::GetLastVisibleElement

擷取屬於功能區類別目錄的最後一個可見專案。

CMFCRibbonBaseElement* GetLastVisibleElement() const;

傳回值

最後一個可見專案的指標;如果類別沒有任何可見的元素,可能是 NULL。

備註

CMFCRibbonCategory::GetMaxHeight

擷取功能區類別中包含的功能區面板最大高度。

int GetMaxHeight(CDC* pDC);

參數

pDC
[in]功能區面板之裝置內容的指標。

傳回值

功能區類別中包含的功能區面板最大高度。

備註

擷取的值包含功能區面板的上邊界和下邊界的高度。

CMFCRibbonCategory::GetName

擷取功能區類別目錄的名稱。

LPCTSTR GetName() const;

傳回值

功能區類別的名稱。

備註

CMFCRibbonCategory::GetPanel

傳回位於指定索引之功能區面板的指標。

CMFCRibbonPanel* GetPanel(int nIndex);

參數

nIndex
[in]功能區面板以零起始的索引。

傳回值

位於指定索引之功能區面板的指標。

備註

如果 nIndex 超出範圍,就會擲回例外狀況。

CMFCRibbonCategory::GetPanelCount

傳回功能區類別中的功能區面板數目。

int GetPanelCount() const;

傳回值

功能區類別中的功能區面板數目。

CMFCRibbonCategory::GetPanelFromPoint

如果指定的點位於功能區面板中,則擷取功能區面板的指標。

CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;

參數

point
[in]指標的 x 和 y 座標,相對於視窗左上角。

傳回值

如果方法成功,則為功能區面板的指標;否則為 NULL。

備註

只會測試功能區類別中包含的功能區面板。

CMFCRibbonCategory::GetPanelIndex

擷取指定功能區面板之以零起始的索引。

int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;

參數

pPanel
[in]功能區面板的指標。

傳回值

如果方法成功,則為指定功能區面板的以零起始的索引;否則為 -1。

備註

只會搜尋功能區類別中包含的功能區面板。

CMFCRibbonCategory::GetParentButton

擷取功能區類別目錄的父功能區專案。

CMFCRibbonBaseElement* GetParentButton() const;

傳回值

傳回父功能區專案的指標,如果沒有父元素,則傳回NULL。

備註

CMFCRibbonCategory::GetParentMenuBar

傳回 物件的父功能表欄 CMFCRibbonCategory 指標。

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

傳回值

傳回受保護成員的內容 m_pParentMenuBar

備註

CMFCRibbonCategory::GetParentRibbonBar

擷取功能區類別的父功能區列。

CMFCRibbonBar* GetParentRibbonBar() const;

傳回值

功能區類別目錄之父功能區列的指標。

備註

CMFCRibbonCategory::GetRect

擷取功能區類別的顯示矩形。

CRect GetRect() const;

傳回值

功能區類別的顯示矩形。

備註

功能區類別目錄的顯示矩形不包含類別索引標籤。

CMFCRibbonCategory::GetSmallImages

擷取功能區類別中包含的小型影像清單。

CMFCToolBarImages& GetSmallImages();

傳回值

功能區類別中包含的小型影像清單。

CMFCRibbonCategory::GetTabColor

傳回功能區類別索引標籤的目前色彩。

AFX_RibbonCategoryColor GetTabColor() const;

傳回值

功能區類別索引標籤的目前色彩。

備註

傳回的值可以是下列其中一個列舉值:

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

CMFCRibbonCategory::GetTabRect

擷取功能區類別索引標籤的顯示矩形。

CRect GetTabRect() const;

傳回值

功能區類別索引標籤的顯示矩形。

備註

CMFCRibbonCategory::GetTextTopLine

擷取功能區類別中顯示大型影像的功能區按鈕上文字的垂直位置。

int GetTextTopLine() const;

傳回值

顯示大型影像的功能區按鈕上的文字垂直位置,以像素為單位。

備註

CMFCRibbonCategory::GetVisibleElements

擷取屬於功能區類別目錄的所有可見專案。

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

參數

arElements
所有可見元素的陣列。

備註

CMFCRibbonCategory::HighlightPanel

反白顯示指定的功能區面板。

CMFCRibbonPanel* HighlightPanel(
    CMFCRibbonPanel* pHLPanel,
    CPoint point);

參數

pHLPanel
[in]要反白顯示的功能區面板指標。

point
[in]指標的 x 和 y 座標,相對於視窗左上角。

傳回值

先前醒目提示功能區面板的指標;否則,如果未在叫用此方法時反白顯示任何功能區面板,則為 NULL。

備註

如需醒目提示功能區面板的詳細資訊,請參閱 CMFCRibbonPanel::Highlight

CMFCRibbonCategory::HitTest

如果指定的點位於功能區元素中,則擷取功能區專案的指標。

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

參數

point
[in]滑鼠指標的 x 和 y 座標,相對於視窗左上角。

bCheckPanelCaption
[in]TRUE 可測試功能區面板標題;FALSE 表示排除功能區面板標題。

傳回值

如果方法成功,則為功能區專案的指標;否則為 NULL。

備註

只會測試功能區類別中包含的功能區專案。

CMFCRibbonCategory::HitTestEx

如果指定的點位於功能區元素中,則擷取以零起始的索引。

int HitTestEx(CPoint point) const;

參數

point
[in]滑鼠指標的 x 和 y 座標,相對於視窗左上角。

傳回值

如果方法成功,則為功能區專案的以零起始的索引;否則為 -1。

備註

只會測試功能區類別中包含的功能區專案。

CMFCRibbonCategory::HitTestScrollButtons

如果某個點落在功能區類別的左側或右卷動按鈕內,則傳回該按鈕的指標。

CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;

參數

point
[in] 要測試的點。

傳回值

如果 落在功能區類別的左側或右卷動按鈕的周框內,則傳回該按鈕的指標,否則會傳回 NULL。

備註

CMFCRibbonCategory::IsActive

指出功能區類別是否為功能區列的作用中類別。

BOOL IsActive() const;

傳回值

如果功能區類別是使用中類別,則為TRUE;否則為 FALSE。

備註

使用中的功能區類別會顯示其功能區面板。

CMFCRibbonCategory::IsVisible

指出功能區類別是否可見。

BOOL IsVisible() const;

傳回值

如果顯示功能區類別,則為TRUE;否則為 FALSE。

備註

可見的功能區類別會顯示類別索引標籤。

CMFCRibbonCategory::IsWindows7Look

指出父功能區是否有 Windows 7 外觀(小型矩形應用程式按鈕)。

BOOL IsWindows7Look() const;

傳回值

如果父功能區具有 Windows 7 外觀,則為 TRUE;否則為 FALSE。

備註

CMFCRibbonCategory::NotifyControlCommand

將WM_NOTIFY命令訊息傳遞至 CMFCRibbonPanel 中的所有 CMFCRibbonCategory 專案,直到處理訊息為止。

virtual BOOL NotifyControlCommand(
    BOOL bAccelerator,
    int nNotifyCode,
    WPARAM wParam,
    LPARAM lParam);

參數

bAccelerator
[in]如果此命令源自快捷鍵,則為TRUE,否則為 FALSE。

nNotifyCode
[in]通知碼。

wParam
[in]訊息的 WPARAM 欄位。

lParam
[in]訊息的 LPARAM 欄位。

傳回值

如果已處理訊息,則傳回 TRUE,否則傳回 FALSE。

備註

CMFCRibbonCategory::OnCancelMode

在的所有 CMFCRibbonPanel 元素 CMFCRibbonCategory中叫用取消模式。

virtual void OnCancelMode();

備註

CMFCRibbonCategory::OnDraw

由架構呼叫以繪製功能區類別目錄。

virtual void OnDraw(CDC* pDC);

參數

pDC
[in]功能區類別的裝置內容指標。

備註

CMFCRibbonCategory::OnDrawImage

由架構呼叫,以在功能區類別上繪製指定的影像。

virtual BOOL OnDrawImage(
    CDC* pDC,
    CRect rect,
    CMFCRibbonBaseElement* pElement,
    BOOL bIsLargeImage,
    BOOL nImageIndex,
    BOOL bCenter);

參數

pDC
[in]影像裝置內容的指標。

rect
[in]顯示影像的矩形。

pElement
[in]包含影像的功能區項目指標。

bIsLargeImage
[in]如果影像的大小很大,則為TRUE;如果影像的大小很小,則為 FALSE。

nImageIndex
[in]功能區類別中影像陣列中影像的以零起始的索引。

bCenter
[in]TRUE 表示在顯示矩形中置中影像;FALSE,在顯示矩形的左上角繪製影像。

傳回值

如果方法成功,則為TRUE;否則為 FALSE。

備註

CMFCRibbonCategory::OnDrawMenuBorder

由架構呼叫以繪製快捷功能表的框線。

virtual void OnDrawMenuBorder(
    CDC* pDC,
    CMFCRibbonPanelMenuBar* pMenuBar);

參數

pDC
[in]不使用此參數。

pMenuBar
[in]不使用此參數。

備註

根據預設,此方法不會執行任何動作。 覆寫此方法以繪製快捷功能表的框線。

CMFCRibbonCategory::OnKey

當使用者按下鍵盤按鈕時,由架構呼叫。

virtual BOOL OnKey(UINT nChar);

參數

nChar
使用者按下之按鍵的虛擬按鍵碼。

備註

CMFCRibbonCategory::OnLButtonDown

由架構呼叫,以在使用者按下滑鼠左鍵時擷取指定點下的功能區專案。

virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);

參數

point
[in]滑鼠指標的 x 和 y 座標,相對於視窗左上角。

傳回值

如果方法成功,則為功能區專案的指標;否則為 NULL。

備註

CMFCRibbonCategory::OnLButtonUp

當使用者放開滑鼠左鍵且指標位於功能區類別上方時,由架構呼叫。

virtual void OnLButtonUp(CPoint point);

參數

point
[in]指標的 x 和 y 座標,相對於視窗左上角。

備註

CMFCRibbonCategory::OnMouseMove

當指標在功能區列上移動以更新功能區類別顯示時,由架構呼叫。

virtual void OnMouseMove(CPoint point);

參數

point
[in]指標的 x 和 y 座標,相對於視窗左上角。

備註

CMFCRibbonCategory::OnRTLChanged

當版面配置變更方向時,由架構呼叫。

virtual void OnRTLChanged(BOOL bIsRTL);

參數

bIsRTL
[in]如果版面配置由右至左則為TRUE;如果版面配置由左至右,則為 FALSE。

備註

這個方法會調整功能區類別中包含的所有功能區面板和功能區元素的版面配置。

CMFCRibbonCategory::OnScrollHorz

以水準方向捲動功能區類別。

virtual BOOL OnScrollHorz(
    BOOL bScrollLeft,
    int nScrollOffset = 0);

參數

bScrollLeft
[in]TRUE 表示向左卷動;FALSE 則向右卷動。

nScrollOffset
[in]以像素為單位的滾動距離。

傳回值

如果功能區類別以水準方向移動,則為TRUE;否則為 FALSE。

備註

CMFCRibbonCategory::OnUpdateCmdUI

OnUpdateCmdUI呼叫 中每個CMFCRibbonPanel元素CMFCRibbonCategory中的成員函式,以啟用或停用其中的使用者介面專案。

virtual void OnUpdateCmdUI(
    CMFCRibbonCmdUI* pCmdUI,
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler);

參數

pCmdUI
[in] CMFCRibbonCmdUI 物件的指標,指定要啟用哪些使用者介面專案,以及要停用的專案。

pTarget
[in]控制使用者介面元素啟用或停用之視窗的指標。

bDisableIfNoHndler
[in]如果訊息對應中未定義任何處理程式,則為TRUE,以停用使用者介面專案;否則為 FALSE。

備註

CMFCRibbonCategory::RecalcLayout

調整功能區類別上所有控制件的配置。

virtual void RecalcLayout(CDC* pDC);

參數

pDC
[in]功能區類別的裝置內容指標。

備註

CMFCRibbonCategory::RemovePanel

從功能區類別中移除功能區面板。

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

參數

nIndex
[in]要移除之面板的索引編號。 藉由呼叫 CMFCRibbonCategory::GetPanelIndex 方法取得。

bDelete
[in]TRUE 可刪除記憶體中的面板物件;FALSE 可移除面板物件,而不刪除它。

傳回值

如果方法成功,則為TRUE;否則為 FALSE。

CMFCRibbonCategory::ReposPanels

調整功能區類別中所含功能區面板上所有控制件的配置。

virtual void ReposPanels(CDC* pDC);

參數

pDC
[in]功能區類別中所含功能區面板之裝置內容的指標。

備註

CMFCRibbonCategory::SetCollapseOrder

定義功能區類別目錄折疊功能區面板的順序。

void SetCollapseOrder(const CArray<int,int>& arCollapseOrder);

參數

arCollapseOrder
[in]指定折疊順序。 數位包含功能區面板以零起始的索引。

備註

連結庫會定義折疊順序。 不過,您可以藉由提供類別來指定折疊順序的索引清單,來自定義此行為。

當類別偵測到它必須折疊功能區面板時,它會尋找指定清單中的下一個專案。 如果清單是空的,或您尚未指定足夠的元素,則類別會使用內部演算法。

例如,類別有三個功能區面板,而且可以折疊數次,直到所有面板都處於完全折疊狀態為止。 您可以設定下列折疊順序:0、0、2、2。 在此情況下,類別將折疊面板0兩次,面板2兩次。 索引為 1 的面板會維持未收集。

範例

下列範例示範如何在 類別中使用 SetCollapseOrder CMFCRibbonCategory 方法。 此範例示範如何建構折疊順序的陣列,以及如何將折疊順序設定為功能區類別目錄。

CArray<int, int> arCollapseOrder;
arCollapseOrder.Add(0);
arCollapseOrder.Add(1);
arCollapseOrder.Add(2);
// CMFCRibbonCategory* pCategoryHome
pCategoryHome->SetCollapseOrder(arCollapseOrder);

CMFCRibbonCategory::SetData

設定要與功能區類別相關聯的使用者定義數據。

void SetData(DWORD_PTR dwData);

參數

dwData
[in]使用者定義的數據。

CMFCRibbonCategory::SetKeys

將按鍵提示指派給功能區類別目錄。

void SetKeys(LPCTSTR lpszKeys);

參數

lpszKeys
[in]按鍵提示文字。

備註

當使用者按下 Alt 鍵或 F10 鍵時,會顯示按鍵提示。

CMFCRibbonCategory::SetName

將名稱和索引鍵提示指派給功能區類別目錄。

void SetName(LPCTSTR lpszName);

參數

lpszName
[in]功能區類別的名稱和索引鍵提示。

備註

若要設定功能區類別的索引鍵提示,請將換行符逸出序列附加至 lpszName,後面接著索引鍵提示字元。

CMFCRibbonCategory::SetTabColor

設定功能區類別的色彩。

void SetTabColor(AFX_RibbonCategoryColor color);

參數

color
[in]指定功能區類別的新色彩。

備註

色彩可以是下列其中一個值:

  • AFX_CategoryColor_None

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

另請參閱

階層架構圖表
類別
CObject 類別