CMFCRibbonBar クラス

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	[印刷プレビュー] タブを有効にします。
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	[印刷プレビュー] タブが有効かどうかを指定します。
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 アプリケーションにリボン バーを追加する方法については、「チュートリアル: MFC Scribble アプリケーションの更新」を参照してください。

継承階層

CObject

CCmdTarget

CWnd

CBasePane

CPane

CMFCRibbonBar

必要条件

ヘッダー:afxribbonbar.h

CMFCRibbonBar::ActivateContextCategory

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

BOOL ActivateContextCategory(UINT uiContextID);

パラメーター

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

戻り値

TRUE コンテキスト カテゴリが見つかり uiContextID 、アクティブ化された場合は 〗。それ以外の場合 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場合は、ランタイム クラスを使用して新しいリボン カテゴリが動的に作成されます。

例

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

// 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]ランタイム クラスへのポインター。

戻り値

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

解説

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

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

• 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

解説

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

例

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

// 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
[in] 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は .

解説

例

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

// 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
[in] 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
[in] TRUE キーヒント機能を有効にするには、 FALSE キーヒント機能を無効にします。

解説

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

CMFCRibbonBar::EnablePrintPreview

印刷プレビュー機能を有効または無効にします。

void EnablePrintPreview(BOOL bEnable = TRUE);

パラメーター

bEnable
[in] TRUE印刷プレビュー機能を有効にする場合は [印刷プレビュー] 機能FALSEを無効にします。

解説

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

既定では、 印刷プレビュー 機能が有効になっています。

CMFCRibbonBar::EnableToolTips

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

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

パラメーター

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

bEnableDescr
[in] TRUE ツールヒントの説明を有効にするには、 FALSE を選択すると、ツールヒントの説明が無効になります。

解説

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

CMFCRibbonBar::FindByData

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

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

パラメーター

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

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

戻り値

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

解説

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

CMFCRibbonBar::FindByID

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

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

パラメーター

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

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

bExcludeQAT
[in] 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メソッドが成功した場合。それ以外の場合は、 FALSE 0 の場合uiContextID、またはコンテキスト カテゴリキャプションが見つかりませんでした。

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
[in] 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
[in] TRUE アクティブなカテゴリを検索する場合。 FALSE アクティブなカテゴリを検索しません。

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

戻り値

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

解説

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

CMFCRibbonBar::IsKeyTipEnabled

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

BOOL IsKeyTipEnabled() const;

戻り値

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

CMFCRibbonBar::IsMainRibbonBar

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

virtual BOOL IsMainRibbonBar() const;

戻り値

常に TRUE を返します。

解説

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

CMFCRibbonBar::IsPrintPreviewEnabled

印刷プレビュー機能が有効かどうかを示します。

BOOL IsPrintPreviewEnabled() const;

戻り値

TRUE印刷プレビュー機能が有効な場合は 〗。それ以外の場合FALSEは 。

CMFCRibbonBar::IsQATEmpty

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

BOOL IsQATEmpty() const;

戻り値

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

解説

CMFCRibbonBar::IsQuickAccessToolbarOnTop

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

BOOL IsQuickAccessToolbarOnTop() const;

戻り値

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

CMFCRibbonBar::IsReplaceFrameCaption

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

BOOL IsReplaceFrameCaption() const;

戻り値

TRUEリボン バーがメインフレーム ウィンドウのキャプションを置き換える場合は a0/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
[in] 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
[in] 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]アプリケーション リボン ボタンのサイズ。

解説

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

例

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

// 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
[in] TRUE をクリックして、キーボード フォーカスをリボン バーに設定します。

解説

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

CMFCRibbonBar::SetMaximizeMode

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

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

パラメーター

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

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

解説

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

CMFCRibbonBar::SetQuickAccessCommands

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

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

パラメーター

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

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

例

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

// 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]クイック アクセス ツール バーの既定の状態。

解説

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

例

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

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
[in] 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]場合は、指定した ID を持つカテゴリを表示します。それ以外の場合 TRUEは、指定した 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 それ以外の場合。

解説

関連項目

階層図
クラス
CPane クラス
CMFCRibbonCategory クラス
CMFCRibbonPanel クラス
CMFCRibbonBaseElement クラス
チュートリアル: MFC Scribble アプリケーションの更新