CJumpList Class

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件

ACJumpList是當您以滑鼠右鍵按一下工作列中的圖示時所顯示的快速鍵的清單。

class CJumpList;  

公用建構函式

名稱描述
CJumpList::CJumpList建構 CJumpList 物件。
CJumpList:: ~ CJumpList終結 CJumpList 物件。
名稱說明
CJumpList::AbortList中止清單建置交易不認可。
CJumpList::AddDestination多載。 將目的地加入至清單。
CJumpList::AddKnownCategory將已知的類別附加至清單。
CJumpList::AddTask多載。 將項目加入至標準工作分類。
CJumpList::AddTasks將項目加入至標準工作分類。
CJumpList::AddTaskSeparator新增工作之間的分隔符號。
CJumpList::ClearAll移除所有的工作和已加入至目前的執行個體的目的地CJumpList為止。
CJumpList::ClearAllDestinations移除已加入至目前的執行個體的所有目的地CJumpList為止。
CJumpList::CommitList結束清單建置異動,並將報告的清單認可至相關聯的儲存區 (在此情況下登錄。)
CJumpList::GetDestinationList擷取目的地清單的介面指標。
CJumpList::GetMaxSlots擷取項目,包括可以在呼叫應用程式的 [目的地] 功能表中顯示的類別標頭的最大數目。
CJumpList::GetRemovedItems傳回陣列,表示項目移除目的地。
CJumpList::InitializeList開始清單建立交易。
CJumpList::SetAppID設定清單,將建置的應用程式使用者模型識別碼。

CJumpList

標頭︰ afxadv.h

終結 CJumpList 物件。

~CJumpList();

中止清單建置交易不認可。

void AbortList();

備註

呼叫這個方法有相同的效果終結CJumpList而不需呼叫CommitList

將目的地加入至清單。

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,  
    LPCTSTR strDestinationPath);

 
BOOL AddDestination(
    LPCTSTR strCategoryName,  
    IShellItem* pShellItem);

 
BOOL AddDestination(
    LPCTSTR strCategoryName,  
    IShellLink* pShellLink);

參數

lpcszCategoryName
指定類別名稱。 如果指定的類別目錄不存在,就會建立。

strDestinationPath
指定目的地檔案的路徑。

strCategoryName
指定類別名稱。 如果指定的類別目錄不存在,就會建立。

pShellItem
指定代表要加入目的地的殼層項目。

pShellLink
指定代表要加入目的地的殼層連結。

傳回值

備註

執行個體CJumpList內部彙總加入的目的地,並再認可在CommitList

將已知的類別附加至清單。

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

參數

category
指定已知的類別類型。 可以是KDC_RECENT,或KDC_KNOWN

傳回值

備註

知道類別是經常] 和 [最近使用分類,我們會自動計算每個應用程式會利用SHAddToRecentDocs(或間接使用該介面會替應用程式在某些情況下呼叫它)。

將項目加入至標準工作分類。

BOOL AddTask(
    LPCTSTR strTargetExecutablePath,  
    LPCTSTR strCommandLineArgs,  
    LPCTSTR strTitle,  
    LPCTSTR strIconLocation,  
    int iIconIndex);  
  
BOOL AddTask(IShellLink* pShellLink);

參數

strTargetExecutablePath
指定的目標工作路徑。

strCommandLineArgs
指定可執行檔 strTargetExecutablePath 所指定的命令列引數。

strTitle
將目的地清單中顯示的工作名稱。

strIconLocation
將標題和目的地清單中顯示的圖示的位置。

iIconIndex
圖示的索引。

pShellLink
表示要加入工作的 shell 連結。

傳回值

備註

執行個體CJumpList彙總指定的工作,並將它們新增至目的地清單期間CommitList。 工作項目會出現在應用程式的目的地] 功能表底部的類別。 此類別的優先順序高於所有其他類別目錄報告 UI 中。

將項目加入至標準工作分類。

BOOL AddTasks(IObjectArray* pObjectCollection);

參數

pObjectCollection
要加入的工作的集合。

傳回值

備註

CJumpList 的執行個體彙總指定的工作,並將它們新增至目的地清單期間CommitList。 工作項目會出現在應用程式的目的地] 功能表底部的類別。 此類別的優先順序高於所有其他類別目錄報告 UI 中。

新增工作之間的分隔符號。

BOOL AddTaskSeparator();

傳回值

非零,如果成功,則不為 0。

建構 CJumpList 物件。

CJumpList(BOOL bAutoCommit = TRUE);

參數

bAutoCommit
如果這個參數是 FALSE 清單不會自動認可解構函式中。

移除所有的工作和已加入至目前的執行個體的目的地CJumpList為止。

void ClearAll();

備註

這個方法會清除並釋放所有資料和內部介面。

移除已加入至目前的執行個體的 CJumpList 到目前為止的所有目的地。

void ClearAllDestinations();

備註

如果您要移除所有目的地已經新增到目前為止的目的地清單建置目前的工作階段,並再次新增其他目的地,請呼叫此函式。 如果內部ICustomDestinationList已初始化,它就保持運作。

結束清單建立交易,並認可至相關聯的存放區 (在此情況下登錄) 的報告的清單。

BOOL CommitList();

傳回值

備註

Commit 就是不可部分完成的。 如果認可失敗,則會傳回錯誤。 當CommitList呼叫時,目前已移除的項目清單將會清除。 呼叫這個方法,使它並沒有使用中的清單建立交易,會重設物件。 若要更新的清單,BeginList需要被呼叫一次。

擷取目的地清單的介面指標。

ICustomDestinationList* GetDestinationList();

傳回值

備註

如果跳躍清單尚未初始化,或已認可或中止,傳回的值將是NULL

擷取項目,包括可以在呼叫應用程式的 [目的地] 功能表中顯示的類別標頭的最大數目。

UINT GetMaxSlots() const;  

傳回值

備註

應用程式可能只會報告許多項目和類別標頭結合到此值。 如果呼叫AppendCategoryAppendKnownCategory,或AddUserTasks超過此數目時,它們就會傳回失敗。

傳回陣列,表示項目移除目的地。

IObjectArray* GetRemovedItems();

傳回值

備註

移除的目的地的捷徑清單初始化期間擷取。 時產生新的目的地清單,應用程式都必須先處理移除的目的地清單中,清除其追蹤資料,移除的清單的列舉值所傳回的任何項目。 如果應用程式會嘗試提供只在呼叫目前交易中移除的項目BeginList啟動,重新新增該項目方法呼叫將會失敗,以確保應用程式會尊重移除的清單。

開始清單建立交易。

BOOL InitializeList();

傳回值

備註

您不需要明確呼叫這個方法,除非您想要擷取的指標ICustomDestinationList使用GetDestinationList,使用的可用插槽數目GetMaxSlots,或使用移除的項目清單GetRemovedItems

設定清單,將建置的應用程式使用者模型識別碼。

void SetAppID(LPCTSTR strAppID);

參數

strAppID
字串,指定應用程式使用者的模型識別碼。

類別

顯示: