CMFCTasksPane クラス
詳細については、Visual Studio インストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
CMFCTasksPane クラスは、クリック可能な項目 (タスク) のリストを実装します。
構文
class CMFCTasksPane : public CDockablePane
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
| CMFCTasksPane::CMFCTasksPane | CMFCTasksPane オブジェクトを構築します。 |
パブリック メソッド
保護メソッド
| 名前 | 説明 |
|---|---|
| CMFCTasksPane::OnActivateTasksPanePage | 新しい作業ウィンドウ ページがアクティブになると、フレームワークによって呼び出されます。 |
解説
CMFCTasksPane クラスは次の機能を実装します。
項目をグループ化し、項目の各グループにキャプションを関連付ける。
項目グループを展開したり、折りたたんだりする。
作業ウィンドウの各項目にアイコンを関連付ける。
個々の項目をコマンド ID に関連付けることができる。このコマンド ID は、ユーザーが項目をクリックすると実行されます。 クリックが発生すると、WM_COMMAND メッセージが作業ウィンドウ コントロールの所有者に送信されます。
アプリケーションで、CMFCTasksPane コントロールを使用するには、次の手順に従います。
CMFCTasksPaneオブジェクトをメイン フレーム ウィンドウ クラスに埋め込みます。WM_CREATE メッセージを処理するときは、メソッドを
Create呼び出します。 通常 の CControlBar スタイルを使用できます。 詳細については、CControlBar::Createを参照してください。CMFCTasksPane::AddGroup メソッドを呼び出して、さまざまなグループを追加します。
CMFCTasksPane::AddTask、CMFCTasksPane::AddLabel または CMFCTasksPane::AddMRUFilesList メンバー関数を呼び出して、新しい項目 (タスク) を各グループに追加します。
CMFCTasksPane::EnableGroupCollapse を呼び出して、項目グループを折りたたむことができるかどうかを指定します。
次の図は、標準的な作業ウィンドウ コントロールを示しています。 最初のグループは特殊なグループであり、そのキャプションは濃い色です。 3 番目のグループは折りたたまれています。 最後のグループは作業ウィンドウの最下部に揃えられており、キャプションはなく、このグループの最後のタスクは単純なラベルです。
作業ウィンドウの外観をカスタマイズするには、さまざまな余白やオフセットを調整します。 次の図に、それらの変数の意味を示します。
例
CMFCTasksPane オブジェクトを構築して CMFCTasksPane クラスのさまざまなメソッドを使用する方法を次の例に示します。 この例では、タスク グループの折りたたみを有効にする方法、[次へ] ナビゲーション ボタンと [前へ] ナビゲーション ボタンのドロップダウン メニューを有効にする方法、スクロール バーではなくスクロール ボタンを有効にする方法、ラベル内のテキストの折り返しを有効にする方法、作業ウィンドウのキャプション名を設定する方法、グループ キャプションのテキストの色を設定する方法、水平方向と垂直方向の余白を設定する方法を示します。
CMFCTasksPane *tPane = new CMFCTasksPane();
tPane->EnableGroupCollapse(true);
tPane->EnableHistoryMenuButtons(true);
tPane->EnableScrollButtons(true);
tPane->EnableWrapLabels(true);
tPane->SetCaption(_T("Task Pane"));
tPane->SetGroupTextColor(0, RGB(0, 0, 128));
tPane->SetHorzMargin(15);
tPane->SetVertMargin(15);
tPane->Update();
継承階層
CObject
└ CCmdTarget
└ CWnd
└ CBasePane
└ CPane
└ CDockablePane
└ CMFCTasksPane
必要条件
ヘッダー: afxTasksPane.h
CMFCTasksPane::AddGroup
タスクの新しいグループを作業ウィンドウ コントロールに追加します。
int AddGroup(
int nPageIdx,
LPCTSTR lpszGroupName,
BOOL bBottomLocation = FALSE,
BOOL bSpecial = FALSE,
HICON hIcon = NULL);
int AddGroup(
LPCTSTR lpszGroupName,
BOOL bBottomLocation = FALSE,
BOOL bSpecial = FALSE,
HICON hIcon = NULL);
パラメーター
nPageIdx
[in]0 から始まるページ インデックスを指定します。
lpszGroupName
[in]グループ名を指定します。
bBottomLocation
[in]作業ウィンドウ コントロールの下部にグループを作成する場合は TRUE。それ以外の場合は FAL Standard Edition。
bSpecial
[in]このグループを特別なグループとしてマークする場合は TRUE、それ以外の場合は FAL Standard Edition。 特別なグループの詳細については、次の「解説」セクション CMFCTasksPaneを参照してください。
hIcon
[in]グループ キャプションに表示するアイコンを指定します。
戻り値
クラスに含まれるグループの内部リスト内のグループの 0 から始まるインデックスメイン。
解説
タスクのグループを作成し、そのグループを作業ウィンドウ コントロールに追加するには、このメソッドを呼び出します。
フレームワークは、作業ウィンドウ コントロールの上部または下部にタスク グループを表示します。 フレームワークは、下部に 1 つのグループのみを表示できます。このグループは最後に追加する必要があります。
CMFCTasksPane::AddLabel
指定したタスク グループにラベルを追加します。
int AddLabel(
int nGroup,
LPCTSTR lpszLabelName,
int nTaskIcon = -1,
BOOL bIsBold = FALSE);
パラメーター
nGroup
[in]ラベルを追加するグループのインデックスを指定します。
lpszLabelName
[in]ラベルの名前を指定します。
nTaskIcon
[in]ラベルの横に表示するアイコンを指定します。 フレームワークは、アイコンをイメージの一覧に格納します。 このパラメーターは、そのリストのインデックスです。
bIsBold
[in]ラベルを太字で表示する場合は TRUE。それ以外の場合は FAL Standard Edition。
戻り値
ラベルが追加されたグループの 0 から始まるインデックス。nGroup で指定されたグループが存在しない場合は -1。
解説
フレームワークでは、タスクとラベルの処理方法が異なります。 ユーザーがタスクをクリックすると、フレームワークはコマンドを実行します。 ユーザーがラベルをクリックしても、コマンドは実行されません。 詳細については、「CMFCTasksPane::AddTask」を参照してください。
CMFCTasksPane::AddMRUFilesList
最近使用したファイル (MRU) の一覧に格納されている各ファイルのタスクをグループに追加します。
int AddMRUFilesList(
int nGroup,
int nMaxFiles = 4);
パラメーター
nGroup
[in]グループのインデックスを指定します。 このメソッドは、このパラメーターで指定されたグループに MRU ファイル リストを追加します。
nMaxFiles
[in]MRU ファイルの一覧に表示するファイルの数を指定します。
戻り値
MRU ファイル リストが追加されたグループの 0 から始まるインデックス。nGroup で指定されたグループが存在しない場合は -1。
CMFCTasksPane::AddPage
作業ウィンドウにページを追加します。
int AddPage(LPCTSTR lpszPageLabel);
パラメーター
lpszPageLabel
[in]ページのラベルを指定します。
戻り値
新しいページの 0 から始まるインデックス。
CMFCTasksPane::AddSeparator
int AddSeparator(int nGroup);
パラメーター
[in] nGroup
戻り値
解説
CMFCTasksPane::AddTask
指定したタスク グループにタスクを追加します。
int AddTask(
int nGroup,
LPCTSTR lpszTaskName,
int nTaskIcon = -1,
UINT uiCommandID = 0,
DWORD dwUserData = 0);
パラメーター
nGroup
[in]タスクを追加するグループ インデックスを指定します。
lpszTaskName
[in]タスクの名前を指定します。
nTaskIcon
[in]タスクの横に表示するアイコンを指定します。 フレームワークは、アイコンをイメージの一覧に格納します。 このパラメーターは、そのリストのインデックスです。
uiCommandID
[in]ユーザーがタスクをクリックしたときに実行するコマンドのコマンド ID を指定します。 uiCommandID が 0 の場合、タスクはラベルとして扱われます。
dwUserData
[in]タスクに関連付けるユーザー定義データを指定します。
戻り値
タスクが追加されたグループの 0 から始まるインデックス。nGroup で指定されたグループが存在しない場合は -1。
CMFCTasksPane::AddWindow
作業ウィンドウに子ウィンドウを追加します。
int AddWindow(
int nGroup,
HWND hwndTask,
int nWndHeight,
BOOL bAutoDestroyWindow = FALSE,
DWORD dwUserData = 0);
パラメーター
nGroup
[in]ウィンドウが追加されるグループ インデックスを指定します。
hwndTask
[in]追加するウィンドウのハンドルを指定します。
nWndHeight
[in]ウィンドウの高さを指定します。
bAutoDestroyWindow
[in]タスクが削除されたときにウィンドウを破棄する場合は TRUE。それ以外の場合は FAL Standard Edition。
dwUserData
[in]タスクに関連付けられているユーザー定義データを指定します。
戻り値
ウィンドウが追加されたグループの 0 から始まるインデックス。nGroup で指定されたグループが存在しない場合は -1。
解説
このメソッドを呼び出して、作業ウィンドウにコントロールを追加します。 たとえば、検索バーのように機能する編集コントロールを追加できます。
CMFCTasksPane::CMFCTasksPane
CMFCTasksPane オブジェクトを構築します。
CMFCTasksPane();
CMFCTasksPane::CollapseAllGroups
void CollapseAllGroups(BOOL bCollapse = TRUE);
void CollapseAllGroups(
int nPageIdx,
BOOL bCollapse);
パラメーター
[in] bCollapse
[in] nPageIdx
解説
CMFCTasksPane::CollapseGroup
グループを折りたたみまたは展開します。
BOOL CollapseGroup(
CMFCTasksPaneTaskGroup* pGroup,
BOOL bCollapse = TRUE);
BOOL CollapseGroup(
int nGroup,
BOOL bCollapse = TRUE);
パラメーター
pGroup
[in]折りたたむグループを指定します。
bCollapse
[in]グループを折りたたむ場合は TRUE。FAL Standard Edition グループを展開します。
nGroup
[in]グループの内部リストで折りたたむグループの 0 から始まるインデックスを指定します。
戻り値
グループが正常に折りたたまれたり展開されたりする場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
折りたたまれたグループには、グループ キャプションのみが表示され、タスクの一覧は非表示になります。
CMFCTasksPane::CreateDefaultMiniframe
virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);
パラメーター
[in] rectInitial
戻り値
解説
CMFCTasksPane::CreateMenu
ユーザーが [その他のタスク ウィンドウ] メニュー ボタンを クリックしたときに表示されるメニューを 作成します。
HMENU CreateMenu() const;
戻り値
新しいメニューへのハンドル。
解説
作業ウィンドウのメニューをカスタマイズするには、派生クラスでこのメソッドをオーバーライドします。
このメソッドによって作成されるポップアップ メニューには、作業ウィンドウ内のページの一覧が含まれています。 メニューには、アクティブなページの横にチェックマークが表示されます。
CMFCTasksPane::EnableAnimation
タスク グループが展開または折りたたまれたときに発生するアニメーションを有効または無効にします。
void EnableAnimation(BOOL bEnable = TRUE);
パラメーター
bEnable
[in]TRUE タスク グループが展開または折りたたまれたときに発生するアニメーションを有効にします。それ以外の場合は FAL Standard Edition。
解説
既定では、タスク グループが展開または折りたたまれたときに発生するアニメーションが有効になります。
CMFCTasksPane::EnableGroupCollapse
ユーザーがタスク グループを折りたたむことができるかどうかを指定します。
void EnableGroupCollapse(BOOL bEnable);
パラメーター
bEnable
[in]ユーザーがタスク グループを折りたたむことができる場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
折りたたまれているタスク グループには、グループ キャプションのみが表示され、タスクの一覧は非表示になります。
CMFCTasksPane::EnableHistoryMenuButtons
[次へ] ナビゲーション ボタンと [前へ] ナビゲーション ボタンのドロップダウン メニューを有効にします。
void EnableHistoryMenuButtons(BOOL bEnable = TRUE);
パラメーター
bEnable
[in]TRUE の場合は、[次へ] ナビゲーション ボタンと [前へ] ナビゲーション ボタンのドロップダウン メニューが有効になります。それ以外の場合は FAL Standard Edition。
解説
既定では、[次へ] ボタンと [前へ] ボタンのドロップダウン メニューは無効になっています。
メニューには、ユーザーが使用したタスク ページの履歴が含まれています。
CMFCTasksPane::EnableNavigationToolbar
ナビゲーション ツール バーを有効または無効にします。
void EnableNavigationToolbar(
BOOL bEnable = TRUE,
UINT uiToolbarBmpRes = 0,
CSize sizeToolbarImage = CSize(0,
0),
CSize sizeToolbarButton = CSize(0,
0));
パラメーター
bEnable
[in]ナビゲーション ツール バーを有効にする場合は TRUE。それ以外の場合は FAL Standard Edition。
uiToolbarBmpRes
[in]ツール バーに表示するイメージを含むビットマップのリソース ID を指定します。
sizeToolbarImage
[in]ツール バー イメージのサイズを指定します。
sizeToolbarButton
[in]ツール バー ボタンのサイズを指定します。
解説
ナビゲーション ツール バーは、作業ウィンドウの上部にフレームワークが表示されるツール バーです。 ナビゲーション ツール バーには、[戻る]、[進む]、[ホーム] のナビゲーション ボタンと、使用可能なページの一覧を含むメニュー ボタンが含まれています。
既定では、フレームワークにはナビゲーション ツール バーは表示されません。 ナビゲーション ツールバーが表示されない場合、ナビゲーション ボタンはドッキング バーのキャプションにあります。
CMFCTasksPane::EnableOffsetCustomControls
void EnableOffsetCustomControls(BOOL bEnable);
パラメーター
[入力] bEnable
解説
CMFCTasksPane::EnableScrollButtons
スクロール バーの代わりにスクロール ボタンを有効にします。
void EnableScrollButtons(BOOL bEnable = TRUE);
パラメーター
bEnable
[in]TRUE スクロール バーの代わりに作業ウィンドウにスクロール ボタンを表示します。それ以外の場合は FAL Standard Edition。
解説
既定では、フレームワークは作業ウィンドウにスクロール ボタンを表示します。
CMFCTasksPane::EnableWrapLabels
ラベル内のテキストの折り返しを有効または無効にします。
void EnableWrapLabels(BOOL bEnable = TRUE);
パラメーター
bEnable
[in]作業ウィンドウに表示されるラベルでテキストを折り返す場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
既定では、フレームワークはテキストをラベルで折り返しません。 単語折り返しが有効になっている場合、ラベル内のテキストを複数行で表示できます。 ラベルには、改行マーカー (下線マーカー&など\n) を含めることができます。
CMFCTasksPane::EnableWrapTasks
タスク内のテキストの折り返しを有効または無効にします。
void EnableWrapTasks(BOOL bEnable = TRUE);
パラメーター
bEnable
[in]作業ウィンドウでタスクをラップする場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
既定では、タスクのワード ラッピングは無効になっています。
CMFCTasksPane::GetActivePage
アクティブ ページの 0 から始まるインデックスを返します。
int GetActivePage() const;
戻り値
アクティブなページの 0 から始まるインデックス。
CMFCTasksPane::GetGroupCaptionHeight
グループ キャプションの高さを返します。
int GetGroupCaptionHeight() const;
戻り値
グループキャプションの高さ (ピクセル単位)。
CMFCTasksPane::GetGroupCaptionHorzOffset
グループ キャプションの水平方向のオフセットを返します。
int GetGroupCaptionHorzOffset() const;
戻り値
グループ キャプションの水平方向のオフセット。 水平オフセットは、作業ウィンドウの左端または右端からの距離 (ピクセル単位) です。
CMFCTasksPane::GetGroupCaptionVertOffset
グループ キャプションの垂直方向のオフセットを返します。
int GetGroupCaptionVertOffset() const;
戻り値
グループの垂直方向のオフセットは、作業ウィンドウの上端と下端からキャプション。
解説
垂直オフセットの既定値は 7 ピクセルです。
CMFCTasksPane::GetGroupCount
グループの総数を返します。
int GetGroupCount() const;
戻り値
作業ウィンドウ内のグループの合計数。
CMFCTasksPane::GetGroupLocation
指定したグループの内部グループ インデックスを返します。
BOOL GetGroupLocation(
CMFCTasksPaneTaskGroup* pGroup,
int& nGroup) const;
パラメーター
pGroup
[in]場所を取得するタスク グループを指定します。
nGroup
[out]タスク グループの 0 から始まるインデックスを格納します。
戻り値
タスク グループが見つかった場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::GetGroupVertOffset
グループの垂直方向のオフセットを返します。
int GetGroupVertOffset() const;
戻り値
グループの垂直方向のオフセット (ピクセル単位)。
CMFCTasksPane::GetHorzMargin
作業ウィンドウとクライアント領域の端との間の水平方向の間隔を返します。
int GetHorzMargin() const;
戻り値
作業ウィンドウとクライアント領域の端との間の水平方向の間隔。
解説
作業ウィンドウとクライアント領域の端の間の既定の間隔は 12 ピクセルです。
CMFCTasksPane::GetNextPages
void GetNextPages(CStringList& lstNextPages) const;
パラメーター
[in] lstNextPages
解説
CMFCTasksPane::GetPageByGroup
指定されたグループのページ インデックスを取得します。
BOOL GetPageByGroup(
int nGroup,
int& nPage) const;
パラメーター
nGroup
[in]タスク グループの 0 から始まるインデックスを指定します。
nPage
[out]指定したグループのページ インデックスを格納します。 タスク グループに既定のページのみが含まれている場合、返される値は 0 です。
戻り値
グループ nGroup が存在する場合は TRUE、それ以外の場合は FAL Standard Edition。
CMFCTasksPane::GetPagesCount
ページ数を返します。
int GetPagesCount() const;
戻り値
作業ウィンドウ内のページ数。
CMFCTasksPane::GetPreviousPages
void GetPreviousPages(CStringList& lstPrevPages) const;
パラメーター
[in] lstPrevPages
解説
CMFCTasksPane::GetScrollBarCtrl
virtual CScrollBar* GetScrollBarCtrl(int nBar) const;
パラメーター
[in] nBar
戻り値
解説
CMFCTasksPane::GetTask
タスクを取得します。
CMFCTasksPaneTask* GetTask(
int nGroup,
int nTask) const;
パラメーター
nGroup
[in]タスクを含むグループの 0 から始まるインデックスを指定します。
nTask
[in]nGroup で指定されたリスト内のタスクの 0 から始まるインデックスを指定 します。
戻り値
指定したインデックス位置にあるタスク。
CMFCTasksPane::GetTaskCount
指定したグループ内のタスクの数を返します。
int GetTaskCount(int nGroup) const;
パラメーター
nGroup
[in]タスク グループのインデックスを指定します。
戻り値
指定したグループ内のタスクの数。nGroup が無効な場合は 0。
CMFCTasksPane::GetTaskGroup
指定したグループ インデックスのタスク グループを返します。
CMFCTasksPaneTaskGroup* GetTaskGroup(int nGroup) const;
パラメーター
nGroup
[in]取得するグループの 0 から始まるインデックスを指定します。
戻り値
指定したインデックス位置にあるタスク グループ。
CMFCTasksPane::GetTaskLocation
指定したタスクのグループとインデックスを返します。
BOOL GetTaskLocation(
UINT uiCommandID,
int& nGroup,
int& nTask) const;
BOOL GetTaskLocation(
HWND hwndTask,
int& nGroup,
int& nTask) const;
BOOL GetTaskLocation(
CMFCTasksPaneTask* pTask,
int& nGroup,
int& nTask) const;
パラメーター
uiCommandID
[in]検索するタスクのコマンド ID を指定します。
nGroup
[out]タスクのグループ インデックスを格納します。
nTask
[out]タスク グループ内のタスクのインデックスを格納します。
hwndTask
[in]タスクに関連付けられているウィンドウを指定します。
pTask
[in]検索するタスクを指定します。
戻り値
タスクの場所が見つかった場合は TRUE。FAL Standard Edition 指定したタスクが存在しない場合。
解説
このメソッドは、指定したタスクのグループ インデックスとタスク インデックスを取得します。 メソッドが FAL Standard Edition を返す場合、nGroup と nTask は -1 に設定されます。
CMFCTasksPane::GetTasksHorzOffset
タスクの水平方向のオフセットを返します。
int GetTasksHorzOffset() const;
戻り値
親グループの左端と右端からのタスクの水平方向のオフセット。
解説
タスクの既定の水平オフセットは 12 ピクセルです。
CMFCTasksPane::GetTasksIconHorzOffset
int GetTasksIconHorzOffset() const;
戻り値
解説
CMFCTasksPane::GetTasksIconVertOffset
int GetTasksIconVertOffset() const;
戻り値
解説
CMFCTasksPane::GetVertMargin
作業ウィンドウとクライアント領域の端の間の垂直方向の余白を返します。
int GetVertMargin() const;
戻り値
作業ウィンドウとクライアント領域の端の間の垂直方向の余白。
解説
垂直方向の余白は、作業ウィンドウとクライアント領域の端の間のスペースです。 垂直余白の既定値は 12 ピクセルです。
CMFCTasksPane::IsAccessibilityCompatible
virtual BOOL IsAccessibilityCompatible();
戻り値
解説
CMFCTasksPane::IsAnimationEnabled
アニメーションが有効かどうかを示します。
BOOL IsAnimationEnabled() const;
戻り値
ユーザーがグループを展開または折りたたむときに発生するアニメーションが有効な場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCTasksPane::EnableAnimation を呼び出して、アニメーションを有効または無効にします。
CMFCTasksPane::IsBackButtonEnabled
[戻る] ボタンが有効かどうかを示します。
BOOL IsBackButtonEnabled() const;
戻り値
戻るボタンが有効な場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
ユーザーが [戻る] ボタンをクリックすると、フレームワークに前のタスク ページが表示されます。
CMFCTasksPane::IsForwardButtonEnabled
[進む] ボタンが有効かどうかを示します。
BOOL IsForwardButtonEnabled() const;
戻り値
進むボタンが有効な場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
[進む] ボタンを使用すると、タスク ページの履歴に移動できます。
CMFCTasksPane::IsGroupCollapseEnabled
BOOL IsGroupCollapseEnabled() const;
戻り値
解説
CMFCTasksPane::IsHistoryMenuButtonsEnabled
[次へ] ナビゲーション ボタンと [前へ] ナビゲーション ボタンにドロップダウン メニューがあるかどうかを示します。
BOOL IsHistoryMenuButtonsEnabled() const;
戻り値
[次へ] ナビゲーション ボタンと [前へ] ナビゲーション ボタンにドロップダウン メニューがある場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::IsNavigationToolbarEnabled
ナビゲーション ツール バーが有効かどうかを示します。
BOOL IsNavigationToolbarEnabled() const;
戻り値
ナビゲーション ツール バーが有効な場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::IsToolBox
virtual BOOL IsToolBox() const;
戻り値
解説
CMFCTasksPane::IsWrapLabelsEnabled
作業ウィンドウでラベルのテキストが折り返されるかどうかを示します。
BOOL IsWrapLabelsEnabled() const;
戻り値
ラベル内の単語がラップされている場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::IsWrapTasksEnabled
フレームワークがタスク文字列をラップするかどうかを指定します。
BOOL IsWrapTasksEnabled() const;
戻り値
タスク文字列がラップされている場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::LoadState
virtual BOOL LoadState(
LPCTSTR lpszProfileName = NULL,
int nIndex = -1,
UINT uiID = (UINT) -1);
パラメーター
[in] lpszProfileName
[in] Nindex
[in] Uiid
戻り値
解説
CMFCTasksPane::OnActivateTasksPanePage
作業ウィンドウ ページをアクティブにすると、フレームワークによって呼び出されます。
virtual void OnActivateTasksPanePage();
解説
作業ウィンドウ ページの外観をカスタマイズするには、派生クラスでこのメソッドをオーバーライドします。
CMFCTasksPane::OnCancel
virtual void OnCancel();
解説
CMFCTasksPane::OnClickTask
ユーザーが作業ウィンドウ内の項目をクリックすると、フレームワークによって呼び出されます。
virtual void OnClickTask(
int nGroupNumber,
int nTaskNumber,
UINT uiCommandID,
DWORD dwUserData);
パラメーター
nGroupNumber
[in]クリックしたタスクを含むグループの 0 から始まるインデックスを指定します。
nTaskNumber
[in]クリックしたタスクの 0 から始まるインデックスを指定します。
uiCommandID
[in]タスクに関連付けられているコマンド ID を指定します。
dwUserData
[in]クリックされたタスクに関連付けられたユーザー定義データが含まれます。
解説
フレームワークは、ユーザーがタスクをクリックしたときにこのメソッドを呼び出します。 既定では、フレームワークはクリックされたタスクに関連付けられているコマンド ID をチェックし、ゼロでない場合は、WM_COMMAND メッセージを作業ウィンドウ コントロールの所有者に送信します。
タスクがクリックされたときにカスタム コードを実行するには、派生クラスでこのメソッドをオーバーライドします。
CMFCTasksPane::OnOK
virtual void OnOK();
解説
CMFCTasksPane::OnPressBackButton
ユーザーが [戻る] ナビゲーション ボタンをクリックすると、フレームワークによって呼び出されます。
virtual void OnPressBackButton();
解説
既定では、フレームワークには以前に表示されたページが表示されます。
ユーザーが [戻る] ボタンをクリックしたときにカスタム コードを実行するには、派生クラスでこのメソッドをオーバーライドします。
CMFCTasksPane::OnPressForwardButton
ユーザーが [進む] ナビゲーション ボタンをクリックすると、フレームワークによって呼び出されます。
virtual void OnPressForwardButton();
解説
既定では、[戻る] ボタンをクリックする前に、ユーザーが表示したページがフレームワークに表示されます。
ユーザーが [進む] ボタンをクリックしたときにカスタム コードを実行するには、派生クラスでこのメソッドをオーバーライドします。
CMFCTasksPane::OnPressHomeButton
ユーザーがホーム ナビゲーション ボタンをクリックすると、フレームワークによって呼び出されます。
virtual void OnPressHomeButton();
解説
既定では、フレームワークにはタスク グループの既定のページが表示されます。
ユーザーがホーム ナビゲーション ボタンをクリックしたときにカスタム コードを実行するには、派生クラスでこのメソッドをオーバーライドします。
CMFCTasksPane::OnPressOtherButton
virtual void OnPressOtherButton(
CMFCCaptionMenuButton* pbtn,
CWnd* pWndOwner);
パラメーター
[in] pbtn
[in] pWndOwner
解説
CMFCTasksPane::OnSetAccData
virtual BOOL OnSetAccData(long lVal);
パラメーター
[in] lVal
戻り値
解説
CMFCTasksPane::OnUpdateCmdUI
virtual void OnUpdateCmdUI(
CFrameWnd* pTarget,
BOOL bDisableIfNoHndler);
パラメーター
[入力] pTarget
[in] bDisableIfNoHndler
解説
CMFCTasksPane::P reTranslateMessage
virtual BOOL PreTranslateMessage(MSG* pMsg);
パラメーター
[入力] pMsg
戻り値
解説
CMFCTasksPane::RecalcLayout
void RecalcLayout(BOOL bRedraw = TRUE);
パラメーター
[in] bRedraw
解説
CMFCTasksPane::RemoveAllGroups
指定したページ上のすべてのグループを削除します。
void RemoveAllGroups(int nPageIdx = 0);
パラメーター
nPageIdx
[in]ページの 0 から始まるインデックスを指定します。
解説
nPageIdx で指定されたページ上のすべてのグループを削除します。既定のページしかない場合は、すべてのグループを削除します。
CMFCTasksPane::RemoveAllPages
既定 (最初) のページを除く、すべてのページを作業ウィンドウから削除します。
void RemoveAllPages();
CMFCTasksPane::RemoveAllTasks
指定したグループからすべてのタスクを削除します。
void RemoveAllTasks(int nGroup);
パラメーター
nGroup
[in]グループの 0 から始まるインデックスを指定します。
CMFCTasksPane::RemoveGroup
グループを削除します。
void RemoveGroup(int nGroup);
パラメーター
nGroup
[in]削除するグループの 0 から始まるインデックスを指定します。
解説
このメソッドは、1 つのグループを削除します。 すべてのグループを削除するには、代わりに CMFCTasksPane::RemoveAllGroups を呼び出します。
フレームワークがグループを削除すると、それに関連付けられているすべてのタスクとユーザー ウィンドウが破棄されます。
CMFCTasksPane::RemovePage
指定されたページを作業ウィンドウから削除します。
void RemovePage(int nPageIdx);
パラメーター
nPageIdx
[in]削除するページの 0 から始まるインデックスを指定します。
CMFCTasksPane::RemoveTask
タスク グループからタスクを削除します。
BOOL RemoveTask(
int nGroup,
int nTask,
BOOL bRedraw = TRUE);
パラメーター
nGroup
[in]削除するタスクを含むタスク グループの 0 から始まるインデックスを指定します。
nTask
[in]削除するタスクの 0 から始まるインデックスを指定します。
bRedraw
[in]作業ウィンドウを再描画する場合は TRUE。それ以外の場合は FAL Standard Edition。
戻り値
関数が成功した場合は TRUE。FAL Standard Edition nGroup または nTask が無効な場合。
CMFCTasksPane::SaveState
virtual BOOL SaveState(
LPCTSTR lpszProfileName = NULL,
int nIndex = -1,
UINT uiID = (UINT) -1);
パラメーター
[in] lpszProfileName
[in] Nindex
[in] Uiid
戻り値
解説
CMFCTasksPane::Serialize
virtual void Serialize(CArchive& ar);
パラメーター
[in] Ar
解説
CMFCTasksPane::SetActivePage
作業ウィンドウで指定したページをアクティブにします。
void SetActivePage(int nPageIdx);
パラメーター
nPageIdx
[in]表示するページの 0 から始まるインデックスを指定します。
解説
このメソッドは、nPageIdx が無効な場合にアサートします。
CMFCTasksPane::SetCaption
作業ウィンドウのキャプション名を設定します。
void SetCaption(LPCTSTR lpszName);
パラメーター
lpszName
[in]キャプション名を指定します。
解説
作業ウィンドウに複数のページがある場合、既定のページには、この関数を使用して設定されたキャプションがあります。
CMFCTasksPane::SetGroupCaptionHeight
グループ キャプションの高さを設定します。
void SetGroupCaptionHeight(int n = -1);
パラメーター
n
[in]キャプションの高さを指定します。
解説
作業ウィンドウ要素の余白をカスタマイズするには、このメソッドを呼び出します。
n が -1 の場合、フレームワークはビジュアル マネージャー ( CMFCVisualManager::GetTasksPaneGroupCaptionHeight) を使用して余白の値を決定します。 既定のキャプションの高さは 25 ピクセルです。
CMFCTasksPane::SetGroupCaptionHorzOffset
グループ キャプションの水平方向のオフセットを設定します。
void SetGroupCaptionHorzOffset(int n = -1);
パラメーター
n
[in]グループ キャプションの水平方向のオフセットを指定します。
CMFCTasksPane::SetGroupCaptionVertOffset
グループ キャプションの垂直方向のオフセットを設定します。
void SetGroupCaptionVertOffset(int n = -1);
パラメーター
n
[in]グループ キャプションの垂直方向のオフセットをピクセル単位で指定します。
CMFCTasksPane::SetGroupName
グループ名を設定します。
BOOL SetGroupName(
int nGroup,
LPCTSTR lpszGroupName);
パラメーター
nGroup
[in]グループの 0 から始まるインデックスを指定します。
lpszGroupName
[in]グループの名前を指定します。
戻り値
グループ名が正常に設定された場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::SetGroupTextColor
グループ キャプションのテキストの色を設定します。
BOOL SetGroupTextColor(
int nGroup,
COLORREF color,
COLORREF colorHot = (COLORREF)-1);
パラメーター
nGroup
[in]グループの 0 から始まるインデックスを指定します。
color
[in]テキストの色を指定します。
colorHot
[in]強調表示されたグループのテキストの色を指定します。 -1 の場合、既定の強調表示の色が使用されます。
戻り値
グループ テキストの色が正常に変更された場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::SetGroupVertOffset
グループの垂直方向のオフセットを設定します。
void SetGroupVertOffset(int n = -1);
パラメーター
n
[in]垂直方向のオフセットを指定します。
解説
垂直方向のオフセットは、作業グループと作業ウィンドウの境界線の間の距離です。
作業ウィンドウ要素の余白をカスタマイズするには、このメソッドを呼び出します。 n が -1 の場合、フレームワークはビジュアル マネージャー (CMFCVisualManager::GetTasksPaneGroupVertOffset) を使用してマージン値を決定します。 既定のオフセットは 15 ピクセルです。
CMFCTasksPane::SetHorzMargin
水平余白を設定します。
void SetHorzMargin(int n = -1);
パラメーター
n
[in]余白をピクセル単位で指定します。
解説
水平余白は、作業ウィンドウとクライアント領域の上端または下端との間の距離です。
n が -1 の場合、フレームワークはビジュアル マネージャー (CMFCVisualManager::GetTasksPaneHorzMargin) を使用して余白の値を決定します。 既定の水平余白は 12 ピクセルです。
CMFCTasksPane::SetIconsList
イメージの一覧を設定します。
BOOL SetIconsList(
UINT uiImageListResID,
int cx,
COLORREF clrTransparent = RGB(255, 0, 255));
void SetIconsList(HIMAGELIST hIcons);
パラメーター
uiImageListResID
[in]イメージ リストのリソース ID を指定します。
cx
[in]イメージ リスト内のアイコンのサイズを指定します。
clrTransparent
[in]透明な色を指定します。
hIcons
[in]作業ウィンドウのアイコンを含むイメージ リストを指定します。
解説
フレームワークは、アイコンをイメージ リストに格納します。 タスクは、そのリストに格納されているアイコンに関連付けられます。
このメソッドは、画像リストを作業ウィンドウ コントロールに関連付けます。 CMFCTasksPane::AddTask を呼び出すときにタスクのアイコンを設定するには、このイメージ リストの適切な 0 から始まるインデックスに設定nTaskIconします。
CMFCTasksPane::SetPageCaption
作業ウィンドウ ページのキャプション テキストを設定します。
void SetPageCaption(
int nPageIdx,
LPCTSTR lpszName);
パラメーター
nPageIdx
[in]ページの 0 から始まるインデックスを指定します。
lpszName
[in]ページに表示するキャプションテキストを指定します。
解説
作業ウィンドウに複数のページがある場合、既定のページには、このメソッドを使用して設定されたキャプションがあります。
CMFCTasksPane::SetTaskName
タスクの名前を設定します。
BOOL SetTaskName(
int nGroup,
int nTask,
LPCTSTR lpszTaskName);
パラメーター
nGroup
[in]タスク グループの 0 から始まるインデックスを指定します。
nTask
[in]タスクの 0 から始まるインデックスを指定します。
lpszTaskName
[in]タスク名を指定します。
戻り値
タスク名が正常に設定された場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::SetTasksHorzOffset
タスクの水平方向のオフセットを設定します。
void SetTasksHorzOffset(int n = -1);
パラメーター
n
[in]水平方向のオフセットを指定します。
解説
水平オフセットは、グループの左端と右端からの距離 (ピクセル単位) です。
n が -1 の場合、このメソッドは水平方向のオフセットをメソッドによって返される値にCMFCVisualManager::GetTasksPaneTaskHorzOffset設定します。
既定の水平オフセットは 12 ピクセルです。
CMFCTasksPane::SetTasksIconHorzOffset
void SetTasksIconHorzOffset(int n = -1);
パラメーター
[in] N
解説
CMFCTasksPane::SetTasksIconVertOffset
void SetTasksIconVertOffset(int n = -1);
パラメーター
[in] N
解説
CMFCTasksPane::SetTaskTextColor
タスクのテキストの色を設定します。
BOOL SetTaskTextColor(
int nGroup,
int nTask,
COLORREF color,
COLORREF colorHot = (COLORREF)-1);
パラメーター
nGroup
[in]タスクを含むタスク グループの 0 から始まるインデックスを指定します。
nTask
[in]タスクの 0 から始まるインデックスを指定します。
color
[in]タスクのテキストの色を指定します。
colorHot
[in]強調表示されたグループのテキストの色を指定します。 -1 の場合、このメソッドは既定の強調表示色を使用します。
戻り値
タスクのテキストの色が正常に設定された場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCTasksPane::SetVertMargin
垂直方向の余白を設定します。
void SetVertMargin(int n = -1);
パラメーター
n
[in]設定する垂直余白を指定します。
解説
垂直余白は、作業ウィンドウとクライアント領域の垂直エッジの間の距離です。
n が -1 の場合、フレームワークはビジュアル マネージャー (CMFCVisualManager::GetTasksPaneVertMargin) を使用してマージン値を決定します。 既定の余白は 12 ピクセルです。
CMFCTasksPane::SetWindowHeight
ウィンドウ コントロールの高さを設定します。
BOOL SetWindowHeight(
int nGroup,
HWND hwndTask,
int nWndHeight);
BOOL SetWindowHeight(
HWND hwndTask,
int nWndHeight);
パラメーター
nGroup
[in]ウィンドウ コントロールを含むグループの 0 から始まるインデックスを指定します。
hwndTask
[in]ウィンドウ コントロールへのハンドルを指定します。
nWndHeight
[in]設定する高さを指定します。
戻り値
ウィンドウ コントロールの高さが正常に設定された場合は TRUE。FAL Standard Edition nGroup が無効な場合、または hwndTask が存在しない場合。
解説
CMFCTasksPane::AddWindow を呼び出して、ウィンドウ コントロールを含むタスクを追加します。
CMFCTasksPane::ShowCommandMessageString
virtual void ShowCommandMessageString(UINT uiCmdId);
パラメーター
[in] uiCmdId
解説
CMFCTasksPane::ShowTask
タスクの表示と非表示を切り替えます。
BOOL ShowTask(
int nGroup,
int nTask,
BOOL bShow = TRUE,
BOOL bRedraw = TRUE);
パラメーター
nGroup
[in]グループの 0 から始まるインデックスを指定します。
nTask
[in]表示または非表示にするタスクの 0 から始まるインデックスを指定します。
bShow
[in]タスクを表示する場合は TRUE。FAL Standard Edition タスクを非表示にします。
bRedraw
[in]作業ウィンドウを再描画する場合は TRUE。それ以外の場合は FAL Standard Edition。
戻り値
タスクが正常に表示または非表示になった場合は TRUE。FAL Standard Edition指定されたグループまたはタスクが存在しない場合。
解説
CMFCTasksPane::ShowTaskByCmdId を使用して、コマンド ID に基づいてタスクを表示または非表示にします。
CMFCTasksPane::ShowTaskByCmdId
コマンド ID に基づいて、タスクの表示と非表示を切り替えます。
BOOL ShowTaskByCmdId(
UINT uiCommandID,
BOOL bShow = TRUE,
BOOL bRedraw = TRUE);
パラメーター
uiCommandID
[in]表示または非表示にするタスクのコマンド ID を指定します。
bShow
[in]タスクを表示する場合は TRUE。FAL Standard Edition タスクを非表示にします。
bRedraw
[in]作業ウィンドウを再描画する場合は TRUE。それ以外の場合は FAL Standard Edition。
戻り値
タスクが正常に表示または非表示になった場合は TRUE。FAL Standard Edition指定されたコマンド ID を持つタスクが存在しない場合。
解説
CMFCTasksPane::ShowTask を使用して 、 コマンド ID に基づいてタスクを表示または非表示にします。
CMFCTasksPane::Update
作業ウィンドウ内のすべてのコントロールを更新します。
virtual void Update();
解説
このメソッドは、作業ウィンドウのキャプションを更新し、スクロール バーを調整し、すべてのタスクの位置を変更し、すべての作業ウィンドウ コントロールを再描画します。
フレームワークが作業ウィンドウを更新するときにカスタム コードを実行するには、派生クラスでこのメソッドをオーバーライドします。
関連項目
階層図
クラス
CMFCTasksPaneTaskGroup クラス
CMFCTasksPaneTask クラス
CMFCOutlookBar クラス
CMFCVisualManager クラス
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示