次の方法で共有


CMFCRibbonPanel クラス

一連のリボン要素を含むパネルを実装します。 このパネルが描画されると、そのパネルに指定されたサイズに対して可能な限り多くの要素が表示されます。

詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。

構文

class CMFCRibbonPanel : public CObject

メンバー

保護されたコンストラクター

名前 説明
CMFCRibbonPanel::CMFCRibbonPanel CMFCRibbonPanel オブジェクトを構築して初期化します。

パブリック メソッド

名前 説明
CMFCRibbonPanel::Add パネルにリボン要素を追加します。
CMFCRibbonPanel::AddSeparator リボン パネルに区切り記号を追加します。
CMFCRibbonPanel::AddToolBar リボン パネルにツール バーを追加します。
CMFCRibbonPanel::FindByData
CMFCRibbonPanel::FindByID 指定したコマンド ID で識別される要素を返します。
CMFCRibbonPanel::GetCaptionHeight
CMFCRibbonPanel::GetCount リボン パネル内の要素の数を返します。
CMFCRibbonPanel::GetData パネルに関連付けられているユーザー定義データを返します。
CMFCRibbonPanel::GetDefaultButton
CMFCRibbonPanel::GetDroppedDown
CMFCRibbonPanel::GetElement 指定したインデックス位置にあるリボン要素を返します。
CMFCRibbonPanel::GetElements リボン パネルに含まれるすべての要素を取得します。
CMFCRibbonPanel::GetElementsByID
CMFCRibbonPanel::GetFocused フォーカスされた要素を返します。
CMFCRibbonPanel::GetGalleryRect ギャラリー要素の外接する四角形を返します。
CMFCRibbonPanel::GetHighlighted
CMFCRibbonPanel::GetIndex
CMFCRibbonPanel::GetItemIDsList
CMFCRibbonPanel::GetName
CMFCRibbonPanel::GetParentButton
CMFCRibbonPanel::GetParentCategory リボン パネルの親カテゴリを返します。
CMFCRibbonPanel::GetParentMenuBar
CMFCRibbonPanel::GetPreferedMenuLocation
CMFCRibbonPanel::GetPressed
CMFCRibbonPanel::GetRect
CMFCRibbonPanel::GetVisibleElements 表示される要素の配列を取得します。
CMFCRibbonPanel::HasElement
CMFCRibbonPanel::HitTest
CMFCRibbonPanel::HitTestEx
CMFCRibbonPanel::Insert 指定した位置にリボン要素を挿入します。
CMFCRibbonPanel::InsertSeparator 指定した位置に区切り記号を挿入します。
CMFCRibbonPanel::IsCenterColumnVert すべてのパネル要素を列単位で垂直方向に中央揃えにするかどうかを指定します。
CMFCRibbonPanel::IsCollapsed
CMFCRibbonPanel::IsHighlighted
CMFCRibbonPanel::IsJustifyColumns すべてのパネル列の幅が同じかどうかを指定します。
CMFCRibbonPanel::IsMainPanel
CMFCRibbonPanel::IsMenuMode
CMFCRibbonPanel::MakeGalleryItemVisible ギャラリーをスクロールして、指定したリボン要素を表示します。
CMFCRibbonPanel::OnKey
CMFCRibbonPanel::RecalcWidths
CMFCRibbonPanel::Remove 指定したインデックス位置にある要素を削除し、必要に応じて削除します。
CMFCRibbonPanel::RemoveAll リボン パネルからすべての要素を削除します。
CMFCRibbonPanel::Replace それぞれのインデックス値に基づいて、1 つの要素を別の要素に置き換えます。
CMFCRibbonPanel::ReplaceByID 指定したコマンド ID に基づいて、1 つの要素を別の要素に置き換えます。
CMFCRibbonPanel::SetCenterColumnVert 列ごとに要素を垂直方向に配置するようにパネルを並べ替えます。
CMFCRibbonPanel::SetData ユーザー定義データをリボン パネルに関連付けます。
CMFCRibbonPanel::SetElementMenu 指定されたコマンド ID を持つ要素にポップアップ メニューを割り当てます。
CMFCRibbonPanel::SetElementRTC 指定されたランタイム クラス情報で指定されたリボン要素をリボン パネルに追加します。
CMFCRibbonPanel::SetElementRTCByID 指定されたランタイム クラス情報で指定されたリボン要素をリボン パネルに追加します。
CMFCRibbonPanel::SetFocused 指定したリボン要素にフォーカスを設定します。
CMFCRibbonPanel::SetJustifyColumns 列の位置合わせを有効または無効にします。
CMFCRibbonPanel::SetKeys リボン パネルを表示するキーボード ショートカットを設定します。
CMFCRibbonPanel::ShowPopup

解説

リボン パネルは、リボン カテゴリ内で作成する関連タスクの論理的なグループです。 リボンのサイズが変更されると、パネル レイアウトはできるだけ多くの要素を表示するように自動的に調整されます。

リボン カテゴリに含まれるリボン パネルを取得するには、 CMFCRibbonCategory::GetPanel メソッドを呼び出します。

次の例では、CMFCRibbonPanel クラスのさまざまなメソッドを使用してCMFCRibbonPanel オブジェクトを構成する方法を示します。 この例では、リボン パネルを表示するキーボード ショートカットを設定し、パネル内の要素を列ごとに垂直方向に配置し、列の両端揃えを有効にする方法を示します。 このコード スニペットは、 MS Office 2007 Demo サンプルの一部です。

// CMFCRibbonCategory* pCategory
// CMFCToolBarImages m_PanelImages
CMFCRibbonPanel *pPanelClipboard = pCategory->AddPanel(_T("Clipboard"), m_PanelImages.ExtractIcon(1));
pPanelClipboard->SetKeys(_T("zc"));
pPanelClipboard->SetCenterColumnVert();
pPanelClipboard->SetJustifyColumns();

継承階層

CObject

CMFCRibbonPanel

要件

Header: afxRibbonPanel.h

CMFCRibbonPanel::Add

リボン パネルに含まれるリボン要素の配列に、指定したリボン要素を追加します。

virtual void Add(CMFCRibbonBaseElement* pElem);

パラメーター

pElem
[入力、出力]リボン要素へのポインター。

解説

CMFCRibbonPanel::AddSeparator

リボン パネルに区切り記号を追加します。

virtual void AddSeparator();

解説

リボン パネルに区切り記号を追加するには、このメソッドを呼び出します。 区切り記号は、 CMFCRibbonPanel::Add への前回の呼び出しによって追加されたリボン要素の横に追加されます。 指定した位置に区切り記号を挿入するには、 CMFCRibbonPanel::InsertSeparator を呼び出します。

CMFCRibbonPanel::AddToolBar

リボン パネルにツール バーを追加します。

CMFCRibbonButtonsGroup* AddToolBar(
UINT uiToolbarResID,
UINT uiColdResID = 0,
UINT uiHotResID = 0,
UINT uiDisabledResID = 0);

パラメーター

uiToolbarResID
[in]追加するツール バーのリソース ID を指定します。

uiColdResID
[in]ツール バーのコールド イメージのリソース ID を指定します。

uiHotResID
[in]ツール バーのホット イメージのリソース ID を指定します。

uiDisabledResID
[in]ツール バーの無効なイメージのリソース ID を指定します。

戻り値

リボン パネルにツール バーを追加するには、このメソッドを呼び出します。 ツール バーは、 CMFCRibbonPanel::Add への前回の呼び出しによって追加されたリボン要素の横に追加されます。

解説

ツール バー、ホット イメージ、コールド イメージ、および無効なイメージの詳細については、「 CMFCToolBar クラスを参照してください。

CMFCRibbonPanel::CMFCRibbonPanel

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

CMFCRibbonPanel(
LPCTSTR lpszName = NULL,
HICON hIcon = NULL);

CMFCRibbonPanel(CMFCRibbonGallery* pPaletteButton);

パラメーター

lpszName
[in]リボン パネルの名前。

hIcon
[in]リボン パネルの既定のボタンのアイコンを処理します。

pPaletteButton
[in]リボン パネルのリボン ギャラリーへのポインター。

CMFCRibbonPanel::FindByData

指定したデータに関連付けられているリボン要素を取得します。

CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData) const;

パラメーター

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

戻り値

メソッドが成功した場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

CMFCRibbonPanel::FindByID

指定したコマンド ID で識別されるリボン要素を取得します。

CMFCRibbonBaseElement* FindByID(UINT uiCmdID) const;

パラメーター

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

戻り値

指定したコマンド ID で識別されるリボン要素。指定したコマンド ID でリボン要素が識別されない場合は NULL。

CMFCRibbonPanel::GetCaptionHeight

リボン パネルのキャプションの高さを取得します。

int GetCaptionHeight() const;

戻り値

リボン パネルのキャプションの高さ (ピクセル単位)。

解説

CMFCRibbonPanel::GetCount

リボン パネルに含まれるリボン要素の数を取得します。

int GetCount() const;

戻り値

リボン パネルに含まれるリボン要素の数。

CMFCRibbonPanel::GetData

パネルに関連付けられているユーザー定義データを返します。

DWORD_PTR GetData() const;

戻り値

パネルに関連付けられているユーザー定義データ。

CMFCRibbonPanel::GetDefaultButton

リボン パネルの既定のボタンを取得します。

CMFCRibbonButton& GetDefaultButton();

戻り値

リボン パネルの既定のボタン。

解説

既定のボタンは、リボン パネルのリボン要素を表示するための十分な領域が存在する場合に表示されます。

CMFCRibbonPanel::GetDroppedDown

ポップアップ メニューがドロップダウンされた場合に、リボン要素へのポインターを取得します。

CMFCRibbonBaseElement* GetDroppedDown() const;

戻り値

ポップアップ メニューがドロップダウンされているリボン要素へのポインター。それ以外の場合、リボン要素にポップアップ メニューがドロップダウンされていない場合は NULL。

解説

テストされるのは、リボン パネルに含まれているリボン要素だけです。

CMFCRibbonPanel::GetElement

指定したインデックス位置にあるリボン要素を返します。

CMFCRibbonBaseElement* GetElement(int nIndex) const;

パラメーター

nIndex
[in]取得する要素の 0 から始まるインデックスを指定します。

戻り値

リボン パネルの nIndex 位置にある基本リボン要素への有効なポインター。指定したインデックスに要素がない場合は NULL。

CMFCRibbonPanel::GetElements

リボン パネルに含まれるすべてのリボン要素を取得します。

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

パラメーター

arElements
[out]リボン パネルに含まれるすべてのリボン要素を格納する配列。

解説

CMFCRibbonPanel::GetElementsByID

指定したコマンド ID を持つリボン要素を、指定した配列に追加します。

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

パラメーター

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

arElements
[in]リボン要素の配列。

解説

テストされるのは、リボン パネルに含まれているリボン要素だけです。

CMFCRibbonPanel::GetHighlighted

リボン パネルで強調表示されているリボン要素を取得します。

CMFCRibbonBaseElement* GetHighlighted() const;

戻り値

リボン パネルで強調表示されているリボン要素へのポインター。

解説

CMFCRibbonPanel::GetIndex

リボン パネルに含まれるリボン要素の配列から、指定したリボン要素の 0 から始まるインデックスを取得します。

virtual int GetIndex(CMFCRibbonBaseElement* pElem) const;

パラメーター

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

戻り値

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

解説

CMFCRibbonPanel::GetItemIDsList

リボン パネルのすべてのリボン要素のコマンド ID を取得します。

void GetItemIDsList(CList<UINT, UINT>& lstItems) const;

パラメーター

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

解説

CMFCRibbonPanel::GetName

リボン パネルの名前を取得します。

LPCTSTR GetName() const;

戻り値

リボン パネルの名前。

解説

CMFCRibbonPanel::GetParentButton

CMFCRibbonBaseElement* GetParentButton() const;

戻り値

解説

CMFCRibbonPanel::GetParentCategory

リボン パネルの親カテゴリを返します。

CMFCRibbonCategory* GetParentCategory() const;

戻り値

このリボン パネルを含むリボン カテゴリへのポインター。

CMFCRibbonPanel::GetParentMenuBar

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

戻り値

解説

CMFCRibbonPanel::GetPreferedMenuLocation

リボン パネルのポップアップ メニューの優先表示四角形を取得します。

virtual BOOL GetPreferedMenuLocation(CRect& rect);

パラメーター

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

戻り値

常に FALSE を返します。

解説

このメソッドは常に FALSE を返します。 リボン パネルのポップアップ メニューの優先表示四角形を取得するには、このメソッドをオーバーライドします。

CMFCRibbonPanel::GetPressed

ユーザーが現在押している場合は、リボン パネル上のリボン要素へのポインターを取得します。

CMFCRibbonBaseElement* GetPressed() const;

戻り値

ユーザーが現在押している場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

CMFCRibbonPanel::GetRect

リボン パネルの表示四角形を取得します。

const CRect& GetRect() const;

戻り値

リボン パネルの表示四角形。

解説

CMFCRibbonPanel::HasElement

リボン パネルに指定したリボン要素が含まれているかどうかを示します。

BOOL HasElement(const CMFCRibbonBaseElement* pElem) const;

パラメーター

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

戻り値

リボン パネルに指定したリボン要素が含まれている場合は TRUE。それ以外の場合は FALSE。

解説

CMFCRibbonPanel::Highlight

選択したリボン パネルと、ポイントで指定されたリボン要素の強調表示の色を設定します。

virtual void Highlight(
BOOL bHighlight,
CPoint point);

パラメーター

bHighlight
[in]リボン パネルを強調表示する場合は TRUE。リボン パネルの強調表示を解除する場合は FALSE。

point
[in]ウィンドウの左上隅を基準としたポインターの x 座標と y 座標。

解説

CMFCRibbonPanel::HitTest

指定したポイントがリボン要素内にある場合に、リボン要素を取得します。

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

パラメーター

point
[in]ウィンドウの左上隅を基準としたポインターの x 座標と y 座標。

bCheckPanelCaption
[in]リボン パネルのキャプションをテストする場合は TRUE。それ以外の場合は FALSE。

戻り値

指定したポイントがリボン要素内にある場合のリボン要素へのポインター。それ以外の場合は NULL。

解説

テストされるのは、リボン パネルに含まれているリボン要素だけです。

CMFCRibbonPanel::HitTestEx

指定したポイントが存在するリボン要素の 0 から始まるインデックスを取得します。

virtual int HitTestEx(CPoint point) const;

パラメーター

point
[in]ウィンドウの左上隅を基準としたポインターの x 座標と y 座標。

戻り値

指定したポイントが存在するリボン要素の 0 から始まるインデックス。それ以外の場合は -1。

解説

テストされるのは、リボン パネルに含まれているリボン要素だけです。

CMFCRibbonPanel::Insert

リボン パネルに含まれるリボン要素の配列内の指定した位置に、指定したリボン要素を挿入します。

virtual BOOL Insert(
CMFCRibbonBaseElement* pElem,
int nIndex);

パラメーター

pElem
[入力、出力]リボン要素へのポインター。

nIndex
[in]-1 から配列に含まれるリボン要素の数までの 0 から始まる値。

戻り値

リボン要素が正常に挿入された場合は TRUE。それ以外の場合は FALSE。

解説

nIndex の値が -1 の場合、または nIndex が配列内のリボン要素の数と等しい場合は、指定したリボン要素が配列の末尾に追加されます。 nIndex の値が範囲外の場合、メソッドは失敗します。

CMFCRibbonPanel::InsertSeparator

指定した位置に区切り記号を挿入します。

virtual BOOL InsertSeparator(int nIndex);

パラメーター

nIndex
[in]区切り記号を挿入する 0 から始まるインデックスを指定します。

戻り値

区切り記号が正常に挿入された場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドを呼び出して、 nIndex で指定された位置に区切り記号を挿入します。 最後に追加したリボン要素の横に区切り記号を挿入するには、 CMFCRibbonPanel::AddSeparator を呼び出します。

CMFCRibbonPanel::IsCenterColumnVert

リボン要素の垂直方向の位置が表示四角形内の中央に配置されているかどうかを示します。

BOOL IsCenterColumnVert() const;

戻り値

リボン要素の垂直方向の位置が表示四角形内の中央に配置されている場合は TRUE。それ以外の場合は FALSE。

CMFCRibbonPanel::IsCollapsed

リボン パネルの表示サイズを水平方向に最小化するかどうかを示します。

BOOL IsCollapsed() const;

戻り値

リボン パネルの表示サイズが水平方向に最小化されている場合は TRUE。それ以外の場合は FALSE。

解説

リボン パネルを折りたたむと、既定のボタン、名前、ドロップダウン矢印のみが表示されます。

CMFCRibbonPanel::IsHighlighted

リボン パネルの表示が強調表示されているかどうかを示します。

BOOL IsHighlighted() const;

戻り値

リボン パネルの表示が強調表示されている場合は TRUE。それ以外の場合は FALSE。

解説

リボン パネルの上にポインターがある場合、リボン パネルの表示が強調表示されます。

CMFCRibbonPanel::IsJustifyColumns

リボン パネル内の同じ列にあるリボン要素の表示寸法を同じ幅に設定するかどうかを示します。

BOOL IsJustifyColumns() const;

戻り値

TRUE リボン パネルの同じ列にあるリボン要素の表示寸法が同じ幅に設定されている場合。それ以外の場合は FALSE。

CMFCRibbonPanel::IsMainPanel

リボン パネルがメイン リボン パネルかどうかを示します。

virtual BOOL IsMainPanel() const;

戻り値

常に FALSE を返します。

解説

このメソッドは常に FALSE を返します。 リボン パネルがメイン リボン パネルかどうかを示すには、このメソッドをオーバーライドします。

ユーザーがアプリケーション ボタンを選択すると、メイン リボン パネルが表示されます。

CMFCRibbonPanel::IsMenuMode

BOOL IsMenuMode() const;

戻り値

解説

CMFCRibbonPanel::OnKey

virtual BOOL OnKey(UINT nChar);

パラメーター

[入力] nChar

戻り値

解説

CMFCRibbonPanel::RecalcWidths

リボン パネルの各表示レイアウト構成の幅を再計算します。

virtual void RecalcWidths(
CDC* pDC,
int nHeight);

パラメーター

pDC
[in]リボン パネルのデバイス コンテキストへのポインター。

nHeight
[in]リボン パネルの高さ。

解説

リボン パネルは、使用可能な幅が変更されるとレイアウト構成を変更します。

CMFCRibbonPanel::Remove

指定したインデックス位置にある要素を削除し、必要に応じて削除します。

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

パラメーター

nIndex
[in]リボン パネルから削除される要素の 0 から始まるインデックスを指定します。

bDelete
[in]削除する要素を削除する場合は TRUE。それ以外の場合は FALSE。

戻り値

要素が削除および削除された場合は TRUE ( bDelete が TRUE の場合)。要素が削除されなかった場合、またはリボン要素が nIndex に存在しない場合は FALSE。

解説

リボン パネルから要素を削除するには、このメソッドを呼び出します。

CMFCRibbonPanel::RemoveAll

リボン パネルからすべてのリボン要素を削除します。

void RemoveAll();

解説

リボン パネルからすべてのリボン要素が削除され、破棄されます。

CMFCRibbonPanel::Replace

インデックス値に基づいて、ある要素を別の要素に置き換えます。

BOOL Replace(
int nIndex,
CMFCRibbonBaseElement* pElem);

パラメーター

nIndex
[in]置換する要素の 0 から始まるインデックスを指定します。

pElem
[入力、出力]元の要素を置き換える要素への有効なポインター。

戻り値

元のリボン要素が新しいリボン要素に正常に置き換えられた場合は TRUE。リボン要素が置き換えられなかった場合、または指定したインデックスに要素がない場合は FALSE。

解説

リボン要素をコマンド ID で置き換えるには、 CMFCRibbonPanel::ReplaceByID を呼び出します。

CMFCRibbonPanel::ReplaceByID

指定したコマンド ID に基づいて、1 つの要素を別の要素に置き換えます。

BOOL ReplaceByID(
UINT uiCmdID,
CMFCRibbonBaseElement* pElem);

パラメーター

uiCmdID
[in]置き換える要素のコマンド ID を指定します。

pElem
[入力、出力]元の要素を置き換える要素への有効なポインター。

戻り値

元のリボン要素が新しいリボン要素に正常に置き換えられた場合は TRUE。リボン要素が置き換えられなかった場合、または指定したコマンド ID を持つ要素が実際に存在しない場合は FALSE。

解説

位置に基づいてリボン要素を置き換えるには、 CMFCRibbonPanel::Replace を呼び出します。

CMFCRibbonPanel::SetCenterColumnVert

表示四角形内のリボン要素の垂直方向の位置の中心を有効または無効にします。

void SetCenterColumnVert(BOOL bSet = TRUE);

パラメーター

bSet
[in]表示四角形内のリボン要素の垂直方向の位置を中央に配置する場合は TRUE。この機能を無効にする場合は FALSE。

解説

CMFCRibbonPanel::SetData

ユーザー定義データをリボン パネルに関連付けます。

void SetData(DWORD_PTR dwData);

パラメーター

dwData
[in]設定するユーザー定義データを指定します。

解説

このメソッドを呼び出して、ユーザー定義データをリボン パネルに関連付けます。

CMFCRibbonPanel::SetElementMenu

指定されたコマンド ID を持つ要素にポップアップ メニューを割り当てます。

BOOL SetElementMenu(
UINT uiCmdID,
HMENU hMenu,
BOOL bIsDefautCommand = FALSE,
BOOL bRightAlign = FALSE);

BOOL SetElementMenu(
UINT uiCmdID,
UINT uiMenuResID,
BOOL bIsDefautCommand = FALSE,
BOOL bRightAlign = FALSE);

パラメーター

uiCmdID
[in]メニューを追加するリボン要素のコマンド ID を指定します。

hMenu
[in]リボン パネルに追加する Windows メニューのハンドルを指定します。

bIsDefautCommand
[in]リボン要素がクリックされた場合に、リボン要素に関連付けられているコマンドを実行するように指定する場合は TRUE。 この場合、メニューは、ユーザーがリボン要素の横にある矢印をクリックしたときにのみ開きます。 リボン要素がクリックされた場合に、リボン要素に関連付けられているコマンドを実行しないように指定する場合は FALSE。 この場合、ユーザーが要素をクリックした場所に関係なく、ポップアップ メニューが表示されます。

bRightAlign
[in]ポップアップ メニューが右揃えであることを指定する場合は TRUE。それ以外の場合は FALSE。

uiMenuResID
[in]リボン パネルに追加するメニューのリソース ID を指定します。

戻り値

メニューがリボン要素に割り当てられている場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドを呼び出して、指定されたコマンド ID を持つリボン要素にポップアップ メニューを割り当てます。

CMFCRibbonPanel::SetElementRTC

指定されたランタイム クラス情報で指定されたリボン要素をリボン パネルに追加します。

CMFCRibbonBaseElement* SetElementRTC(
int nIndex,
CRuntimeClass* pRTC);

パラメーター

nIndex
[in]追加するリボン要素の 0 から始まるインデックスを指定します。

pRTC
[入力、出力]リボン パネルに追加されるリボン要素のランタイム クラス情報へのポインター。

戻り値

指定したランタイム クラス情報を使用して作成されたリボン要素。

解説

カスタム要素 (色ボタンなど) をリボン パネルに追加する場合は、カスタム要素のランタイム クラス情報を指定する必要があります。 リボンは、この情報を格納し、カスタム要素を作成し、指定されたコマンド ID にある (識別される) 既存の要素を置き換えます。 リボンは、新しく作成された要素へのポインターを返します。

CMFCRibbonPanel::SetElementRTCByID

指定されたランタイム クラス情報で指定されたリボン要素をリボン パネルに追加します。

CMFCRibbonBaseElement* SetElementRTCByID(
UINT uiCmdID,
CRuntimeClass* pRTC);

パラメーター

uiCmdID
[in]追加するリボン要素のコマンド ID を指定します。

pRTC
[入力、出力]リボン パネルに追加されるリボン要素に関連付けられているランタイム クラス情報へのポインター。

戻り値

指定したランタイム クラス情報を使用して作成されたリボン要素。

解説

カスタム要素 (色ボタンなど) をリボン パネルに追加する場合は、カスタム要素のランタイム クラス情報を指定する必要があります。 リボンは、この情報を格納し、カスタム要素を作成し、指定されたコマンド ID で配置された既存の要素を置き換えます。 次に、新しく作成された要素へのポインターを返します。

次の例は、 SetElementRTCByID メソッドの使用方法を示しています。

// Load and add toolbar with standard buttons. This toolbar
// should display a custom color button with id ID_CHAR_COLOR:

pPanel->AddToolBar(IDR_MAINFRAME,
    IDB_MAINFRAME256);

CMFCRibbonColorButton* pColorButton =
(CMFCRibbonColorButton*)pPanel->SetElementRTCByID(
ID_CHAR_COLOR,
    RUNTIME_CLASS (CMFCRibbonColorButton));

// SetElementRTCByID sets runtime class and returns a pointer
// to the newly created custom button,
    which can be set up immediately:
pColorButton->EnableAutomaticButton(_T("Automatic"),
    RGB (0,
    0,
    0));

CMFCRibbonPanel::SetJustifyColumns

同じ列のリボン要素の幅の調整を有効または無効にします。

void SetJustifyColumns(BOOL bSet = TRUE);

パラメーター

bSet
[in]同じ列のリボン要素の幅を、列の最大リボン要素の幅に調整する場合は TRUE。この幅調整を無効にする場合は FALSE。

解説

リボン パネルでこの機能を有効にすると、同じ列のリボン要素の幅が、同じ列の最大リボン要素の幅に合わせて調整されます。

CMFCRibbonPanel::SetKeys

リボン パネルの既定のボタンのキーヒントを設定します。

void SetKeys(LPCTSTR lpszKeys);

パラメーター

lpszKeys
[in]リボン パネルの既定のボタンのキーヒント。

解説

既定のボタンは、リボン パネルのリボン要素を表示するための十分な領域が存在する場合に表示されます。

CMFCRibbonPanel::ShowPopup

リボン パネルのポップアップ メニューを作成して表示します。

CMFCRibbonPanelMenu* ShowPopup(CMFCRibbonDefaultPanelButton* pButton = NULL);

パラメーター

pButton
[in]リボン パネルの既定のボタンへのポインター。

戻り値

メソッドが成功した場合のリボン パネルのポップアップ メニューへのポインター。それ以外の場合は NULL。

解説

リボン パネルのポップアップ メニューは、リボン パネルの表示が折りたたまれている場合にのみ使用できます。

CMFCRibbonPanel::SetFocused

指定したリボン要素にフォーカスを設定します。

void SetFocused(CMFCRibbonBaseElement* pNewFocus);

パラメーター

pNewFocus
フォーカスを受け取るリボン要素へのポインター。

解説

CMFCRibbonPanel::MakeGalleryItemVisible

ギャラリーをスクロールして、指定したリボン要素を表示します。

void MakeGalleryItemVisible(CMFCRibbonBaseElement* pItem);

パラメーター

pItem
表示するリボン要素へのポインター。

解説

CMFCRibbonPanel::IsWindows7Look

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

BOOL IsWindows7Look() const;

戻り値

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

解説

CMFCRibbonPanel::GetVisibleElements

表示される要素の配列を取得します。

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

パラメーター

arElements
関数から制御が戻るときに、このパラメーターには可視要素の配列が含まれます。

解説

CMFCRibbonPanel::GetGalleryRect

ギャラリー要素の外接する四角形を返します。

CRect GetGalleryRect();

戻り値

このパネル内のギャラリー要素のサイズと位置。

解説

CMFCRibbonPanel::GetFocused

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

CMFCRibbonBaseElement* GetFocused() const;

戻り値

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

解説

関連項目

階層図
クラス
CObject クラス
CMFCRibbonCategory クラス
CMFCRibbonBaseElement クラス