CMFCOutlookBarPane クラス

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

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

Outlook バー (CMFCOutlookBar クラス) に挿入できるCMFCToolBar クラスから派生したコントロール。 Outlook バーペインには、大きいボタンの列があります。ボタンのリストがペインより長い場合、ユーザーはリストを上下にスクロールできます。ユーザーが Outlook バーペインを Outlook バーから切り離すと、そのペインをフローティング状態にするかメインフレームウィンドウにドッキングできます。

構文

class CMFCOutlookBarPane : public CMFCToolBar

メンバー

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

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

パブリックメソッド

名前	説明
CMFCOutlookBarPane::AddButton	Outlook バーウィンドウにボタンを追加します。
CMFCOutlookBarPane::CanBeAttached	ウィンドウを別のウィンドウウィンドウまたはフレームウィンドウにドッキングできるかどうかを指定します。 ( をオーバーライドしますCBasePane::CanBeAttached.)
`CMFCOutlookBarPane::CanBeRestored`	カスタマイズ後にツールバーを元の状態に戻すことができるかどうかを判断します。 ( をオーバーライドしますCMFCToolBar::CanBeRestored.)
CMFCOutlookBarPane::ClearAll	Outlook バーウィンドウの画像で使用されているリソースを解放します。
CMFCOutlookBarPane::Create	Outlook バーウィンドウを作成します。
`CMFCOutlookBarPane::CreateObject`	このクラス型の動的インスタンスを作成するために、フレームワークで使用されます。
`CMFCOutlookBarPane::Dock`	Outlook バーウィンドウをドッキングするためにフレームワークによって呼び出されます。 ( `CPane::Dock`をオーバーライドします)。
CMFCOutlookBarPane::EnablePageScrollMode	Outlook バーウィンドウのスクロール矢印で、ページ別またはボタン別にボタンの一覧を進めるかどうかを指定します。
CMFCOutlookBarPane::GetRegularColor	Outlook バーウィンドウの標準 (選択されていない) テキストの色を返します。
`CMFCOutlookBarPane::GetThisClass`	このクラス型に関連付けられている CRuntimeClass オブジェクトへのポインターを取得するためにフレームワークによって使用されます。
CMFCOutlookBarPane::IsBackgroundTexture	Outlook バーウィンドウに背景イメージが読み込まれているかどうかを判断します。
`CMFCOutlookBarPane::IsChangeState`	フローティングウィンドウをドッキングできるかどうかを決定します。 ( `CPane::IsChangeState`をオーバーライドします)。
CMFCOutlookBarPane::IsDrawShadedHighlight	ボタンが強調表示され、背景画像が表示されるときに、ボタンの境界線を網掛けするかどうかを指定します。
`CMFCOutlookBarPane::OnBeforeFloat`	ウィンドウが浮動しようとしているときにフレームワークによって呼び出されます。 ( をオーバーライドしますCPane::OnBeforeFloat.)
CMFCOutlookBarPane::RemoveButton	指定したコマンド ID を持つボタンを削除します。
`CMFCOutlookBarPane::RestoreOriginalstate`	ツールバーを元の状態に戻します。 ( をオーバーライドしますCMFCToolBar::RestoreOriginalState.)
CMFCOutlookBarPane::SetBackColor	背景色を設定します。
CMFCOutlookBarPane::SetBackImage	背景画像を設定します。
CMFCOutlookBarPane::SetDefaultState	Outlook バーウィンドウを元のボタンセットにリセットします。
CMFCOutlookBarPane::SetExtraSpace	Outlook バーウィンドウのボタンの周囲で使用されるパディングのピクセル数を設定します。
CMFCOutlookBarPane::SetTextColor	Outlook バーウィンドウの標準テキストと強調表示されたテキストの色を設定します。
CMFCOutlookBarPane::SetTransparentColor	Outlook バーウィンドウの透明な色を設定します。
`CMFCOutlookBarPane::SmartUpdate`	Outlook バーを更新するために内部的に使用されます。 ( `CMFCToolBar::SmartUpdate`をオーバーライドします)。

保護メソッド

名前	説明
CMFCOutlookBarPane::EnableContextMenuItems	カスタマイズモードで表示するショートカットメニュー項目を指定します。
CMFCOutlookBarPane::RemoveAllButtons	Outlook バーウィンドウからすべてのボタンを削除します。 ( をオーバーライドしますCMFCToolBar::RemoveAllButtons.)

解説

Outlook バーを実装する方法については、「 CMFCOutlookBar クラスを参照してください。

Outlook バーの例については、OutlookDemo サンプルプロジェクトを参照してください。

例

次の例では、 CMFCOutlookBarPane クラスのさまざまなメソッドを使用する方法を示します。この例では、Outlook バーウィンドウの作成、ページスクロールモードの有効化、ドッキングの有効化、Outlook バーの背景色の設定を行う方法を示します。このコードスニペットは、 Outlook Multi Views サンプルの一部です。

CMFCOutlookBarPane m_wndShortcutsPane1;

CImageList images;
images.Create(IDB_SHORTCUTS, 32, 0, RGB(255, 0, 255));

// Create first page:
m_wndShortcutsPane1.Create(&m_wndShortcutsBar, AFX_DEFAULT_TOOLBAR_STYLE, ID_SHORTCUTS_PANE_1);
// The this pointer points to a CMainFrame class which extends the CFrameWnd class
m_wndShortcutsPane1.SetOwner(this);
m_wndShortcutsPane1.EnableTextLabels();
m_wndShortcutsPane1.EnableDocking(CBRS_ALIGN_ANY);
m_wndShortcutsPane1.EnablePageScrollMode();
m_wndShortcutsPane1.SetBackColor(RGB(0, 255, 0));

m_wndShortcutsPane1.AddButton(images.ExtractIcon(0), _T("View 1"), ID_SHORTCUT_1);
m_wndShortcutsPane1.AddButton(images.ExtractIcon(1), _T("View 2"), ID_SHORTCUT_2);
m_wndShortcutsPane1.AddButton(images.ExtractIcon(2), _T("View 3"), ID_SHORTCUT_3);
m_wndShortcutsPane1.AddButton(images.ExtractIcon(3), _T("View 4"), ID_SHORTCUT_4);

継承階層

要件

Header: afxoutlookbarpane.h

CMFCOutlookBarPane::AddButton

Outlook バーウィンドウにボタンを追加します。

BOOL AddButton(
    UINT uiImage,
    LPCTSTR lpszLabel,
    UINT iIdCommand,
    int iInsertAt=-1);

BOOL AddButton(
    UINT uiImage,
    UINT uiLabel,
    UINT iIdCommand,
    int iInsertAt=-1);

BOOL AddButton(
    LPCTSTR szBmpFileName,
    LPCTSTR szLabel,
    UINT iIdCommand,
    int iInsertAt=-1);

BOOL AddButton(
    HBITMAP hBmp,
    LPCTSTR lpszLabel,
    UINT iIdCommand,
    int iInsertAt=-1);

BOOL AddButton(
    HICON hIcon,
    LPCTSTR lpszLabel,
    UINT iIdCommand,
    int iInsertAt=-1,
    BOOL bAlphaBlend=FALSE);

パラメーター

uiImage
[in]ビットマップのリソース識別子を指定します。

lpszLabel
[in]ボタンのテキストを指定します。

iIdCommand
[in]ボタンコントロールの ID を指定します。

iInsertAt
[in]ボタンを挿入する Outlook バーのページの 0 から始まるインデックスを指定します。

uiLabel
[in]文字列リソース ID。

szBmpFileName
[in]読み込むディスクイメージファイルの名前を指定します。

szLabel
[in]ボタンのテキストを指定します。

hBmp
[in]ボタンのビットマップへのハンドル。

hIcon
[in]ボタンのアイコンへのハンドル。

戻り値

ボタンが正常に追加された場合は TRUE。それ以外の場合は FALSE。

解説

Outlook バーのページに新しいボタンを挿入するには、このメソッドを使用します。ボタンのイメージは、アプリケーションリソースまたはディスクファイルから読み込むことができます。

uiPageID で指定されたページ ID が -1 の場合、ボタンは最初のページに挿入されます。

iInsertAt で指定されたインデックスが -1 の場合、ページの末尾にボタンが追加されます。

CMFCOutlookBarPane::CanBeAttached

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

virtual BOOL CanBeAttached() const;

戻り値

解説

CMFCOutlookBarPane::ClearAll

Outlook バーウィンドウの画像で使用されるリソースを解放します。

void ClearAll();

解説

このメソッドは CMFCToolBarImages::Clear を直接呼び出します。これは、Outlook バーウィンドウで使用されるイメージで呼び出されます。

CMFCOutlookBarPane::Create

Outlook バーウィンドウを作成します。

virtual BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle=AFX_DEFAULT_TOOLBAR_STYLE,
    UINT uiID=(UINT)-1,
    DWORD dwControlBarStyle=0);

パラメーター

pParentWnd
[in]Outlook バーウィンドウコントロールの親ウィンドウを指定します。 NULL は指定できません。

dwStyle
[in]ウィンドウスタイル。ウィンドウスタイルの一覧については、「 Window スタイル」を参照してください。

uiID
[入力] コントロール ID。コントロールの状態の保存を有効にするには、一意である必要があります。

dwControlBarStyle
[in]Outlook バーから切り離されたときの Outlook バーウィンドウコントロールの動作を定義する特殊なスタイルを指定します。

戻り値

メソッドが成功した場合は TRUE。それ以外の場合は FALSE。

解説

CMFCOutlookBarPane オブジェクトを作成するには、まずコンストラクターを呼び出してから、Createを呼び出します。これにより、Outlook バーウィンドウコントロールが作成され、CMFCOutlookBarPane オブジェクトにアタッチされます。

dwControlBarStyleの詳細については、CBasePane::CreateEx を参照してください。

CMFCOutlookBarPane::EnableContextMenuItems

カスタマイズモードで表示するショートカットメニュー項目を指定します。

virtual BOOL EnableContextMenuItems(
    CMFCToolBarButton* pButton,
    CMenu* pPopup);

パラメーター

pButton
[in]ユーザーがクリックしたツールバーボタンへのポインター。

pPopup
[in]ショートカットメニューへのポインター。

戻り値

ショートカットメニューを表示する必要がある場合は TRUE を返します。それ以外の場合は FALSE。

解説

フレームワークがカスタマイズモードで表示するフレームワークの標準ショートカットメニューを変更するには、このメソッドをオーバーライドします。

既定の実装では、カスタマイズモード ( CMFCToolBar::IsCustomizeMode) がチェックされ、TRUE に設定されている場合は、 Delete を除くすべてのショートカットメニュー項目が無効になります。次に、入力パラメーターを CMFCToolBar::EnableContextMenuItemsに渡すだけです。

Note

コンテキストメニュー はショートカットメニューのシノニムです。

CMFCOutlookBarPane::EnablePageScrollMode

Outlook バーウィンドウのスクロール矢印で、ページごとにボタンの一覧を進めるか、ボタンごとにボタンを進めるかを指定します。

void EnablePageScrollMode(BOOL bPageScroll=TRUE);

パラメーター

bPageScroll
[in]TRUE の場合は、ページスクロールモードを有効にします。 FALSE の場合は、ページスクロールモードを無効にします。

CMFCOutlookBarPane::GetRegularColor

Outlook バーウィンドウの標準 (つまり、選択されていない) テキストの色を返します。

DECLARE_MESSAGE_MAPCOLORREF GetRegularColor() const;

戻り値

RGB カラー値としての現在のテキストの色。

解説

CMFCOutlookBarPane::SetTextColor を使用して、Outlook バーの現在の (標準および選択されている) テキストの色を設定します。 COLOR_WINDOW インデックスを使用して GetSysColor 関数を呼び出すと、既定のテキストの色を取得できます。

CMFCOutlookBarPane::IsBackgroundTexture

Outlook バーウィンドウに背景イメージが読み込まれているかどうかを判断します。

BOOL IsBackgroundTexture() const;

戻り値

表示する背景画像がある場合は TRUE。それ以外の場合は FALSE。

解説

バックグラウンドイメージを追加するには、 CMFCOutlookBarPane::SetBackImage 関数を呼び出します。

背景画像がない場合、背景は、 CMFCOutlookBarPane::SetBackColor を使用して指定された色で塗りつぶされます。

CMFCOutlookBarPane::IsDrawShadedHighlight

ボタンが強調表示され、背景画像が表示されるときに、ボタンの境界線を網掛けするかどうかを指定します。

BOOL IsDrawShadedHighlight() const;

戻り値

ボタンの境界線が網掛けされている場合は TRUE。それ以外の場合は FALSE。

CMFCOutlookBarPane::RemoveAllButtons

Outlook バーウィンドウからすべてのボタンを削除します。

virtual void RemoveAllButtons();

CMFCOutlookBarPane::RemoveButton

指定したコマンド ID を持つボタンを削除します。

BOOL RemoveButton(UINT iIdCommand);

パラメーター

iIdCommand
[in]削除するボタンのコマンド ID を指定します。

戻り値

ボタンが正常に削除された場合は TRUE。指定したコマンド ID が無効な場合は FALSE。

CMFCOutlookBarPane::SetBackColor

Outlook バーの背景色を設定します。

void SetBackColor(COLORREF color);

パラメーター

color
[in] 新しい背景色を指定します。

解説

Outlook バーの現在の背景色を設定するには、この関数を呼び出します。背景色は、背景画像がない場合にのみ使用されます。

CMFCOutlookBarPane::SetBackImage

背景画像を設定します。

void SetBackImage(UINT uiImageID);

パラメーター

uiImageID
[in]イメージリソース ID を指定します。

解説

Outlook バーの背景画像を設定するには、このメソッドを呼び出します。背景画像の一覧は、埋め込み CMFCToolBarImages クラスオブジェクトによって管理されます。

CMFCOutlookBarPane::SetDefaultState

Outlook バーウィンドウを元のボタンセットにリセットします。

void SetDefaultState();

解説

このメソッドは、Outlook バーのボタンを元のセットに復元します。このメソッドは、Outlook バーウィンドウの再描画をトリガーしない点を除き、 CMFCOutlookBarPane::RestoreOriginalstateのようなものです。

CMFCOutlookBarPane::SetExtraSpace

Outlook バーウィンドウのボタンの周囲で使用されるパディングのピクセル数を設定します。

void SetExtraSpace()

CMFCOutlookBarPane::SetTextColor

Outlook バーウィンドウの標準テキストと強調表示されたテキストの色を設定します。

void SetTextColor(
    COLORREF clrRegText,
    COLORREF clrSelText=0);

パラメーター

clrRegText
[in]選択されていないテキストの新しい色を指定します。

clrSelText
[in]選択したテキストの新しい色を指定します。

CMFCOutlookBarPane::SetTransparentColor

Outlook バーウィンドウの透明な色を設定します。

void SetTransparentColor(COLORREF color);

パラメーター

color
新しい透明色を指定します。

解説

透明な画像を表示するには、透明な色が必要です。イメージ内でこの色が発生した場合は、代わりに背景色で塗りつぶされます。背景と前景のイメージのブレンドはありません。

次の方法で共有

CMFCOutlookBarPane クラス

構文

メンバー

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

パブリック メソッド

保護メソッド

解説

例

継承階層

要件

CMFCOutlookBarPane::AddButton

パラメーター

戻り値

解説

CMFCOutlookBarPane::CanBeAttached

戻り値

解説

CMFCOutlookBarPane::ClearAll

解説

CMFCOutlookBarPane::Create

パラメーター

戻り値

解説

CMFCOutlookBarPane::EnableContextMenuItems

パラメーター

戻り値

解説

CMFCOutlookBarPane::EnablePageScrollMode

パラメーター

CMFCOutlookBarPane::GetRegularColor

戻り値

解説

CMFCOutlookBarPane::IsBackgroundTexture

戻り値

解説

CMFCOutlookBarPane::IsDrawShadedHighlight

戻り値

CMFCOutlookBarPane::RemoveAllButtons

CMFCOutlookBarPane::RemoveButton

パラメーター

戻り値

CMFCOutlookBarPane::SetBackColor

パラメーター

解説

CMFCOutlookBarPane::SetBackImage

パラメーター

解説

CMFCOutlookBarPane::SetDefaultState

解説

CMFCOutlookBarPane::SetExtraSpace

CMFCOutlookBarPane::SetTextColor

パラメーター

CMFCOutlookBarPane::SetTransparentColor

パラメーター

解説

関連項目

フィードバック

その他のリソース

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

パブリックメソッド