`CMFCRibbonBar` クラス

[アーティクル]
10/12/2023

CMFCRibbonBar クラスは、Office 2007 で使用されているものに似たリボンバーを実装します。

詳細については、Visual Studio インストール先の mfc フォルダーにあるソースコードを参照してください。たとえば、%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc のようにします。

構文

class CMFCRibbonBar : public CPane

メンバー

パブリックコンストラクター

名前	説明
`CMFCRibbonBar::CMFCRibbonBar`	既定のコンストラクターです。

パブリックメソッド

名前	説明
`CMFCRibbonBar::ActivateContextCategory`	既に表示されているコンテキストカテゴリをアクティブにします。
`CMFCRibbonBar::AddCategory`	新しいリボンカテゴリをリボンに追加します。
`CMFCRibbonBar::AddContextCategory`	コンテキストカテゴリを追加します。
`CMFCRibbonBar::AddMainCategory`	新しいメインリボンカテゴリを追加します。
`CMFCRibbonBar::AddPrintPreviewCategory`
`CMFCRibbonBar::AddQATOnlyCategory`
`CMFCRibbonBar::AddToTabs`	リボンバーの右側にリボン要素を追加します。
`CMFCRibbonBar::CreateEx`	コントロールバーを作成し、 `CPane` オブジェクトにアタッチします。 ( `CPane::CreateEx`をオーバーライドします)。
`CMFCRibbonBar::Create`	リボンバーコントロールを作成し、それをリボンバーにアタッチします。
`CMFCRibbonBar::DeactivateKeyboardFocus`
`CMFCRibbonBar::DrawMenuImage`
`CMFCRibbonBar::DWMCompositionChanged`
`CMFCRibbonBar::EnableKeyTips`	リボンコントロールのキーのヒントを有効または無効にします。
`CMFCRibbonBar::EnablePrintPreview`	[ Print Preview タブを有効にします。
`CMFCRibbonBar::EnableToolTips`	リボンバー上のツールヒントとその説明を有効または無効にします。
`CMFCRibbonBar::FindByData`	ユーザーが指定するデータを使用してリボン要素を検索します。
`CMFCRibbonBar::FindByID`	指定したコマンド ID を持つリボン要素を検索します。
`CMFCRibbonBar::FindCategoryIndexByData`	ユーザー定義データを含むリボンカテゴリのインデックスを検索します。
`CMFCRibbonBar::ForceRecalcLayout`
`CMFCRibbonBar::GetActiveCategory`	アクティブなカテゴリへのポインターを取得します。
`CMFCRibbonBar::GetCaptionHeight`	キャプションの高さを返します。 ( `CBasePane::GetCaptionHeight`をオーバーライドします)。
`CMFCRibbonBar::GetCategory`	指定されたインデックス位置にあるカテゴリへのポインターを取得します。
`CMFCRibbonBar::GetCategoryCount`	リボンバー内のリボンカテゴリの数を取得します。
`CMFCRibbonBar::GetCategoryHeight`
`CMFCRibbonBar::GetCategoryIndex`	リボンカテゴリのインデックスを返します。
`CMFCRibbonBar::GetContextName`	ID を使用して指定するコンテキストカテゴリキャプションの名前を取得します。
`CMFCRibbonBar::GetDroppedDown`
`CMFCRibbonBar::GetElementsByID`	指定された ID を持つすべてのリボン要素へのポインターが含まれている配列を取得します。
`CMFCRibbonBar::GetApplicationButton`	リボンボタンへのポインターを取得します。
`CMFCRibbonBar::GetFocused`	フォーカスされた要素を返します。
`CMFCRibbonBar::GetHideFlags`
`CMFCRibbonBar::GetItemIDsList`
`CMFCRibbonBar::GetKeyboardNavigationLevel`
`CMFCRibbonBar::GetKeyboardNavLevelCurrent`
`CMFCRibbonBar::GetKeyboardNavLevelParent`
`CMFCRibbonBar::GetMainCategory`	現在選択されているリボンカテゴリへのポインターを返します。
`CMFCRibbonBar::GetQATCommandsLocation`
`CMFCRibbonBar::GetQATDroppedDown`
`CMFCRibbonBar::GetQuickAccessCommands`	クイックアクセスツールバーに表示されるすべての要素のコマンド ID が含まれるリストにデータを入力します。
`CMFCRibbonBar::GetQuickAccessToolbarLocation`
`CMFCRibbonBar::GetTabTrancateRatio`
`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`
`CMFCRibbonBar::GetTooltipFixedWidthRegular`
`CMFCRibbonBar::GetVisibleCategoryCount`
`CMFCRibbonBar::HideAllContextCategories`	アクティブかつ表示中のすべてのカテゴリを非表示にします。
`CMFCRibbonBar::HideKeyTips`
`CMFCRibbonBar::HitTest`	リボンバーのクライアント座標の指定されたポイントに位置するリボン要素へのポインターを検索します。
`CMFCRibbonBar::IsKeyTipEnabled`	keytip が有効かどうかを決定します。
`CMFCRibbonBar::IsMainRibbonBar`
`CMFCRibbonBar::IsPrintPreviewEnabled`	[ Print Preview タブが有効かどうかを判断します。
`CMFCRibbonBar::IsQATEmpty`
`CMFCRibbonBar::IsQuickAccessToolbarOnTop`	クイックアクセスツールバーがリボンバーの上に配置されるかどうかを指定します。
`CMFCRibbonBar::IsReplaceFrameCaption`	リボンバーでメインフレームキャプションを置き換えるか、またはフレームキャプションの下に追加するかを決定します。
`CMFCRibbonBar::IsShowGroupBorder`
`CMFCRibbonBar::IsToolTipDescrEnabled`	ツールヒントの説明が有効かどうかを決定します。
`CMFCRibbonBar::IsToolTipEnabled`	リボンバーのツールヒントが有効かどうかを決定します。
`CMFCRibbonBar::IsTransparentCaption`
`CMFCRibbonBar::IsWindows7Look`	リボンの外観が Windows 7 スタイル (小さな四角形のアプリケーションボタン) であるかどうかを示します。
`CMFCRibbonBar::LoadFromResource`	過負荷です。アプリケーションリソースからリボンバーを読み込みます。
`CMFCRibbonBar::OnClickButton`
`CMFCRibbonBar::OnEditContextMenu`
`CMFCRibbonBar::OnRTLChanged`	( `CPane::OnRTLChanged`をオーバーライドします)。
`CMFCRibbonBar::OnSetAccData`	( `CBasePane::OnSetAccData`をオーバーライドします)。
`CMFCRibbonBar::OnShowRibbonContextMenu`
`CMFCRibbonBar::OnShowRibbonQATMenu`
`CMFCRibbonBar::OnSysKeyDown`
`CMFCRibbonBar::OnSysKeyUp`
`CMFCRibbonBar::PopTooltip`
`CMFCRibbonBar::PreTranslateMessage`	( `CBasePane::PreTranslateMessage`をオーバーライドします)。
`CMFCRibbonBar::RecalcLayout`	( `CPane::RecalcLayout`をオーバーライドします)。
`CMFCRibbonBar::RemoveAllCategories`	リボンバーからすべてのリボンカテゴリを削除します。
`CMFCRibbonBar::RemoveAllFromTabs`	タブ領域からすべてのリボン要素を削除します。
`CMFCRibbonBar::RemoveCategory`	指定されたインデックス位置にあるリボンカテゴリを削除します。
`CMFCRibbonBar::SaveToXMLBuffer`	リボンバーをバッファーに保存します。
`CMFCRibbonBar::SaveToXMLFile`	リボンバーを XML ファイルに保存します。
`CMFCRibbonBar::SetActiveCategory`	指定されたリボンカテゴリをアクティブに設定します。
`CMFCRibbonBar::SetActiveMDIChild`
`CMFCRibbonBar::SetElementKeys`	指定された keytip を、指定されたコマンド ID を持つすべてのリボン要素に対して設定します。
`CMFCRibbonBar::SetApplicationButton`	リボンバーにアプリケーションリボンボタンを割り当てます。
`CMFCRibbonBar::SetKeyboardNavigationLevel`
`CMFCRibbonBar::SetMaximizeMode`
`CMFCRibbonBar::SetQuickAccessCommands`	クイックアクセスツールバーに 1 つ以上のリボン要素を追加します。
`CMFCRibbonBar::SetQuickAccessDefaultState`	クイックアクセスツールバーの既定の状態を指定します。
`CMFCRibbonBar::SetQuickAccessToolbarOnTop`	クイックアクセスツールバー (QAT) を、リボンバーの上または下に配置します。
`CMFCRibbonBar::SetTooltipFixedWidth`
`CMFCRibbonBar::SetWindows7Look`	リボンの Windows 7 スタイル (小さな四角形のアプリケーションボタン) の外観を有効または無効にします。
`CMFCRibbonBar::ShowCategory`	指定されたリボンカテゴリを表示または非表示にします。
`CMFCRibbonBar::ShowContextCategories`	指定された ID を持つコンテキストカテゴリを表示または非表示にします。
`CMFCRibbonBar::ShowKeyTips`
`CMFCRibbonBar::ToggleMimimizeState`	リボンバーの最小化された状態と最大化された状態を切り替えます。
`CMFCRibbonBar::TranslateChar`

解説

Microsoft は、Microsoft Office 2007 のリリースと同時に Office Fluent Ribbon を導入しました。このリボンバーは、単なる新しいコントロールではありません。新たなユーザーインターフェイスのパラダイムを表すものです。リボンとは、カテゴリと呼ばれるタブのセットを含むウィンドウです。各カテゴリは論理的にリボンパネルへと分割され、各パネルにはさまざまなコントロールやコマンドボタンを追加することができます。

リボンバーに表示される要素を拡大および縮小することで、スペースを最大限に活用します。たとえば、リボンパネルに要素を表示するための十分なスペースがない場合、リボンパネルはポップアップメニューにサブアイテムを表示するメニューボタンになります。リボンバーは、静的 (フローティングでない) コントロールバーとして動作し、フレームの上部にドッキングできます。

CMFCRibbonStatusBar クラスを使用すると、Office 2007 で使われているようなステータスバーを実装できます。リボンカテゴリには、リボンパネルのグループが含まれています (表示。各リボンパネルには、 CMFCRibbonBaseElementから派生した 1 つ以上のリボン要素が含まれています。

既存の MFC アプリケーションにリボンバーを追加する方法については、「 Walkthrough: MFC Scribble アプリケーションの更新」を参照してください。

継承階層

要件

ヘッダー: afxribbonbar.h

`CMFCRibbonBar::ActivateContextCategory`

既に表示されているコンテキストカテゴリをアクティブにします。

BOOL ActivateContextCategory(UINT uiContextID);

パラメーター

uiContextID
[in]コンテキストカテゴリ ID。

戻り値

TRUEuiContextIDを持つコンテキストカテゴリが見つかり、アクティブ化された場合は。それ以外の場合はFALSE。

`CMFCRibbonBar::AddCategory`

リボンバーの新しいリボンカテゴリを作成して初期化します。

CMFCRibbonCategory* AddCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage= CSize(16,
    16),
    CSize sizeLargeImage= CSize(32,
    32),
    int nInsertAt = -1,
    CRuntimeClass* pRTI= NULL);

パラメーター

lpszName
[in]リボンカテゴリの名前。

uiSmallImagesResID
[in]リボンカテゴリの小さなイメージリストのリソース ID。

uiLargeImagesResID
[in]リボンカテゴリの大きなイメージリストのリソース ID。

sizeSmallImage
[in]リボンカテゴリの小さい画像のサイズを指定します。

sizeLargeImage
[in]リボンカテゴリの大きな画像のサイズを指定します。

nInsertAt
[in]カテゴリの場所の 0 から始まるインデックス。

pRTI
[in]実行時にリボンカテゴリを動的に作成するための CMFCRibbonCategory クラスランタイムクラスへのポインター。

戻り値

メソッドが成功した場合の新しいリボンカテゴリへのポインター。それ以外の場合は NULL。

解説

pRTI パラメーターがNULLされていない場合は、ランタイムクラスを使用して新しいリボンカテゴリが動的に作成されます。

例

次の例では、CMFCRibbonBar クラスで AddCategory メソッドを使用する方法を示します。

// Add "Home" category.
// CMFCRibbonBar m_wndRibbonBar
strTemp.LoadString(IDS_RIBBON_HOME);
CMFCRibbonCategory *pCategoryHome = m_wndRibbonBar.AddCategory(strTemp,
                                                               IDB_WRITESMALL, IDB_WRITELARGE);

`CMFCRibbonBar::AddContextCategory`

リボンバーの新しいコンテキストカテゴリを作成して初期化します。

CMFCRibbonCategory* AddContextCategory(
    LPCTSTR lpszName,
    LPCTSTR lpszContextName,
    UINT uiContextID,
    AFX_RibbonCategoryColor clrContext,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32),
    CRuntimeClass* pRTI = NULL);

パラメーター

lpszName
[in]カテゴリの名前。

lpszContextName
[in]コンテキストカテゴリのキャプションの名前。

uiContextID
[in]コンテキスト ID。

clrContext
[in]コンテキストカテゴリのキャプションの色。

uiSmallImagesResID
[in]コンテキストカテゴリの小さなイメージのリソース ID。

uiLargeImagesResID
[in]コンテキストカテゴリの大きなイメージのリソース ID。

sizeSmallImage
[in]小さい画像のサイズ。

sizeLargeImage
[in]大きな画像のサイズ。

pRTI
[in]ランタイムクラスへのポインター。

戻り値

新しく作成されたカテゴリへのポインター。または、pRTIのCreateObject メソッドが指定したカテゴリを作成できない場合にNULLします。

解説

この関数を使用して、コンテキストカテゴリを追加します。コンテキストカテゴリは、現在のアプリケーションコンテキストに応じて実行時に表示または非表示にできる特殊な種類のカテゴリです。たとえば、ユーザーがオブジェクトを選択すると、特定の選択したオブジェクトを変更するために使用するコンテキストカテゴリを含む特別なタブを表示できます。

コンテキストカテゴリの色には、次のいずれかの値を指定できます。

AFX_CategoryColor_None
AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet

`CMFCRibbonBar::AddMainCategory`

リボンバーの新しいメインリボンカテゴリを作成します。

CMFCRibbonMainPanel* AddMainCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

パラメーター

lpszName
[in]メインリボンカテゴリの名前。

uiSmallImagesResID
[in]小さなイメージのリソース ID。

uiLargeImagesResID
[in]大きなイメージのリソース ID。

sizeSmallImage
[in]小さい画像のサイズ。

sizeLargeImage
[in]大きな画像のサイズ。

戻り値

メソッドが成功した場合は、新しいメインリボンカテゴリへのポインター。それ以外の場合は NULL。

解説

メインリボンカテゴリが既に存在する場合は削除されます。

例

次の例では、CMFCRibbonBar クラスで AddMainCategory メソッドを使用する方法を示します。

// m_wndRibbonBar is declared as a protected member variable
// CMFCRibbonBar m_wndRibbonBar.
// strTemp is a CString variable.
strTemp.LoadString(IDS_RIBBON_FILE);
CMFCRibbonMainPanel *pMainPanel = m_wndRibbonBar.AddMainCategory(strTemp,
                                                                 IDB_FILESMALL, IDB_FILELARGE);

`CMFCRibbonBar::AddPrintPreviewCategory`

リボンバーに印刷プレビューカテゴリを作成します。

CMFCRibbonCategory* AddPrintPreviewCategory();

戻り値

メソッドが成功した場合の新しいリボンカテゴリへのポインター。それ以外の場合は NULL。

解説

このメソッドは、印刷プレビューを提供するために必要なリボンカテゴリとコントロールを作成します。

`CMFCRibbonBar::AddQATOnlyCategory`

クイックアクセスツールバーのリボンカテゴリを作成します。

CMFCRibbonCategory* AddQATOnlyCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    CSize sizeSmallImage = CSize(16,
    16));

パラメーター

lpszName
[in]カテゴリの名前。

uiSmallImagesResID
[in]カテゴリのイメージリストのリソース ID。

sizeSmallImage
[in]カテゴリ内のリボン要素の画像のサイズ。

戻り値

メソッドが成功した場合の新しいカテゴリへのポインター。それ以外の場合は NULL。

解説

クイックアクセスツールバーのリボンカテゴリは、[クイックアクセスツールバーのカスタマイズ] ダイアログボックスでのみ使用されます。

`CMFCRibbonBar::AddToTabs`

指定したリボン要素をリボンバーのタブ行に追加します。

void AddToTabs(CMFCRibbonBaseElement* pElement);

パラメーター

pElement
[in]リボン要素へのポインター。

解説

リボン要素は、システムボタンの前に配置されます。

`CMFCRibbonBar::CMFCRibbonBar`

CMFCRibbonBar オブジェクトを構築して初期化します。

CMFCRibbonBar(BOOL bReplaceFrameCaption = TRUE);

パラメーター

bReplaceFrameCaption
[入力] TRUE メインフレームウィンドウのキャプションを置き換えるリボンバー。 FALSE 、メインフレームウィンドウのキャプションの下にリボンバーを配置します。

解説

`CMFCRibbonBar::Create`

リボンバーのウィンドウを作成します。

BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

パラメーター

pParentWnd
[in]リボンバーの親ウィンドウへのポインター。

dwStyle
[in]新しいウィンドウのスタイルの論理的な組み合わせ。

nID
[in]新しいウィンドウの ID。

戻り値

TRUE ウィンドウが作成された場合。それ以外の場合は FALSE。

解説

例

次の例では、CMFCRibbonBar クラスの Create メソッドを使用する方法を示します。

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.Create(this, WS_CHILD | CBRS_TOP);

`CMFCRibbonBar::CreateEx`

リボンバーのウィンドウを作成します。

BOOL CreateEx(
    CWnd* pParentWnd,
    DWORD dwCtrlStyle = 0,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

パラメーター

pParentWnd
[in]リボンバーの親ウィンドウへのポインター。

dwCtrlStyle
[in]このパラメーターは使用されません。

dwStyle
[in]新しいウィンドウのスタイルの論理的な組み合わせ。

nID
[in]新しいウィンドウの ID。

戻り値

TRUE ウィンドウが作成された場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::DeactivateKeyboardFocus`

リボンバーのすべてのキーヒントコントロールを閉じます。

void DeactivateKeyboardFocus(BOOL bSetFocus = TRUE);

パラメーター

bSetFocus
[入力] TRUE をクリックして、リボンバーの親ウィンドウにフォーカスを設定します。

解説

`CMFCRibbonBar::DrawMenuImage`

メニューボタンの画像を描画します。

BOOL DrawMenuImage(
    CDC* pDC,
    const CMFCToolBarMenuButton* pMenuItem,
    const CRect& rectImage);

パラメーター

pDC
[in]メニューボタンのデバイスコンテキストへのポインター。

pMenuItem
[in]ツールバーメニューボタンへのポインター。

rectImage
[in]メニューボタンの表示四角形。

戻り値

TRUE 画像が描画された場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::DWMCompositionChanged`

デスクトップウィンドウマネージャー (DWM) コンポジションが有効または無効になっている場合のリボンバーの表示を調整します。

virtual void DWMCompositionChanged();

解説

`CMFCRibbonBar::EnableKeyTips`

リボンバーのキーヒント機能を有効または無効にします。

void EnableKeyTips(BOOL bEnable = TRUE);

パラメーター

bEnable
[入力] TRUE キーヒント機能を有効にするには、キーヒント機能を無効にする FALSE 。

解説

この機能を有効にすると、ユーザーが ALT または F10 キーを押すと、キーヒントが表示されます。ユーザーが ALT キーを押すと、200 ミリ秒の遅延でキーヒントが表示されます。この遅延により、ショートカットを実行して、押された ALT キーが、 ALT キーを含む他の組み合わせと干渉しないようにすることができます。

`CMFCRibbonBar::EnablePrintPreview`

Print Preview 機能を有効または無効にします。

void EnablePrintPreview(BOOL bEnable = TRUE);

パラメーター

bEnable
[入力] TRUEPrint Preview 機能を有効にする場合は >。Print Preview 機能を無効にするFALSE。

解説

bEnableがFALSEされ、印刷プレビューカテゴリが存在する場合は、削除されます。

既定では、 Print Preview 機能が有効になっています。

`CMFCRibbonBar::EnableToolTips`

リボンバーのヒントとオプションのツールヒントの説明を有効または無効にします。

void EnableToolTips(
    BOOL bEnable = TRUE,
    BOOL bEnableDescr = TRUE);

パラメーター

bEnable
[入力] TRUE リボンバーでツールヒントを有効にするにはリボンバーのツールヒントを無効にする FALSE します。

bEnableDescr
[入力] TRUE ツールヒントの説明を有効にするには、ツールヒントの説明を無効にする FALSE します。

解説

bEnable パラメーターは、マウスがリボン要素の上に置かれたときにヒントを表示するかどうかを決定します。 bEnableDescr パラメーターは、追加の説明テキストがツールヒントテキストと共に表示されるかどうかを決定します。

`CMFCRibbonBar::FindByData`

指定されたデータと可視性を持つリボン要素へのポインターを取得します。

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

パラメーター

dwData
[in]リボン要素に関連付けられているデータ。

bVisibleOnly
[入力] TRUE 表示されているリボン要素のみを検索する場合。 FALSE して、すべてのリボン要素を検索します。

戻り値

指定されたデータと可視性を持つリボン要素へのポインター。それ以外の場合は NULL。

解説

リボン要素は、リボンボタン、リボンカテゴリ、リボンスライダーなど、リボンに追加できる任意のコントロールです。

`CMFCRibbonBar::FindByID`

指定したコマンド ID と検索値を持つリボン要素へのポインターを取得します。

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

パラメーター

uiCmdID
[in]リボン要素のコマンド ID。

bVisibleOnly
[入力] TRUE 表示されているリボン要素のみを検索する場合。 FALSE して、すべてのリボン要素を検索します。

bExcludeQAT
[入力] TRUE クイックアクセスツールバー要素を検索から除外する場合。それ以外の場合は FALSE。

戻り値

指定したコマンド ID と検索値を持つリボン要素へのポインター。それ以外の場合は NULL。

解説

リボン要素は、リボンボタン、リボンカテゴリ、リボンスライダーなど、リボンに追加できる任意のリボンコントロールです。

一般に、同じコマンド ID を持つリボン要素が複数存在する場合があります。指定したコマンド ID を使用するすべてのリボン要素へのポインターを取得する場合は、 CMFCRibbonBar::GetElementsByID メソッドを使用します。

`CMFCRibbonBar::FindCategoryIndexByData`

指定したデータを含むリボンカテゴリのインデックスを取得します。

int FindCategoryIndexByData(DWORD dwData) const;

パラメーター

dwData
[in]リボンカテゴリに関連付けられているデータ。

戻り値

メソッドが成功した場合のリボンカテゴリの 0 から始まるインデックス。それ以外の場合は -1。

`CMFCRibbonBar::ForceRecalcLayout`

リボンバーと親ウィンドウ内のすべての項目のレイアウトを調整し、ウィンドウ全体を再描画します。

void ForceRecalcLayout();

解説

`CMFCRibbonBar::GetActiveCategory`

アクティブなリボンカテゴリへのポインターを取得します。

CMFCRibbonCategory* GetActiveCategory() const;

戻り値

アクティブなリボンカテゴリへのポインター。または、カテゴリがアクティブでない場合は NULL 。

解説

カテゴリにフォーカスがある場合はアクティブです。既定では、アクティブなカテゴリはリボンバーの左側にある最初のカテゴリです。

メインカテゴリは、ユーザーがアプリケーションボタンを押したときに表示され、アクティブなカテゴリにすることはできません。

`CMFCRibbonBar::GetApplicationButton`

アプリケーションボタンへのポインターを取得します。

CMFCRibbonApplicationButton* GetApplicationButton() const;

戻り値

アプリケーションボタンへのポインター。ボタンが設定されていない場合は NULL します。

`CMFCRibbonBar::GetCaptionHeight`

リボンバーのキャプション領域の高さを取得します。

int GetCaptionHeight() const;

戻り値

リボンバーのキャプション領域の高さ (ピクセル単位)。

解説

`CMFCRibbonBar::GetCategory`

指定したインデックス位置にあるリボンカテゴリへのポインターを取得します。

CMFCRibbonCategory* GetCategory(int nIndex) const;

パラメーター

nIndex
[in]リボンバーに含まれるリボンカテゴリの一覧にあるリボンカテゴリの 0 から始まるインデックス。

戻り値

指定したインデックス位置にあるリボンカテゴリへのポインター。それ以外の場合は、nIndexが範囲外の場合にNULLします。

`CMFCRibbonBar::GetCategoryCount`

リボンバーのリボンカテゴリの数を取得します。

int GetCategoryCount() const;

戻り値

リボンバーのリボンカテゴリの数。

`CMFCRibbonBar::GetCategoryHeight`

カテゴリの高さを取得します。

int GetCategoryHeight() const;

戻り値

カテゴリの高さ。

解説

カテゴリの高さには、カテゴリタブの高さが含まれます。

`CMFCRibbonBar::GetCategoryIndex`

指定したリボンカテゴリのインデックスを取得します。

int GetCategoryIndex(CMFCRibbonCategory* pCategory) const;

パラメーター

pCategory
[in]リボンカテゴリへのポインター。

戻り値

pCategoryで指定されたリボンカテゴリの 0 から始まるインデックス。リボンカテゴリが見つからない場合は -1。

`CMFCRibbonBar::GetContextName`

コンテキスト ID で指定されたコンテキストカテゴリキャプションの名前を取得します。

BOOL GetContextName(
    UINT uiContextID,
    CString& strName) const;

パラメーター

uiContextID
[in]リボンカテゴリコンテキスト ID。

strName
[out]コンテキストカテゴリキャプションの名前。

戻り値

TRUEメソッドが成功した場合。それ以外の場合は、uiContextIDが 0 であったか、コンテキストカテゴリのキャプションが見つからなかった場合にFALSEします。

`CMFCRibbonBar::GetDroppedDown`

現在ドロップダウンされているリボン要素を取得します。

virtual CMFCRibbonBaseElement* GetDroppedDown();

戻り値

現在ドロップダウンされているリボン要素。または、リボン要素が現在ドロップダウンされていない場合に NULL します。

解説

`CMFCRibbonBar::GetElementsByID`

特定のコマンド ID を持つすべてのリボン要素へのポインターの配列を取得します。

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

パラメーター

uiCmdID
[in]リボン要素のコマンド ID。

arButtons
[out]リボン要素へのポインターの配列。

解説

一部のリボン要素はクイックアクセスツールバーにコピーできるため、複数のリボン要素に同じコマンド ID を設定できます。

`CMFCRibbonBar::GetHideFlags`

表示されるリボンバーの量を示すフラグを取得します。

DWORD GetHideFlags() const;

戻り値

表示されるリボンバーの量を示すフラグ。

解説

次の表に、戻り値に使用できるフラグの組み合わせを示します。

フラグ	説明
`AFX_RIBBONBAR_HIDE_ELEMENTS`	リボンバーは垂直方向に最小化され、カテゴリタブ、メインボタン、クイックアクセスツールバーのみが表示されます。
`AFX_RIBBONBAR_HIDE_ALL`	リボンバーの幅は最小幅より小さく、完全に非表示になります。

`CMFCRibbonBar::GetItemIDsList`

リボンバー上のリボン要素の指定したコレクションのコマンド ID を取得します。

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

パラメーター

lstItems
[out]リボンバーに含まれるリボン要素のコマンド ID の一覧。

bHiddenOnly
[入力] TRUE 表示されるリボン要素を除外する場合。リボンバーにすべてのリボン要素を含める FALSE します。

解説

`CMFCRibbonBar::GetKeyboardNavigationLevel`

ユーザーがリボンバーに含まれているキーヒントを押すと、現在のナビゲーションレベルを取得します。

int GetKeyboardNavigationLevel() const;

戻り値

ユーザーがリボンバーに含まれているキーヒントを押す現在のナビゲーションレベル。次の表に、可能な戻り値の一覧を示します。

Value	説明
-1	キーヒントは表示されません。
0	キーヒントが表示されます。
1	ユーザーが表示されたキーヒントを押しました。

解説

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

リボンバーの現在のキーボードナビゲーションオブジェクトを取得します。

CObject* GetKeyboardNavLevelCurrent() const;

戻り値

リボンバーの現在のキーボードナビゲーションオブジェクト。それ以外の場合は、現在キーヒントが表示されているオブジェクトがない場合に NULL 。

解説

現在キーヒントを表示しているオブジェクトは、現在のキーボードナビゲーションオブジェクトです。

`CMFCRibbonBar::GetKeyboardNavLevelParent`

リボンバーの親キーボードナビゲーションオブジェクトを取得します。

CObject* GetKeyboardNavLevelParent() const;

戻り値

リボンバーの親キーボードナビゲーションオブジェクト。それ以外の場合は NULL。

解説

ユーザーがリボンバーのキーヒントを押すと、現在のキーボードナビゲーションオブジェクトが親キーボードナビゲーションオブジェクトになります。

`CMFCRibbonBar::GetMainCategory`

メインリボンカテゴリへのポインターを取得します。

CMFCRibbonCategory* GetMainCategory() const;

戻り値

メインリボンカテゴリへのポインター。

解説

メインリボンカテゴリには、メインリボンパネルが含まれています。

`CMFCRibbonBar::GetQATCommandsLocation`

クイックアクセスツールバーのコマンドセクションの表示四角形を取得します。

CRect GetQATCommandsLocation() const;

戻り値

クイックアクセスツールバーのコマンドセクションの表示四角形。

解説

表示四角形のコマンドセクションには、カスタマイズボタンは含まれません。

`CMFCRibbonBar::GetQATDroppedDown`

ポップアップメニューがドロップダウンされているクイックアクセスツールバーのリボン要素へのポインターを取得します。

CMFCRibbonBaseElement* GetQATDroppedDown();

戻り値

ポップアップメニューがドロップダウンされているクイックアクセスツールバーのリボン要素へのポインター。

解説

`CMFCRibbonBar::GetQuickAccessCommands`

クイックアクセスツールバーのリボン要素のコマンド ID の一覧を取得します。

void GetQuickAccessCommands(CList<UINT,UINT>& lstCommands);

パラメーター

lstCommands
[out]クイックアクセスツールバーのリボン要素のコマンド ID の一覧。

解説

リストには、コントロールの区切り記号であるリボン要素は含まれません。

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

クイックアクセスツールバーの表示四角形を取得します。

CRect GetQuickAccessToolbarLocation() const;

戻り値

クイックアクセスツールバーの表示四角形。

解説

`CMFCRibbonBar::GetTabTrancateRatio`

カテゴリタブの表示幅の縮小率を取得します。

int GetTabTrancateRatio() const;

戻り値

カテゴリタブの表示幅のサイズ削減率。

解説

リボンバーに十分な幅がない場合、カテゴリタブの幅が小さくなります。

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

リボンバーのツールヒントの幅の大きいサイズを取得します。

int GetTooltipFixedWidthLargeImage() const;

戻り値

ヒントの幅の大きいサイズ (ピクセル単位)。

解説

ツールヒントの幅の大きいサイズが 0 の場合、幅は異なります。

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

リボンバーのツールヒントの幅の通常のサイズを取得します。

int GetTooltipFixedWidthRegular() const;

戻り値

ヒントの幅の通常のサイズ (ピクセル単位)。

解説

ツールヒントの幅の通常のサイズが 0 の場合、幅は異なります。

`CMFCRibbonBar::GetVisibleCategoryCount`

リボンバーに表示されるカテゴリの数を取得します。

int GetVisibleCategoryCount() const;

戻り値

リボンバーに表示されるカテゴリの数。

解説

`CMFCRibbonBar::HideAllContextCategories`

リボンバーのすべてのコンテキストカテゴリを非表示にします。

BOOL HideAllContextCategories();

戻り値

TRUE 少なくとも 1 つのコンテキストカテゴリが非表示の場合。それ以外の場合は FALSE。

解説

コンテキストカテゴリがアクティブな場合、アクティブなカテゴリはカテゴリリストの最初に表示されるカテゴリにリセットされます。

`CMFCRibbonBar::HideKeyTips`

リボンバーのすべてのキーヒントを非表示にします。

void HideKeyTips();

解説

`CMFCRibbonBar::HitTest`

ポイントの位置で指定されたリボン要素へのポインターを取得します。

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

パラメーター

point
[in]リボンバー座標内のポイントの位置。

bCheckActiveCategory
[入力] TRUE アクティブなカテゴリを検索する場合。 FALSE アクティブなカテゴリを検索しません。

bCheckPanelCaption
[入力] TRUE リボンパネルのキャプションを、その中に位置するポイントでテストする場合。 FALSE 、リボンパネルのキャプションを、その中にあるポイントでテストしないようにします。詳細については、「解説」セクションを参照してください。

戻り値

指定したポイントにあるリボン要素へのポインター。それ以外の場合は、ポイントがリボン要素に配置されていない場合に NULL 。

解説

ポイントがあるリボンパネルのキャプションは、 bCheckActiveCategory パラメーターが TRUEされていない限りテストされません。

`CMFCRibbonBar::IsKeyTipEnabled`

キーヒント機能が有効かどうかを示します。

BOOL IsKeyTipEnabled() const;

戻り値

TRUE キーヒント機能が有効になっている場合。それ以外の場合は FALSE。

`CMFCRibbonBar::IsMainRibbonBar`

リボンバーがプライマリリボンバーかどうかを示します。

virtual BOOL IsMainRibbonBar() const;

戻り値

常に TRUE を返します。

解説

既定では、このメソッドは常に TRUEを返します。リボンバーがプライマリリボンバーであるかどうかを示すには、このメソッドをオーバーライドします。

`CMFCRibbonBar::IsPrintPreviewEnabled`

Print Preview 機能が有効かどうかを示します。

BOOL IsPrintPreviewEnabled() const;

戻り値

TRUEPrint Preview 機能が有効な場合は。それ以外の場合はFALSE。

`CMFCRibbonBar::IsQATEmpty`

クイックアクセスツールバーにコマンドボタンが含まれているかどうかを示します。

BOOL IsQATEmpty() const;

戻り値

TRUE クイックアクセスツールバーにコマンドボタンが含まれている場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::IsQuickAccessToolbarOnTop`

クイックアクセスツールバーがリボンバーの上または下に配置されているかどうかを示します。

BOOL IsQuickAccessToolbarOnTop() const;

戻り値

TRUE クイックアクセスツールバーがリボンバーの上にある場合。クイックアクセスツールバーがリボンバーの下にある場合に FALSE します。

`CMFCRibbonBar::IsReplaceFrameCaption`

リボンバーがメインフレームウィンドウのキャプションに置き換えられるか、下にあるかを示します。

BOOL IsReplaceFrameCaption() const;

戻り値

TRUE リボンバーがメインフレームウィンドウのキャプションを置き換える場合。リボンバーがメインフレームウィンドウのキャプションの下にある場合に FALSE します。

`CMFCRibbonBar::IsShowGroupBorder`

リボンバーにあるボタングループにグループ罫線を表示するかどうかを示します。

virtual BOOL IsShowGroupBorder(CMFCRibbonButtonsGroup* pGroup) const;

パラメーター

pGroup
[in]このパラメーターは使用されません。

戻り値

常に FALSE を返します。

解説

既定では、このメソッドは常に FALSEを返します。リボンバーにあるボタングループにグループ罫線が表示されるかどうかを示すには、このメソッドをオーバーライドします。

`CMFCRibbonBar::IsToolTipDescrEnabled`

ツールヒントの説明が有効かどうかを示します。

BOOL IsToolTipDescrEnabled() const;

戻り値

TRUE ツールヒントの説明が有効な場合。ツールヒントの説明が無効になっている場合に FALSE します。

解説

ヒントの説明は、ツールヒントテキストと共に表示される追加の説明テキストです。

`CMFCRibbonBar::IsToolTipEnabled`

リボンバーのツールヒントが有効か無効かを示します。

BOOL IsToolTipEnabled() const;

戻り値

TRUE ヒントが有効な場合は〗。ツールヒントが無効になっている場合に FALSE します。

`CMFCRibbonBar::IsTransparentCaption`

Windows Aero 配色の表示が設定されているかどうかを示します。

BOOL IsTransparentCaption() const;

戻り値

TRUE 配色が Windows Aero の場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::OnClickButton`

このメソッドは、既存のアプリケーションとの下位互換性のために保持されるため、新しい開発には使用しないでください。

virtual void OnClickButton(
    CMFCRibbonButton* pButton,
    CPoint point);

パラメーター

pButton
[in]クリックされたボタンへのポインター。

point
[in]このパラメーターは使用されません。

解説

`CMFCRibbonBar::OnEditContextMenu`

virtual void OnEditContextMenu(
    CMFCRibbonRichEditCtrl* pEdit,
    CPoint point);

パラメーター

[入力] pEdit
[入力] point\

解説

`CMFCRibbonBar::OnRTLChanged`

レイアウトの方向が変わるときにフレームワークによって呼び出されます。

virtual void OnRTLChanged(BOOL bIsRTL);

パラメーター

bIsRTL
[入力] TRUE レイアウトが右から左の場合。レイアウトが左から右の場合に FALSE します。

解説

このメソッドは、リボンバー上のすべてのコントロールのレイアウトを新しいレイアウト方向に合わせて調整します。

`CMFCRibbonBar::OnSetAccData`

このメソッドはフレームワークの内部であり、ユーザーコードから呼び出すことを意図していません。

BOOL OnSetAccData(long lVal);

パラメーター

long lVal アクセス可能なオブジェクトのインデックス。

戻り値

S_OK 成功した場合。それ以外の場合は FALSE または S_FALSE。

解説

`CMFCRibbonBar::OnShowRibbonContextMenu`

virtual BOOL OnShowRibbonContextMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

パラメーター

[入力] pWnd
[入力] x
[入力] y
[入力] pHit\

戻り値

解説

`CMFCRibbonBar::OnShowRibbonQATMenu`

virtual BOOL OnShowRibbonQATMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

パラメーター

[入力] pWnd
[入力] x
[入力] y
[入力] pHit\

戻り値

解説

`CMFCRibbonBar::OnSysKeyDown`

ユーザーが F10 キーを押すか、 ALT キーを押しながら別のキーを押したときに、フレームワークによって呼び出されます。

BOOL OnSysKeyDown(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

パラメーター

pFrameWnd
[in]リボンバーの親メインフレームウィンドウへのポインター。

wParam
[in]押されているキーの仮想キーコード。

lParam
[in]キーが押されたときのキーボード状態フラグ。

戻り値

TRUE キーストロークイベントが処理された場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::OnSysKeyUp`

ユーザーが F10 キー、 ALT キー、または ALT キーが押されたときに押されたキーを解放するときに、フレームワークによって呼び出されます。

BOOL OnSysKeyUp(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

パラメーター

pFrameWnd
[in]リボンバーの親メインフレームウィンドウへのポインター。

wParam
[in]リリースされるキーの仮想キーコード。

lParam
[in]このパラメーターは使用されません。

戻り値

TRUE キーストロークイベントが処理された場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::PopTooltip`

ビューからヒントを削除します。

void PopTooltip();

解説

`CMFCRibbonBar::PreTranslateMessage`

指定したメッセージがリボンバーによって処理されるかどうかを判断します。

virtual BOOL PreTranslateMessage(MSG* pMsg);

パラメーター

pMsg
[in]メッセージへのポインター。

戻り値

TRUE メッセージがリボンバーによって処理された場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::RecalcLayout`

リボンバー上のすべてのコントロールのレイアウトを調整します。

virtual void RecalcLayout();

解説

レイアウト調整後、リボンバーの表示が更新されます。

`CMFCRibbonBar::RemoveAllCategories`

リボンバーからすべてのリボンカテゴリを削除します。

void RemoveAllCategories();

解説

このメソッドは、メモリとカテゴリリストからすべてのリボンカテゴリを削除します。

`CMFCRibbonBar::RemoveAllFromTabs`

タブ領域からすべてのリボン要素を削除します。

void RemoveAllFromTabs();

解説

この関数は、 CMFCRibbonBar::AddToTabs メソッドを使用してタブ領域に追加したすべての要素を削除する場合に使用します。

`CMFCRibbonBar::RemoveCategory`

指定したリボンカテゴリをリボンバーから削除します。

BOOL RemoveCategory(int nIndex);

パラメーター

nIndex
[in]リボンバーに含まれるリボンカテゴリの一覧のカテゴリの 0 から始まるインデックス。

戻り値

TRUE 指定したリボンカテゴリが削除された場合。それ以外の場合は FALSE。

解説

指定したリボンカテゴリは、メモリとカテゴリリストから削除されます。

`CMFCRibbonBar::SetActiveCategory`

指定したリボンカテゴリをアクティブなカテゴリとして設定します。

BOOL SetActiveCategory(
    CMFCRibbonCategory* pCategory,
    BOOL bForceRestore= FALSE);

パラメーター

pCategory
[in]リボンバーに含まれるリボンカテゴリ。

bForceRestore
[入力] TRUE リボンバーが最小化されている場合は、リボンバーを最大化します。リボンバーが最小化されている場合に、アクティブなカテゴリをポップアップウィンドウに表示 FALSE 。

戻り値

TRUE 指定したカテゴリがアクティブなカテゴリとして設定されている場合。それ以外の場合は FALSE。

解説

メインリボンカテゴリをアクティブなカテゴリにすることはできません。

pCategoryで指定されたカテゴリが表示されない場合は、アクティブなカテゴリとして設定できません。

`CMFCRibbonBar::SetActiveMDIChild`

複数ドキュメントインターフェイス (MDI) 子ウィンドウに属するリボンバーのシステムボタンを、指定した MDI 子ウィンドウに関連付けます。

void SetActiveMDIChild(CWnd* pWnd);

パラメーター

pWnd
[in]MDI 子ウィンドウへのポインター。

解説

`CMFCRibbonBar::SetApplicationButton`

リボンバーにアプリケーションリボンボタンを割り当てます。

void SetApplicationButton(
    CMFCRibbonApplicationButton* pButton,
    CSize sizeButton);

パラメーター

pButton
[in]アプリケーションリボンボタンへのポインター。

sizeButton
[in]アプリケーションリボンボタンのサイズ。

解説

アプリケーションリボンボタンは、リボンコントロールの左上隅にある大きな丸いボタンです。

例

次の例では、CMFCRibbonBar クラスで SetApplicationButton メソッドを使用する方法を示します。

// Init main button:
// CMFCRibbonApplicationButton m_MainButton
m_MainButton.SetImage(IDB_MAIN);
m_MainButton.SetText(_T("\nf"));
m_MainButton.SetToolTipText(strTemp);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetApplicationButton(&m_MainButton, CSize(45, 45));

`CMFCRibbonBar::SetElementKeys`

指定したコマンド ID を持つすべてのリボン要素のキーヒントを設定します。

BOOL SetElementKeys(
    UINT uiCmdID,
    LPCTSTR lpszKeys,
    LPCTSTR lpszMenuKeys= NULL);

パラメーター

uiCmdID
[in]リボン要素のコマンド ID。

lpszKeys
[in]キーヒント。

lpszMenuKeys
[in]メニューのキーヒント。

戻り値

TRUE 少なくとも 1 つのリボン要素のキーヒントが設定されている場合。それ以外の場合は FALSE。

解説

オプションのメニューキーヒントは、ポップアップメニューを開く分割ボタンを含むリボン要素用です。

`CMFCRibbonBar::SetKeyboardNavigationLevel`

ユーザーがリボンバーに含まれているキーヒントを押すと、キーボードナビゲーションレベルを設定します。

void SetKeyboardNavigationLevel(
    CObject* pLevel,
    BOOL bSetFocus = TRUE);

パラメーター

pLevel
[in]現在のキーボードナビゲーションオブジェクトへのポインター。

bSetFocus
[入力] TRUE をクリックして、キーボードフォーカスをリボンバーに設定します。

解説

ユーザーが ALT または F10 キーを押すと、リボンバーのキーボードナビゲーションが開始されます。ユーザーは、リボンバーのキーヒントを押して、次のナビゲーションレベルを選択します。ユーザーは、エスケープキーを押して、前のナビゲーションレベルに戻ることができます。

`CMFCRibbonBar::SetMaximizeMode`

マルチドキュメントインターフェイス (MDI) の子ウィンドウのウィンドウサイズが最大化された状態に入るか、または残るときにリボンバーを調整します。

void SetMaximizeMode(
    BOOL bMax,
    CWnd* pWnd = NULL);

パラメーター

bMax
[入力] TRUE リボンバーに MDI 子ウィンドウのシステムボタンを表示する場合。 FALSE 、リボンバーから MDI 子ウィンドウのシステムボタンを削除します。

pWnd
[in]リボンバーのメインフレームウィンドウへのポインター。

解説

MDI 子ウィンドウが最大化されると、リボンバーに MDI 子ウィンドウのシステムボタンがタブ行に表示されます。

`CMFCRibbonBar::SetQuickAccessCommands`

クイックアクセスツールバーに 1 つ以上のリボン要素を追加します。

void SetQuickAccessCommands(
    const CList<UINT,UINT>& lstCommands,
    BOOL bRecalcLayout=TRUE);

パラメーター

lstCommands
[in]クイックアクセスツールバーに配置するコマンドの一覧。

bRecalcLayout
[入力] TRUE リボン要素を追加した後でリボンを再描画する場合。それ以外の場合 FALSE 。

例

次の例では、CMFCRibbonBar クラスで SetQuickAccessCommands メソッドを使用する方法を示します。

// Add quick access commands to the toolbar
CList<UINT, UINT> lstQATCmds;

lstQATCmds.AddTail(ID_FILE_NEW);
lstQATCmds.AddTail(ID_FILE_OPEN);
lstQATCmds.AddTail(ID_FILE_SAVE);
lstQATCmds.AddTail(ID_FILE_PRINT_DIRECT);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessCommands(lstQATCmds);

`CMFCRibbonBar::SetQuickAccessDefaultState`

クイックアクセスツールバーを既定の状態に設定します。

void SetQuickAccessDefaultState(const CMFCRibbonQuickAccessToolBarDefaultState& state);

パラメーター

state
[in]クイックアクセスツールバーの既定の状態。

解説

クイックアクセスツールバーの状態には、コマンドとその可視性の一覧が含まれます。

例

次の例では、CMFCRibbonBar クラスで SetQuickAccessDefaultState メソッドを使用する方法を示します。

CMFCRibbonQuickAccessToolBarDefaultState *qaToolBarState =
    new CMFCRibbonQuickAccessToolBarDefaultState();
qaToolBarState->AddCommand(ID_FILE_NEW, true);
qaToolBarState->AddCommand(ID_FILE_OPEN, true);
// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessDefaultState(*qaToolBarState);

`CMFCRibbonBar::SetQuickAccessToolbarOnTop`

クイックアクセスツールバーをリボンバーの上または下に配置します。

void SetQuickAccessToolbarOnTop(BOOL bOnTop);

パラメーター

bOnTop
[入力] TRUE リボンバーの上にクイックアクセスツールバーを配置する場合。 FALSE 、クイックアクセスツールバーをリボンバーの下に配置します。

`CMFCRibbonBar::SetTooltipFixedWidth`

リボンバーの固定幅のツールヒントの標準サイズと大きいサイズを設定します。

void SetTooltipFixedWidth(
    int nWidthRegular,
    int nWidthLargeImage);

パラメーター

nWidthRegular
[in]通常の固定サイズのツールヒントの幅 (ピクセル単位)。

nWidthLargeImage
[in]大きな固定サイズのツールヒントの幅 (ピクセル単位)。

解説

パラメーターを 0 に設定すると、対応する幅が変化します。

`CMFCRibbonBar::ShowCategory`

指定されたリボンカテゴリを表示または非表示にします。

void ShowCategory(
    int nIndex,
    BOOL bShow=TRUE);

パラメーター

nIndex
[in]リボンカテゴリのインデックス。

bShow
[in] TRUE場合はリボンカテゴリを表示し、それ以外の場合はリボンカテゴリを非表示にします。

`CMFCRibbonBar::ShowContextCategories`

指定された ID を持つコンテキストカテゴリを表示または非表示にします。

void ShowContextCategories(
    UINT uiContextID,
    BOOL bShow=TRUE);

パラメーター

uiContextID
[in]コンテキストカテゴリ ID。

bShow
[in] TRUE場合は、指定した ID を持つカテゴリを表示します。それ以外の場合は、指定した ID を持つカテゴリを非表示にします。

`CMFCRibbonBar::ShowKeyTips`

リボンバーの各リボン要素のキーヒントを表示します。

void ShowKeyTips();

解説

`CMFCRibbonBar::ToggleMimimizeState`

リボンバーの最小化された状態と最大化された状態を切り替えます。

void ToggleMimimizeState();

解説

メソッド名におけるミススペルは既知の問題です。

最小化された状態の場合、リボンコントロールは非表示になり、タブだけが表示されます。ユーザーがタブをクリックすると、リボンコントロールがポップアップウィンドウとして表示されます。ユーザーがポップアップウィンドウの外側をクリックするか、コマンドを実行すると、ポップアップウィンドウが閉じます。

`CMFCRibbonBar::TranslateChar`

指定したキーストローク文字コードをリボンバーで処理するかどうかを決定します。

virtual BOOL TranslateChar(UINT nChar);

パラメーター

nChar
[in]ユーザーのキーストローク文字コード。

戻り値

TRUE 文字コードがリボンバーによって処理された場合。それ以外の場合は FALSE。

解説

キーヒント機能を使用すると、ユーザーはキーボードを使用してリボンバー内を移動できます。

`CMFCRibbonBar::GetFocused`

フォーカスされた要素を返します。

virtual CMFCRibbonBaseElement* GetFocused();

戻り値

フォーカスのある要素または NULLへのポインター。

解説

`CMFCRibbonBar::IsWindows7Look`

リボンに Windows 7 の外観 (小さな四角形のアプリケーションボタン) があるかどうかを示します。

BOOL IsWindows7Look() const;

戻り値

TRUE リボンに Windows 7 の外観がある場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::LoadFromResource`

過負荷です。アプリケーションリソースからリボンバーを読み込みます。

virtual BOOL LoadFromResource(
    UINT uiXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

virtual BOOL LoadFromResource(
    LPCTSTR lpszXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

パラメーター

uiXMLResID
リボンバー情報を含む XML 文字列のリソース ID を指定します。

lpszResType
uiXMLResIDにあるリソースの種類を指定します。

hInstance
実行可能ファイルにリソースが含まれているモジュールへのハンドル。 hInstanceがNULL場合、現在のプロセスの作成に使用されたモジュールからリソースが読み込まれます。

lpszXMLResID
リボンバー情報を含むリソース ID (文字列形式) を指定します。

戻り値

TRUE 読み込みが成功した場合。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::SaveToXMLBuffer`

リボンバーをバッファーに保存します。

UINT SaveToXMLBuffer(LPBYTE* ppBuffer) const;

パラメーター

ppBuffer
この関数が戻るときに、 ppBuffer はこのメソッドによって割り当てられたバッファーを指し、XML 形式のリボンバー情報が含まれます。

戻り値

成功した場合は TRUE。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::SaveToXMLFile`

リボンバーを XML ファイルに保存します。

BOOL SaveToXMLFile(LPCTSTR lpszFilePath) const;

パラメーター

lpszFilePath
出力ファイルを指定します。

戻り値

成功した場合は TRUE。それ以外の場合は FALSE。

解説

`CMFCRibbonBar::SetWindows7Look`

リボンの Windows 7 の外観 (小さな四角形のアプリケーションボタン) を有効または無効にします。

void SetWindows7Look(
    BOOL bWindows7Look,
    BOOL bRecalc = TRUE);

パラメーター

bWindows7Look
TRUE Windows 7 の外観を設定します。それ以外の場合 FALSE 。

bRecalc
TRUE リボンレイアウトを再計算します。それ以外の場合 FALSE 。

次の方法で共有

CMFCRibbonBar クラス

構文

メンバー

パブリック コンストラクター

パブリック メソッド

解説

継承階層

要件

CMFCRibbonBar::ActivateContextCategory

パラメーター

戻り値

CMFCRibbonBar::AddCategory

パラメーター

戻り値

解説

例

CMFCRibbonBar::AddContextCategory

パラメーター

戻り値

解説

CMFCRibbonBar::AddMainCategory

パラメーター

戻り値

解説

例

CMFCRibbonBar::AddPrintPreviewCategory

戻り値

解説

CMFCRibbonBar::AddQATOnlyCategory

パラメーター

戻り値

解説

CMFCRibbonBar::AddToTabs

パラメーター

解説

CMFCRibbonBar::CMFCRibbonBar

パラメーター

解説

CMFCRibbonBar::Create

パラメーター

戻り値

解説

例

CMFCRibbonBar::CreateEx

パラメーター

戻り値

解説

CMFCRibbonBar::DeactivateKeyboardFocus

パラメーター

解説

CMFCRibbonBar::DrawMenuImage

パラメーター

戻り値

解説

CMFCRibbonBar::DWMCompositionChanged

解説

CMFCRibbonBar::EnableKeyTips

パラメーター

解説

CMFCRibbonBar::EnablePrintPreview

パラメーター

解説

CMFCRibbonBar::EnableToolTips

パラメーター

解説

CMFCRibbonBar::FindByData

パラメーター

戻り値

解説

CMFCRibbonBar::FindByID

パラメーター

戻り値

解説

CMFCRibbonBar::FindCategoryIndexByData

パラメーター

戻り値

CMFCRibbonBar::ForceRecalcLayout

解説

CMFCRibbonBar::GetActiveCategory

`CMFCRibbonBar` クラス

パブリックコンストラクター

パブリックメソッド

`CMFCRibbonBar::ActivateContextCategory`

`CMFCRibbonBar::AddCategory`

`CMFCRibbonBar::AddContextCategory`

`CMFCRibbonBar::AddMainCategory`

`CMFCRibbonBar::AddPrintPreviewCategory`

`CMFCRibbonBar::AddQATOnlyCategory`

`CMFCRibbonBar::AddToTabs`

`CMFCRibbonBar::CMFCRibbonBar`

`CMFCRibbonBar::Create`

`CMFCRibbonBar::CreateEx`

`CMFCRibbonBar::DeactivateKeyboardFocus`

`CMFCRibbonBar::DrawMenuImage`

`CMFCRibbonBar::DWMCompositionChanged`

`CMFCRibbonBar::EnableKeyTips`

`CMFCRibbonBar::EnablePrintPreview`

`CMFCRibbonBar::EnableToolTips`

`CMFCRibbonBar::FindByData`

`CMFCRibbonBar::FindByID`

`CMFCRibbonBar::FindCategoryIndexByData`

`CMFCRibbonBar::ForceRecalcLayout`

`CMFCRibbonBar::GetActiveCategory`

`CMFCRibbonBar::GetApplicationButton`

`CMFCRibbonBar::GetCaptionHeight`

`CMFCRibbonBar::GetCategory`

`CMFCRibbonBar::GetCategoryCount`

`CMFCRibbonBar::GetCategoryHeight`

`CMFCRibbonBar::GetCategoryIndex`

`CMFCRibbonBar::GetContextName`

`CMFCRibbonBar::GetDroppedDown`

`CMFCRibbonBar::GetElementsByID`

`CMFCRibbonBar::GetHideFlags`

`CMFCRibbonBar::GetItemIDsList`

`CMFCRibbonBar::GetKeyboardNavigationLevel`

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

`CMFCRibbonBar::GetKeyboardNavLevelParent`

`CMFCRibbonBar::GetMainCategory`

`CMFCRibbonBar::GetQATCommandsLocation`

`CMFCRibbonBar::GetQATDroppedDown`

`CMFCRibbonBar::GetQuickAccessCommands`

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

`CMFCRibbonBar::GetTabTrancateRatio`

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

`CMFCRibbonBar::GetVisibleCategoryCount`