CMFCRibbonStatusBar クラス
CMFCRibbonStatusBar クラスは、リボン要素を表示できるステータス バー コントロールを実装します。
構文
class CMFCRibbonStatusBar : public CMFCRibbonBar
メンバー
パブリック メソッド
保護メソッド
| 名前 | 説明 |
|---|---|
| CMFCRibbonStatusBar::OnDrawInformation | 情報モードが有効な場合にリボンのステータス バーに表示される情報文字列を表示します。 |
解説
ユーザーは、リボン ステータス バーの組み込みのコンテキスト メニューを使用して、リボン ステータス バーのリボン要素の表示を変更できます。 要素を動的に追加または削除できます。
リボンのステータス バーには、メイン領域と拡張領域の 2 つの領域があります。 拡張領域はリボンステータスバーの右側に表示され、メイン領域とは異なる色で表示されます。
通常、ステータス バーのメイン領域にはステータス通知が表示され、拡張領域にはビュー コントロールが表示されます。 ユーザーがリボンのステータス バーのサイズを変更しても、拡張領域はできるだけ長く表示されます。
例
CMFCRibbonStatusBar クラスのさまざまなメソッドの使用方法を次の例に示します。 この例では、リボンステータスバーに新しいリボン要素を追加する方法、リボンステータスバーの拡張領域にリボン要素を追加する方法、区切り記号を追加する方法、リボンステータスバーの標準モードを有効にする方法を示します。
// CMFCRibbonStatusBar m_wndStatusBar
m_wndStatusBar.AddElement(rsbp, strTitlePane1);
m_wndStatusBar.AddExtendedElement(new CMFCRibbonStatusBarPane(ID_STATUSBAR_PANE2, strTitlePane2, TRUE),
strTitlePane2);
m_wndStatusBar.AddSeparator();
m_wndStatusBar.SetInformation(NULL);
継承階層
要件
Header: afxribbonstatusbar.h
CMFCRibbonStatusBar::AddDynamicElement
リボンのステータス バーに動的要素を追加します。
void AddDynamicElement(CMFCRibbonBaseElement* pElement);
パラメーター
pElement
[in]動的要素へのポインター。
解説
通常の要素とは異なり、動的要素はカスタマイズ可能ではなく、ステータス バーのカスタマイズ メニューには表示されません。
CMFCRibbonStatusBar::AddElement
リボンのステータス バーに新しいリボン要素を追加します。
void AddElement(
CMFCRibbonBaseElement* pElement,
LPCTSTR lpszLabel,
BOOL bIsVisible=TRUE);
パラメーター
pElement
[in]追加された要素へのポインター。
lpszLabel
[in]要素のテキスト ラベル。
bIsVisible
[in]要素を表示可能として追加する場合は TRUE、非表示として要素を追加する場合は FALSE。
CMFCRibbonStatusBar::AddExtendedElement
リボンのステータス バーの拡張領域にリボン要素を追加します。
void AddExtendedElement(
CMFCRibbonBaseElement* pElement,
LPCTSTR lpszLabel,
BOOL bIsVisible=TRUE);
パラメーター
pElement
[in]追加された要素へのポインター。
lpszLabel
[in]要素のテキスト ラベル。
bIsVisible
[in]要素を表示可能として追加する場合は TRUE、非表示として要素を追加する場合は FALSE。
解説
拡張領域は、ステータス バー コントロールの右側にあります。
CMFCRibbonStatusBar::AddSeparator
リボンのステータス バーに区切り記号を追加します。
void AddSeparator();
解説
フレームワークは、メソッド CMFCRibbonStatusBar::AddElement の後に区切り記号を追加します。 は最後の要素を挿入します。
CMFCRibbonStatusBar::Create
リボンのステータス バーを作成します。
BOOL Create(
CWnd* pParentWnd,
DWORD dwStyle=WS_CHILD|WS_VISIBLE|CBRS_BOTTOM,
UINT nID=AFX_IDW_STATUS_BAR);
パラメーター
pParentWnd
[in]親ウィンドウへのポインター。
dwStyle
[in]コントロール スタイルの論理 OR の組み合わせ。
nID
[in]ステータス バーのコントロール ID。
戻り値
ステータス バーが正常に作成された場合は TRUE、それ以外の場合は FALSE。
CMFCRibbonStatusBar::CreateEx
拡張スタイルを持つリボン ステータス バーを作成します。
BOOL CreateEx(
CWnd* pParentWnd,
DWORD dwCtrlStyle=0,
DWORD dwStyle=WS_CHILD|WS_VISIBLE|CBRS_BOTTOM,
UINT nID=AFX_IDW_STATUS_BAR);
パラメーター
pParentWnd
親ウィンドウへのポインター。
dwCtrlStyle
ステータス バー オブジェクトを作成するための追加のスタイルの論理 OR の組み合わせ。
dwStyle
ステータス バーのコントロール スタイル。
nID
ステータス バーのコントロール ID。
戻り値
ステータス バーが正常に作成された場合は TRUE、それ以外の場合は FALSE。
CMFCRibbonStatusBar::FindByID
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
CMFCRibbonBaseElement* FindByID(UINT uiCmdID, BOOL = TRUE);
パラメーター
[入力] uiCmdID
[入力] BOOL
戻り値
解説
CMFCRibbonStatusBar::FindElement
指定したコマンド ID を持つ要素へのポインターを返します。
CMFCRibbonBaseElement* FindElement(UINT uiID);
パラメーター
uiID
[in]要素の ID。
戻り値
指定したコマンド ID を持つ要素へのポインター。 そのような要素がない場合は NULL。
CMFCRibbonStatusBar::GetCount
リボンのステータス バーのメイン領域にある要素の数を返します。
int GetCount() const;
戻り値
リボン ステータス バーのメイン領域にある要素の数。
CMFCRibbonStatusBar::GetElement
指定したインデックス位置にある要素へのポインターを返します。
CMFCRibbonBaseElement* GetElement(int nIndex);
パラメーター
nIndex
[in]ステータス バー コントロールのメイン領域にある要素の 0 から始まるインデックスを指定します。
戻り値
指定したインデックス位置にある要素へのポインター。 インデックスが負の場合、またはステータス バーの要素数を超える場合は NULL。
解説
CMFCRibbonStatusBar::GetExCount
リボン ステータス バーの拡張領域にある要素の数を返します。
int GetExCount() const;
戻り値
リボン ステータス バーの拡張領域にある要素の数。
CMFCRibbonStatusBar::GetExElement
リボン ステータス バーの拡張領域内の指定されたインデックスにある要素へのポインターを返します。 拡張領域は、ステータス バー コントロールの右側にあります。
CMFCRibbonBaseElement* GetExElement(int nIndex);
パラメーター
nIndex
[in]ステータス バー コントロールの拡張領域にある要素の 0 から始まるインデックスを指定します。
戻り値
リボン ステータス バーの拡張領域内の指定されたインデックスにある要素へのポインター。 nIndex が負の値の場合、またはリボンのステータス バーの拡張領域内の要素数を超えている場合は NULL。
解説
CMFCRibbonStatusBar::GetExtendedArea
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
virtual BOOL GetExtendedArea(CRect& rect) const;
パラメーター
[in] rect
戻り値
解説
CMFCRibbonStatusBar::GetSpace
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
int GetSpace() const;
戻り値
解説
CMFCRibbonStatusBar::IsBottomFrame
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
BOOL IsBottomFrame() const;
戻り値
解説
CMFCRibbonStatusBar::IsExtendedElement
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
BOOL IsExtendedElement(CMFCRibbonBaseElement* pElement) const;
パラメーター
[入力] pElement
戻り値
解説
CMFCRibbonStatusBar::IsInformationMode
リボンのステータス バーに対して情報モードが有効かどうかを指定します。
BOOL IsInformationMode() const;
戻り値
ステータス バーが情報モードで動作できる場合は TRUE。それ以外の場合は FALSE。
解説
情報モードでは、ステータス バーはすべての通常のウィンドウを非表示にし、メッセージ文字列を表示します。
CMFCRibbonStatusBar::OnDrawInformation
情報モードが有効な場合にリボンのステータス バーに表示される文字列を表示します。
virtual void OnDrawInformation(
CDC* pDC,
CString& strInfo,
CRect rectInfo);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
strInfo
[in]情報文字列。
rectInfo
[in]外接する四角形。
解説
ステータス バーの情報文字列の外観をカスタマイズする場合は、派生クラスでこのメソッドをオーバーライドします。 ステータス バーを情報モードにするには、 CMFCRibbonStatusBar::SetInformation メソッドを使用します。 このモードでは、ステータス バーはすべてのペインを非表示にし、 strInfo で指定された情報文字列を表示します。
CMFCRibbonStatusBar::RecalcLayout
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
virtual void RecalcLayout();
解説
CMFCRibbonStatusBar::RemoveAll
リボンのステータス バーからすべての要素を削除します。
void RemoveAll();
CMFCRibbonStatusBar::RemoveElement
指定したコマンド ID を持つ要素をリボンのステータス バーから削除します。
BOOL RemoveElement(UINT uiID);
パラメーター
uiID
[in]ステータス バーから削除する要素の ID。
戻り値
指定した uiID を持つ要素が削除された場合は TRUE。 それ以外の場合は FALSE。
CMFCRibbonStatusBar::SetInformation
リボン ステータス バーの情報モードを有効または無効にします。
void SetInformation(LPCTSTR lpszInfo);
パラメーター
lpszInfo
[in]情報文字列。
解説
ステータス バーを情報モードにするには、このメソッドを使用します。 このモードでは、ステータス バーはすべてのペインを非表示にし、 lpszInfo で指定された情報文字列を表示します。
lpszInfo が NULL の場合、ステータス バーは通常モードに戻ります。
関連項目
階層図
クラス
CMFCRibbonBar クラス
CMFCRibbonBaseElement クラス
CMFCRibbonBar クラス