CMFCOutlookBarTabCtrl クラス

Microsoft Outlook の ナビゲーション ウィンドウ と同じ外観を持つタブ コントロールです。 詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。

構文

class CMFCOutlookBarTabCtrl : public CMFCBaseTabCtrl

メンバー

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

パブリック メソッド

解説

ドッキングをサポートする Outlook バーを作成するには、 CMFCOutlookBar オブジェクトを使用して Outlook バー タブ コントロールをホストします。 詳細については、「 CMFCOutlookBar クラスを参照してください。

例

次の例では、 CMFCOutlookBarTabCtrl オブジェクトを初期化し、 CMFCOutlookBarTabCtrl クラスのさまざまなメソッドを使用する方法を示します。 この例では、Outlook バーのタブ ページ ボタンでテキスト ラベルのインプレース編集を有効にする方法、アニメーションを有効にする方法、ユーザーが Outlook バー ウィンドウのボタンをスクロールできるようにするスクロール ハンドルを有効にする方法、Outlook タブ コントロールの境界線サイズを設定する方法、Outlook バーのタブ ボタンにテキスト ラベルの配置を設定する方法を示します。 このコード スニペットは、 Outlook デモ サンプルの一部です。

// CMFCOutlookBar& bar
CMFCOutlookBarTabCtrl *pOutlookBar = (CMFCOutlookBarTabCtrl*)bar.GetUnderlyingWindow();

pOutlookBar->EnableInPlaceEdit(TRUE);
pOutlookBar->EnableAnimation();
pOutlookBar->EnableScrollButtons();
pOutlookBar->SetBorderSize(10);
pOutlookBar->SetPageButtonTextAlign(TA_LEFT);

継承階層

CObject

CCmdTarget

CWnd

CMFCBaseTabCtrl

CMFCOutlookBarTabCtrl

要件

ヘッダー: afxoutlookbartabctrl.h

CMFCOutlookBarTabCtrl::AddControl

Outlook バーの新しいタブとして Windows コントロールを追加します。

void AddControl(
    CWnd* pWndCtrl,
    LPCTSTR lpszName,
    int nImageID=-1,
    BOOL bDetachable=TRUE,
    DWORD dwControlBarStyle=AFX_CBRS_FLOAT |  AFX_CBRS_CLOSE | AFX_CBRS_RESIZE |  CBRS_AFX_AUTOHIDE);

パラメーター

pWndCtrl
[in]追加するコントロールへのポインター。

lpszName
[in]タブの名前を指定します。

bDetachable
[in]TRUE の場合、ページはデタッチ可能として作成されます。

nImageID
[in]新しいタブに表示するイメージの内部イメージ リスト内のイメージ インデックス。

dwControlBarStyle
[in]ラップされたドッキング ウィンドウのAFX_ CBRS_* スタイルを指定します。

解説

この関数を使用して、Outlook バーの新しいページとしてコントロールを追加します。

この関数は、 CMFCBaseTabCtrl::AddTab を内部的に呼び出します。

bDetachable を TRUE に設定すると、AddControl内部でCDockablePaneAdapter オブジェクトが作成され、追加されたコントロールがラップされます。 タブ付きウィンドウのランタイム クラスが CMFCOutlookBar のランタイム クラスに自動的に設定され、フローティング フレームのランタイム クラスが CMultiPaneFrameWndに設定されます。

例

次の例では、AddControl クラスで CMFCOutlookBarTabCtrl メソッドを使用する方法を示します。 このコード スニペットは、 Outlook デモ サンプルの一部です。

// CMFCOutlookBarTabCtrl* pOutlookBar
// DWORD dwStyle = AFX_CBRS_FLOAT | AFX_CBRS_AUTOHIDE | AFX_CBRS_RESIZE
// CMFCOutlookBarPane pane1
// The third parameter is the image index.
pOutlookBar->AddControl(&pane1, _T("General"), 0, TRUE, dwStyle);

CMFCOutlookBarTabCtrl::CanShowFewerPageButtons

サイズ変更操作中にフレームワークによって呼び出され、表示できる Outlook バーのタブ ページ ボタンが現在表示されているボタンよりも少ないかどうかを判断します。

virtual BOOL CanShowFewerPageButtons() const;

戻り値

複数のボタンがある場合は TRUE。それ以外の場合は FALSE。

解説

Outlook バータブコントロールは、利用可能なスペースの量に応じて、ディスプレイにタブを動的に追加または削除します。 このメソッドは、そのプロセスを支援するためにフレームワークによって使用されます。

CMFCOutlookBarTabCtrl::CanShowMorePageButtons

サイズ変更操作中にフレームワークによって呼び出され、現在表示されているよりも多くの Outlook バー タブ ページ ボタンを表示できるかどうかを判断します。

virtual BOOL CanShowMorePageButtons() const;

戻り値

現在表示されていないボタンがある場合は TRUE。それ以外の場合は FALSE。

解説

Outlook バータブコントロールは、利用可能な会議室の量に応じて、ディスプレイにタブを動的に追加または削除します。 このメソッドは、そのプロセスを支援するためにフレームワークによって使用されます。

CMFCOutlookBarTabCtrl::Create

Outlook バー タブ コントロールを作成します。

virtual BOOL Create(
    const CRect& rect,
    CWnd* pParentWnd,
    UINT nID);

パラメーター

rect
[in]初期サイズと位置をピクセル単位で指定します。

pParentWnd
[in]親ウィンドウをポイントします。 NULL は指定できません。

nID
[入力] コントロール ID。

戻り値

コントロールが正常に作成された場合は 0 以外。それ以外の場合は 0。

解説

通常、outlook バー タブ コントロールは、 CMFCOutlookBar クラス プロセスのWM_CREATE メッセージを制御するときに作成されます。

CMFCOutlookBarTabCtrl::EnableAnimation

アクティブなタブ間の切り替え中に発生するアニメーションを有効にするかどうかを指定します。

static void EnableAnimation(BOOL bEnable=TRUE);

パラメーター

bEnable
[in]アニメーションを有効にするか無効にするかを指定します。

解説

アニメーションを有効または無効にするには、この関数を呼び出します。 ユーザーがタブ ページを開くと、アニメーションが有効になっている場合、ページのキャプションが上下にスライドします。 アニメーションが無効になっている場合、ページはすぐにアクティブになります。

既定では、アニメーションは有効になっています。

CMFCOutlookBarTabCtrl::EnableInPlaceEdit

ユーザーが Outlook バーのタブ ページ ボタンのテキスト ラベルを変更できるかどうかを指定します。

virtual void EnableInPlaceEdit(BOOL bEnable);

パラメーター

bEnable
TRUE の場合は、テキスト ラベルのインプレース編集を有効にします。 FALSE の場合は、インプレース編集を無効にします。

解説

この関数を呼び出して、タブ ページ ボタンのテキスト ラベルのインプレース編集を有効または無効にします。 既定では、インプレース編集は無効になっています。

CMFCOutlookBarTabCtrl::EnableScrollButtons

Outlook バー ウィンドウでユーザーがボタンをスクロールできるようにするスクロール ハンドルを有効にするために、フレームワークによって呼び出されます。

void EnableScrollButtons(
    BOOL bEnable = TRUE,
    BOOL bIsUp = TRUE,
    BOOL bIsDown = TRUE);

パラメーター

bEnable
[in]スクロール ボタンを表示するかどうかを指定します。

bIsUp
[in]上部のスクロール バーを表示するかどうかを指定します。

bIsDown
[in]下のスクロール バーを表示するかどうかを指定します。

解説

スクロール ボタンの表示を有効にします。 このメソッドは、スクロール ボタンを復元するためにアクティブなタブが変更されたときにフレームワークによって呼び出されます。

CMFCOutlookBarTabCtrl::GetBorderSize

Outlook タブ コントロールの境界線のサイズを返します。

int GetBorderSize() const;

戻り値

境界線のサイズ (ピクセル単位)。

CMFCOutlookBarTabCtrl::GetVisiblePageButtons

int GetVisiblePageButtons() const;

戻り値

解説

CMFCOutlookBarTabCtrl::IsAnimation

アクティブなタブ間の切り替え中に発生するアニメーションを有効にするかどうかを指定します。

static BOOL IsAnimation();

戻り値

アニメーションが有効な場合は 0 以外。それ以外の場合は 0。

解説

アニメーションを有効または無効にするには、 CMFCOutlookBarTabCtrl::EnableAnimation 関数を呼び出します。

CMFCOutlookBarTabCtrl::IsMode2003

Outlook バー タブ コントロールが Microsoft Outlook 2003 をエミュレートするモードであるかどうかを判断します。

BOOL IsMode2003() const;

戻り値

Outlook バー タブ コントロールが Outlook 2003 モードの場合は TRUE。それ以外の場合は FALSE。

解説

この値は、 CMFCOutlookBar::SetMode2003 によって設定されます。

CMFCOutlookBarTabCtrl::OnShowFewerPageButtons

表示されるタブ ページ ボタンの数を減らすためにフレームワークによって呼び出されます。

virtual void OnShowFewerPageButtons();

解説

このメソッドは、コントロールのサイズが変更されたときに表示されるページ タブ ボタンの数を調整します。

CMFCOutlookBarTabCtrl::OnShowMorePageButtons

表示されるタブ ページ ボタンの数を増やすためにフレームワークによって呼び出されます。

virtual void OnShowMorePageButtons();

解説

このメソッドは、コントロールのサイズが変更されたときに表示されるタブ ページ ボタンの数を調整します。

CMFCOutlookBarTabCtrl::OnShowOptions

[ ナビゲーション ウィンドウのオプション ] ダイアログ ボックスを表示します。

virtual void OnShowOptions();

解説

[ ナビゲーション ウィンドウのオプション ] ダイアログ ボックスでは、表示するタブ ページ ボタンと表示順序を選択できます。

このメソッドは、ユーザーがコントロールのカスタマイズ メニューから Navigation Pane Options メニュー項目を選択すると、フレームワークによって呼び出されます。

CMFCOutlookBarTabCtrl::SetActiveTab

アクティブなタブを設定します。アクティブなタブは開いているタブで、その内容が表示されます。

virtual BOOL SetActiveTab(int iTab);

パラメーター

iTab
[in]開くタブの 0 から始まるインデックス。

戻り値

指定したタブが正常に開かれた場合は 0 以外。それ以外の場合は 0。

解説

アクティブなタブを設定した場合の視覚効果は、アニメーションを有効にしているかどうかによって異なります。 詳細については、「 CMFCOutlookBarTabCtrl::EnableAnimationを参照してください。

CMFCOutlookBarTabCtrl::SetBorderSize

Outlook タブ コントロールの罫線のサイズを設定します。

void SetBorderSize(int nBorderSize);

パラメーター

nBorderSize
[in]新しい境界線のサイズをピクセル単位で指定します。

解説

新しい罫線のサイズを設定し、Outlook ウィンドウのレイアウトを再計算します。

CMFCOutlookBarTabCtrl::SetPageButtonTextAlign

Outlook バーのタブ ボタンのテキスト ラベルの配置を設定します。

void SetPageButtonTextAlign(
    UINT uiAlign,
    BOOL bRedraw=TRUE);

パラメーター

uiAlign
[in]テキストの配置を指定します。

bRedraw
[in]TRUE の場合、Outlook ウィンドウが再描画されます。

解説

この関数を使用して、ページ ボタンのテキストの配置を変更します。

uiAlign には、次のいずれかの値を指定できます。

既定値は TA_CENTER です。

CMFCOutlookBarTabCtrl::SetToolbarImageList

Outlook 2003 モードの Outlook バーの下部に表示されるアイコンを含むビットマップを設定します。

BOOL SetToolbarImageList(
    UINT uiID,
    int cx,
    COLORREF clrTransp=RGB(255, 0, 255));

パラメーター

uiID
[in]読み込むイメージのリソース ID を指定します。

cx
[in]イメージ リスト内のイメージの幅をピクセル単位で指定します。

clrTransp
[in]透明な色を指定する RGB 値。

戻り値

成功した場合は TRUE を返します。それ以外の場合は FALSE を返します。

解説

この関数を使用して、Microsoft Office 2003 モードのツール バー ボタンに画像が表示されるイメージ リストを添付します。 イメージ インデックスはページ インデックスに対応している必要があります。

Microsoft Office 2003 モードでない場合は、このメソッドを呼び出さないでください。 詳細については、「 CMFCOutlookBar クラスを参照してください。

CMFCOutlookBarTabCtrl::SetVisiblePageButtons

void SetVisiblePageButtons(int nVisiblePageButtons);

パラメーター

[入力] nVisiblePageButtons

解説

関連項目

階層図
クラス
CMFCBaseTabCtrl クラス
CMFCOutlookBar クラス
CMFCOutlookBarPane クラス