共用方式為


CMFCTasksPane 類別

如需更多詳細資料,請參閱 Visual Studio 安裝位置下之 VC\atlmfc\src\mfc 資料夾中的原始程式碼。

CMFCTasksPane 類別會實作可點選式項目 (工作) 清單。

語法

class CMFCTasksPane : public CDockablePane

成員

公用建構函式

名稱 描述
CMFCTasksPane::CMFCTasksPane 建構 CMFCTasksPane 物件。

公用方法

名稱 描述
CMFCTasksPane::AddGroup 將新的工作群組加入至工作窗格控制項。
CMFCTasksPane::AddLabel 將新的靜態標籤加入至指定的工作群組。
CMFCTasksPane::AddMRUFilesList 將最近使用的 (MRU) 檔案清單所指定的工作加入到群組。
CMFCTasksPane::AddPage 將新頁面加入工作窗格。
CMFCTasksPane::AddSeparator
CMFCTasksPane::AddTask 將新工作加入至指定的工作群組。
CMFCTasksPane::AddWindow 將子視窗加入工作窗格。
CMFCTasksPane::CollapseAllGroups
CMFCTasksPane::CollapseGroup 以程式設計方式摺疊群組。
CMFCTasksPane::CreateDefaultMiniframe (覆寫 CPane::CreateDefaultMiniframe.)
CMFCTasksPane::CreateMenu 由架構呼叫,以建立 [其他工作窗格] 功能表按鈕的功能表
CMFCTasksPane::EnableAnimation 啟用或停用摺疊或展開工作群組時的動畫。
CMFCTasksPane::EnableGroupCollapse 指定是否可以摺疊工作群組。
CMFCTasksPane::EnableHistoryMenuButtons 啟用或停用 [下一步] 和 [上一頁] 導覽按鈕中的下拉功能表。
CMFCTasksPane::EnableNavigationToolbar 啟用或停用導覽工具列。
CMFCTasksPane::EnableOffsetCustomControls
CMFCTasksPane::EnableScrollButtons 啟用捲動按鈕而非捲軸。
CMFCTasksPane::EnableWrapLabels 啟用或停用標籤的自動換行。
CMFCTasksPane::EnableWrapTasks 啟用或停用工作的自動換行。
CMFCTasksPane::GetActivePage 傳回使用中頁面以零為基底的索引。
CMFCTasksPane::GetGroupCaptionHeight 傳回群組標題的高度。
CMFCTasksPane::GetGroupCaptionHorzOffset 傳回群組標題距離工作窗格的左邊緣和右邊緣的目前位移。
CMFCTasksPane::GetGroupCaptionVertOffset 傳回群組標題距離工作窗格的上邊緣和下邊緣的目前位移。
CMFCTasksPane::GetGroupCount 傳回群組總數。
CMFCTasksPane::GetGroupLocation 傳回特定群組的內部群組索引。
CMFCTasksPane::GetGroupVertOffset 傳回群組的垂直位移。
CMFCTasksPane::GetHorzMargin 傳回工作窗格與用戶端區域邊緣之間的水平間距。
CMFCTasksPane::GetNextPages
CMFCTasksPane::GetPageByGroup 擷取指定之群組的頁面索引。
CMFCTasksPane::GetPagesCount 傳回頁數。
CMFCTasksPane::GetPreviousPages
CMFCTasksPane::GetScrollBarCtrl (覆寫 CWnd::GetScrollBarCtrl.)
CMFCTasksPane::GetTask 擷取工作。
CMFCTasksPane::GetTaskCount 傳回指定群組中工作項目的數目。
CMFCTasksPane::GetTaskGroup 傳回給定之群組索引的工作群組。
CMFCTasksPane::GetTaskLocation 傳回特定工作的群組與索引。
CMFCTasksPane::GetTasksHorzOffset 傳回工作距離其父群組的左邊緣和右邊緣的水平位移。
CMFCTasksPane::GetTasksIconHorzOffset
CMFCTasksPane::GetTasksIconVertOffset
CMFCTasksPane::GetVertMargin 傳回工作窗格與用戶端區域邊緣之間的垂直間距。
CMFCTasksPane::IsAccessibilityCompatible (覆寫 CDockablePane::IsAccessibilityCompatible。)
CMFCTasksPane::IsAnimationEnabled 指出是否啟用動畫。
CMFCTasksPane::IsBackButtonEnabled 指出是否啟用上一頁按鈕。
CMFCTasksPane::IsForwardButtonEnabled 指出是否啟用下一頁按鈕。
CMFCTasksPane::IsGroupCollapseEnabled
CMFCTasksPane::IsHistoryMenuButtonsEnabled 指出 [下一步] 和 [上一步] 瀏覽按鈕是否有下拉功能表。
CMFCTasksPane::IsNavigationToolbarEnabled 指出是否啟用導覽工具列。
CMFCTasksPane::IsToolBox
CMFCTasksPane::IsWrapLabelsEnabled 指出工作窗格的標籤中是否自動換行。
CMFCTasksPane::IsWrapTasksEnabled 指出工作窗格的工作中是否自動換行。
CMFCTasksPane::LoadState (覆寫 CDockablePane::LoadState.)
CMFCTasksPane::OnCancel
CMFCTasksPane::OnClickTask 使用者按一下工作窗格中的項目時由架構呼叫。
CMFCTasksPane::OnOK
CMFCTasksPane::OnPressBackButton 使用者按一下上一頁按鈕時由架構呼叫。
CMFCTasksPane::OnPressForwardButton 使用者按一下上一步瀏覽按鈕時由架構呼叫。
CMFCTasksPane::OnPressHomeButton 使用者按一下首頁瀏覽按鈕時由架構呼叫
CMFCTasksPane::OnPressOtherButton
CMFCTasksPane::OnSetAccData (覆寫 CBasePane::OnSetAccData.)
CMFCTasksPane::OnUpdateCmdUI (覆寫 CDockablePane::OnUpdateCmdUI.)
CMFCTasksPane::P reTranslateMessage (覆寫 CDockablePane::P reTranslateMessage.)
CMFCTasksPane::RecalcLayout (覆寫 CPane::RecalcLayout.)
CMFCTasksPane::RemoveAllGroups 移除指定之頁面上的所有群組。
CMFCTasksPane::RemoveAllPages 從工作窗格中移除所有頁面,預設 (第一頁) 頁面除外。
CMFCTasksPane::RemoveAllTasks 從群組中移除所有工作。
CMFCTasksPane::RemoveGroup 移除群組。
CMFCTasksPane::RemovePage 從工作窗格移除指定的頁面。
CMFCTasksPane::RemoveTask 從工作群組中移除工作。
CMFCTasksPane::SaveState (覆寫 CDockablePane::SaveState.)
CMFCTasksPane::Serialize (覆寫 CDockablePane::Serialize.)
CMFCTasksPane::SetActivePage 啟動工作窗格中指定的頁面。
CMFCTasksPane::SetCaption 設定工作窗格的標題名稱。
CMFCTasksPane::SetGroupCaptionHeight 設定群組標題的高度。
CMFCTasksPane::SetGroupCaptionHorzOffset 設定群組標題的水平位移。
CMFCTasksPane::SetGroupCaptionVertOffset 設定群組標題的垂直位移。
CMFCTasksPane::SetGroupName 設定群組名稱。
CMFCTasksPane::SetGroupTextColor 設定群組標題的文字色彩。
CMFCTasksPane::SetGroupVertOffset 設定群組的垂直位移。
CMFCTasksPane::SetHorzMargin 設定工作窗格與用戶端區域邊緣之間的水平間距。
CMFCTasksPane::SetIconsList 設定與工作相關聯的影像清單。
CMFCTasksPane::SetPageCaption 設定工作窗格頁面的標題文字。
CMFCTasksPane::SetTaskName 設定工作的名稱。
CMFCTasksPane::SetTasksIconHorzOffset
CMFCTasksPane::SetTasksIconVertOffset
CMFCTasksPane::SetTaskTextColor 設定工作的文字色彩。
CMFCTasksPane::SetTasksHorzOffset 設定工作距離其父群組的左邊緣和右邊緣的水平位移。
CMFCTasksPane::SetVertMargin 設定工作窗格與用戶端區域邊緣之間的垂直間距。
CMFCTasksPane::SetWindowHeight 設定視窗的高度。
CMFCTasksPane::ShowCommandMessageString
CMFCTasksPane::ShowTask 顯示或隱藏工作。
CMFCTasksPane::ShowTaskByCmdId 根據其命令識別碼顯示或隱藏工作。
CMFCTasksPane::Update 更新屬於工作窗格的 GUI 項目。

受保護的方法

名稱 描述
CMFCTasksPane::OnActivateTasksPanePage 啟動新工作窗格頁面時,由架構呼叫。

備註

CMFCTasksPane 類別會實作下列功能:

  • 項目可以組成群組,而且每個項目群組可以有相關聯的標題。

  • 可摺疊或展開項目群組。

  • 圖示可以指派給工作窗格中的每個項目。

  • 個別項目可以與使用者按一下項目時執行的命令識別碼相關聯。 按兩下發生時,會將WM_COMMAND訊息傳送至工作窗格控件的擁有者。

若要在您的應用程式中使用 CMFCTasksPane 控制項,請遵循下列步驟:

  1. 內嵌 CMFCTasksPane 物件到主框架視窗類別。

  2. 處理WM_CREATE訊息時,請呼叫 Create 方法。 您可以使用一般 CControlBar 樣式。 如需詳細資訊,請參閱CControlBar::Create

  3. 呼叫 CMFCTasksPane::AddGroup 方法以新增各種群組。

  4. 呼叫 CMFCTasksPane::AddTaskCMFCTasksPane::AddLabelCMFCTasksPane::AddMRUFilesList 成員函式,將新專案(工作)新增至每個群組。

  5. 呼叫 CMFCTasksPane::EnableGroupCollapse 以指定專案群組是否可以折疊。

下圖顯示典型的工作窗格控制項。 第一個群組是一個 特殊 群組,其標題是較深的色彩。 第三個群組會摺疊。 最後一個群組會與工作窗格的底端對齊,並且沒有標題,而群組中的最後一個工作是簡單的標籤:

工作窗格的範例。

您可以藉由調整各種邊界和位移來自訂工作窗格的外觀。 下圖將釐清這些變數的意義:

自訂工作組。

範例

下列範例示範如何建構 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]指定以零起始的頁面索引。

lpszGroupName
[in]指定組名。

bBottomLocation
[in]TRUE 是表示 在工作窗格控件底部建立群組;否則為 FALSE。

bSpecial
[in]TRUE 表示將此群組標示為特殊群組,否則為 FALSE。 如需特殊群組的詳細資訊,請參閱 的 CMFCTasksPane一節。

hIcon
[in]指定要顯示在群組標題中的圖示。

傳回值

類別所維護群組內部清單中的群組以零起始的索引。

備註

呼叫此方法以建立一組工作,並將該群組新增至工作窗格控件。

架構會在工作窗格控件頂端或底部顯示工作組。 架構只能在底部顯示一個群組;此群組必須最後新增。

CMFCTasksPane::AddLabel

將標籤加入至指定的工作組。

int AddLabel(
    int nGroup,
    LPCTSTR lpszLabelName,
    int nTaskIcon = -1,
    BOOL bIsBold = FALSE);

參數

nGroup
[in]指定新增標籤之群組的索引。

lpszLabelName
[in]指定標籤的名稱。

nTaskIcon
[in]指定要在標籤旁邊顯示的圖示。 架構會將圖示儲存在影像清單中。 此參數是該清單中的索引。

bIsBold
[in]TRUE 表示以粗體文字顯示標籤;否則為 FALSE。

傳回值

加入標籤之群組的以零起始的索引,如果 nGroup 指定的群組不存在,則為 -1。

備註

架構會以不同的方式處理工作和標籤。 當使用者按下工作時,架構會執行命令。 當使用者按兩下卷標時,不會執行任何命令。 如需詳細資訊,請參閱 CMFCTasksPane::AddTask

CMFCTasksPane::AddMRUFilesList

將儲存在最近使用中 (MRU) 檔案清單中的每個檔案的工作新增至群組。

int AddMRUFilesList(
    int nGroup,
    int nMaxFiles = 4);

參數

nGroup
[in]指定群組的索引。 這個方法會將 MRU 檔案清單新增至此參數指定的群組。

nMaxFiles
[in]指定要顯示在 MRU 檔案清單中的檔案數目。

傳回值

新增 MRU 檔案清單之群組的以零起始的索引,如果 nGroup 指定的群組不存在,則為 -1。

CMFCTasksPane::AddPage

將頁面新增至工作窗格。

int AddPage(LPCTSTR lpszPageLabel);

參數

lpszPageLabel
[in]指定頁面的標籤。

傳回值

新頁面以零起始的索引。

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]指定使用者按下工作時所要執行的命令命令標識碼。 如果 uiCommandID 為 0,工作會被視為標籤。

dwUserData
[in]指定要與工作相關聯的使用者定義數據。

傳回值

加入工作的群組以零起始的索引,如果 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 表示移除工作時終結視窗;否則為 FALSE。

dwUserData
[in]指定與工作相關聯的使用者定義數據。

傳回值

加入視窗之群組的以零起始的索引,如果 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 表示折迭群組;FALSE 以展開群組。

nGroup
[in]指定要在群組內部清單中折疊之群組之以零起始的索引。

傳回值

如果群組折迭或成功展開,則為TRUE;否則為 FALSE。

備註

折迭的群組只會顯示群組標題;工作清單已隱藏。

CMFCTasksPane::CreateDefaultMiniframe

virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);

參數

[in] rectInitial

傳回值

備註

CMFCTasksPane::CreateMenu

建立當使用者按兩下 [其他工作窗格 ] 功能表按鈕時出現的功能表。

HMENU CreateMenu() const;

傳回值

新功能表的句柄。

備註

覆寫衍生類別中的這個方法,以自定義工作窗格的功能表。

這個方法所建立的彈出視窗包含工作窗格中的頁面清單。 功能表會顯示使用中頁面旁的複選標記。

CMFCTasksPane::EnableAnimation

啟用或停用當工作組展開或折迭時所發生的動畫。

void EnableAnimation(BOOL bEnable = TRUE);

參數

bEnable
[in]TRUE 表示啟用當工作組展開或折迭時所發生的動畫;否則為 FALSE。

備註

根據預設,啟用工作組展開或折疊時所發生的動畫。

CMFCTasksPane::EnableGroupCollapse

指定使用者是否可以折疊工作組。

void EnableGroupCollapse(BOOL bEnable);

參數

bEnable
[in]如果使用者可以折迭工作組,則為TRUE;否則為 FALSE。

備註

折迭的工作群組只會顯示群組標題;工作清單已隱藏。

CMFCTasksPane::EnableHistoryMenuButtons

啟用 [下一步] 和 [上一頁] 瀏覽按鈕上的下拉功能表。

void EnableHistoryMenuButtons(BOOL bEnable = TRUE);

參數

bEnable
[in]TRUE 表示在 [下一步] 和 [上一個] 瀏覽按鈕上啟用下拉功能表,否則為 FALSE。

備註

根據預設,[下一步] 和 [上一步] 按鈕上的下拉功能表會停用。

功能表包含使用者所使用的工作頁面歷程記錄。

CMFCTasksPane::EnableNavigationToolbar

啟用或停用導覽工具列。

void EnableNavigationToolbar(
    BOOL bEnable = TRUE,
    UINT uiToolbarBmpRes = 0,
    CSize sizeToolbarImage = CSize(0,
    0),
    CSize sizeToolbarButton = CSize(0,
    0));

參數

bEnable
[in]TRUE 表示啟用導覽工具列;否則為 FALSE。

uiToolbarBmpRes
[in]指定點圖的資源識別元,其中包含要顯示在工具列上的影像。

sizeToolbarImage
[in]指定工具列影像的大小。

sizeToolbarButton
[in]指定工具列按鈕的大小。

備註

導覽工具列是架構顯示在工作窗格頂端的工具列。 導覽工具列包含 [上一頁] 和 [首頁] 導覽按鈕,以及包含可用頁面清單的功能表按鈕。

根據預設,架構不會顯示導覽工具列。 如果未顯示導覽工具列,瀏覽按鈕會位於停駐列的標題上。

CMFCTasksPane::EnableOffsetCustomControls

void EnableOffsetCustomControls(BOOL bEnable);

參數

[in] bEnable

備註

CMFCTasksPane::EnableScrollButtons

啟用滾動按鈕,而不是滾動條。

void EnableScrollButtons(BOOL bEnable = TRUE);

參數

bEnable
[in]TRUE 是表示 在工作窗格中顯示滾動按鈕,而不是滾動條;否則為 FALSE。

備註

根據預設,架構會在工作窗格中顯示卷動按鈕。

CMFCTasksPane::EnableWrapLabels

啟用或停用標籤文字的自動換行。

void EnableWrapLabels(BOOL bEnable = TRUE);

參數

bEnable
[in]TRUE 表示在工作窗格上出現的卷標中換行文字;否則為 FALSE。

備註

根據預設,架構不會將文字包裝在標籤中。 啟用自動換行時,標籤中的文字可以出現在多行中。 標籤可以包含折線標記,例如 \n 和底線標記 &

CMFCTasksPane::EnableWrapTasks

啟用或停用工作中文字的自動換行。

void EnableWrapTasks(BOOL bEnable = TRUE);

參數

bEnable
[in]TRUE 表示將工作包裝在工作窗格中;否則為 FALSE。

備註

根據預設,會停用工作的自動換行。

CMFCTasksPane::GetActivePage

傳回使用中頁面以零為基底的索引。

int GetActivePage() const;

傳回值

使用中頁面之以零起始的索引。

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]包含以零起始的工作組索引。

傳回值

如果找到工作組,則為TRUE;否則為 FALSE。

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]指定以零起始的工作組索引。

nPage
[out]包含指定群組的頁面索引。 如果工作組只包含預設頁面,則傳回的值是 0。

傳回值

如果群組 nGroup 存在,則為 TRUE,否則為 FALSE。

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]指定包含工作的群組以零起始的索引。

nTask
[in]指定 nGroup 所指定清單中工作之以零起始的索引。

傳回值

位於指定索引的工作。

CMFCTasksPane::GetTaskCount

傳回指定群組中的工作數目。

int GetTaskCount(int nGroup) const;

參數

nGroup
[in]指定工作組的索引。

傳回值

指定群組中的工作數目,如果 nGroup 無效,則為 0。

CMFCTasksPane::GetTaskGroup

傳回指定群組索引的工作群組。

CMFCTasksPaneTaskGroup* GetTaskGroup(int nGroup) const;

參數

nGroup
[in]指定要擷取之群組的以零起始的索引。

傳回值

位於指定索引的工作組。

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]指定要尋找之工作的命令標識碼。

nGroup
[out]包含工作的群組索引。

nTask
[out]包含工作組中工作的索引。

hwndTask
[in]指定與工作相關聯的視窗。

pTask
[in]指定要尋找的工作。

傳回值

如果找到工作位置,則為TRUE;如果指定的工作不存在,則為 FALSE。

備註

這個方法會擷取指定工作的群組索引和工作索引。 如果方法傳回 FALSE,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;否則為 FALSE。

備註

呼叫 CMFCTasksPane::EnableAnimation 以啟用或停用動畫。

CMFCTasksPane::IsBackButtonEnabled

指出是否啟用上一頁按鈕。

BOOL IsBackButtonEnabled() const;

傳回值

如果已啟用返回按鈕,則為TRUE;否則為 FALSE。

備註

當使用者按兩下 [上一頁] 按鈕時,架構會顯示上一個工作頁面。

CMFCTasksPane::IsForwardButtonEnabled

指出是否啟用下一頁按鈕。

BOOL IsForwardButtonEnabled() const;

傳回值

如果已啟用正向按鈕,則為TRUE;否則為 FALSE。

備註

[轉寄] 按鈕可在工作頁面的歷程記錄中啟用向前流覽。

CMFCTasksPane::IsGroupCollapseEnabled

BOOL IsGroupCollapseEnabled() const;

傳回值

備註

CMFCTasksPane::IsHistoryMenuButtonsEnabled

指出 [下一步] 和 [上一步] 瀏覽按鈕是否有下拉功能表。

BOOL IsHistoryMenuButtonsEnabled() const;

傳回值

如果 [下一步] 和 [上一頁] 導覽按鈕具有下拉功能表,則為 TRUE;否則為 FALSE。

CMFCTasksPane::IsNavigationToolbarEnabled

指出是否啟用導覽工具列。

BOOL IsNavigationToolbarEnabled() const;

傳回值

如果導覽工具列已啟用,則為TRUE;否則為 FALSE。

CMFCTasksPane::IsToolBox

virtual BOOL IsToolBox() const;

傳回值

備註

CMFCTasksPane::IsWrapLabelsEnabled

指出工作窗格的標籤中是否自動換行。

BOOL IsWrapLabelsEnabled() const;

傳回值

如果標籤中的單字已包裝,則為 TRUE;否則為 FALSE。

CMFCTasksPane::IsWrapTasksEnabled

指定架構是否包裝工作字串。

BOOL IsWrapTasksEnabled() const;

傳回值

如果工作字串已包裝,則為TRUE;否則為 FALSE。

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]指定包含已點選工作的群組以零起始的索引。

nTaskNumber
[in]指定已點選工作的以零起始的索引。

uiCommandID
[in]指定與工作相關聯的命令標識碼。

dwUserData
[in]包含與所按兩下工作相關聯的使用者定義數據。

備註

當使用者按下工作時,架構會呼叫此方法。 根據預設,架構會檢查與所單擊工作相關聯的命令標識符,如果不是零,則會將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);

參數

[in] pTarget
[in] bDisableIfNoHndler

備註

CMFCTasksPane::P reTranslateMessage

virtual BOOL PreTranslateMessage(MSG* pMsg);

參數

[in] pMsg

傳回值

備註

CMFCTasksPane::RecalcLayout

void RecalcLayout(BOOL bRedraw = TRUE);

參數

[in] bRedraw

備註

CMFCTasksPane::RemoveAllGroups

移除指定之頁面上的所有群組。

void RemoveAllGroups(int nPageIdx = 0);

參數

nPageIdx
[in]指定頁面以零起始的索引。

備註

拿掉 nPageIdx指定頁面上的所有群組,如果只有預設頁面,則移除所有群組。

CMFCTasksPane::RemoveAllPages

從工作窗格中移除所有頁面,預設 (第一頁) 頁面除外。

void RemoveAllPages();

CMFCTasksPane::RemoveAllTasks

從指定的群組中移除所有工作。

void RemoveAllTasks(int nGroup);

參數

nGroup
[in]指定群組以零起始的索引。

CMFCTasksPane::RemoveGroup

移除群組。

void RemoveGroup(int nGroup);

參數

nGroup
[in]指定要移除之群組的以零起始的索引。

備註

此方法會移除單一群組。 若要移除所有群組,請改為呼叫 CMFCTasksPane::RemoveAllGroups

當架構移除群組時,所有與其相關聯的工作和用戶視窗都會終結。

CMFCTasksPane::RemovePage

從工作窗格移除指定的頁面。

void RemovePage(int nPageIdx);

參數

nPageIdx
[in]指定要移除之頁面的以零起始的索引。

CMFCTasksPane::RemoveTask

從工作群組中移除工作。

BOOL RemoveTask(
    int nGroup,
    int nTask,
    BOOL bRedraw = TRUE);

參數

nGroup
[in]指定要移除之工作群組之以零起始的索引。

nTask
[in]指定要移除之工作之以零起始的索引。

bRedraw
[in]TRUE 可重新繪製工作窗格;否則為 FALSE。

傳回值

如果函式成功,則為TRUE;如果 nGroupnTask 無效,則為 FALSE。

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]指定要顯示之頁面之以零起始的索引。

備註

如果 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]指定群組以零起始的索引。

lpszGroupName
[in]指定組名。

傳回值

如果成功設定組名,則為TRUE;否則為 FALSE。

CMFCTasksPane::SetGroupTextColor

設定群組標題的文字色彩。

BOOL SetGroupTextColor(
    int nGroup,
    COLORREF color,
    COLORREF colorHot = (COLORREF)-1);

參數

nGroup
[in]指定群組以零起始的索引。

color
[in]指定文字色彩。

colorHot
[in]指定醒目提示群組的文字色彩。 如果為 -1,則會使用預設醒目提示色彩。

傳回值

如果群組文字色彩已成功變更,則為TRUE;否則為 FALSE。

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]指定映像清單的資源識別碼。

cx
[in]指定影像清單中的圖示大小。

clrTransparent
[in]指定透明色彩。

hIcons
[in]指定包含工作窗格圖示的影像清單。

備註

架構會將圖示儲存在影像清單中。 工作與儲存在該清單中的圖示相關聯。

這個方法會將影像清單與工作窗格控件產生關聯。 若要在呼叫 CMFCTasksPane::AddTask 時設定工作的圖示,請將 設定 nTaskIcon 為此影像清單中的適當以零起始的索引。

CMFCTasksPane::SetPageCaption

設定工作窗格頁面的標題文字。

void SetPageCaption(
    int nPageIdx,
    LPCTSTR lpszName);

參數

nPageIdx
[in]指定頁面以零起始的索引。

lpszName
[in]指定要顯示在頁面上的標題文字。

備註

如果工作窗格有多個頁面,默認頁面會使用這個方法設定標題。

CMFCTasksPane::SetTaskName

設定工作的名稱。

BOOL SetTaskName(
    int nGroup,
    int nTask,
    LPCTSTR lpszTaskName);

參數

nGroup
[in]指定以零起始的工作組索引。

nTask
[in]指定工作之以零起始的索引。

lpszTaskName
[in]指定工作名稱。

傳回值

如果已成功設定工作名稱,則為TRUE;否則為 FALSE。

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]指定包含工作之工作組之以零起始的索引。

nTask
[in]指定工作之以零起始的索引。

color
[in]指定工作的文字色彩。

colorHot
[in]指定醒目提示群組的文字色彩。 如果為 -1,這個方法會使用預設醒目提示色彩。

傳回值

如果已成功設定工作的文字色彩,則為TRUE;否則為 FALSE。

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]指定包含視窗控制件之群組之以零起始的索引。

hwndTask
[in]指定視窗控制件的句柄。

nWndHeight
[in]指定要設定的高度。

傳回值

如果已成功設定視窗控制元件的高度,則為TRUE;如果 nGroup 無效或 hwndTask 不存在,則為 FALSE。

備註

呼叫 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]指定群組以零起始的索引。

nTask
[in]指定要顯示或隱藏之工作之以零起始的索引。

bShow
[in]TRUE 可顯示工作;FALSE 可隱藏工作。

bRedraw
[in]TRUE 可重新繪製工作窗格;否則為 FALSE。

傳回值

如果工作已成功顯示或隱藏,則為TRUE;如果指定的群組或工作不存在,則為 FALSE。

備註

使用 CMFCTasksPane::ShowTaskByCmdId 根據其命令標識碼來顯示或隱藏工作。

CMFCTasksPane::ShowTaskByCmdId

根據其命令識別碼顯示或隱藏工作。

BOOL ShowTaskByCmdId(
    UINT uiCommandID,
    BOOL bShow = TRUE,
    BOOL bRedraw = TRUE);

參數

uiCommandID
[in]指定要顯示或隱藏之工作的命令標識碼。

bShow
[in]TRUE 可顯示工作;FALSE 可隱藏工作。

bRedraw
[in]TRUE 可重新繪製工作窗格;否則為 FALSE。

傳回值

如果工作已成功顯示或隱藏,則為TRUE;如果具有指定命令標識碼的工作不存在,則為 FALSE。

備註

使用 CMFCTasksPane::ShowTask 根據其命令標識碼來顯示或隱藏工作。

CMFCTasksPane::Update

重新整理工作窗格中的所有控制件。

virtual void Update();

備註

此方法會更新工作窗格標題、調整滾動條、重新定位所有工作,以及重新繪製所有工作窗格控件。

覆寫衍生類別中的這個方法,以在架構重新整理工作窗格時執行自定義程序代碼。

另請參閱

階層架構圖表
類別
CMFCTasksPaneTaskGroup 類別
CMFCTasksPaneTask 類別
CMFCOutlookBar 類別
CMFCVisualManager 類別