Classe CJumpList

Un CJumpList è l'elenco dei collegamenti visualizzati quando si fa clic con il pulsante destro del mouse su un'icona nella barra delle applicazioni.

Sintassi

class CJumpList;

Membri

Costruttori pubblici

Gerarchia di ereditarietà

CJumpList

Requisiti

Intestazione: afxadv.h

CJumpList::~CJumpList

Elimina un oggetto CJumpList .

~CJumpList();

CJumpList::AbortList

Interrompe una transazione di compilazione dell'elenco senza eseguire il commit.

void AbortList();

Osservazioni:

La chiamata a questo metodo ha lo stesso effetto dell'eliminazione definitiva CJumpList senza chiamare CommitList.

CJumpList::AddDestination

Aggiunge la destinazione all'elenco.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parametri

lpcszCategoryName
Specifica un nome di categoria. Se la categoria specificata non esiste, verrà creata.

strDestinationPath
Specifica un percorso del file di destinazione.

strCategoryName
Specifica un nome di categoria. Se la categoria specificata non esiste, verrà creata.

pShellItem
Specifica un elemento della shell che rappresenta la destinazione da aggiungere.

pShellLink
Specifica un collegamento shell che rappresenta la destinazione da aggiungere.

Valore restituito

Osservazioni:

L'istanza di CJumpList accumula internamente le destinazioni aggiunte e quindi le esegue il commit in CommitList.

CJumpList::AddKnownCategory

Aggiunge una categoria nota all'elenco.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parametri

category
Specifica un tipo di categoria noto. Può essere KDC_RECENT o KDC_KNOWN.

Valore restituito

Osservazioni:

Le categorie note sono le categorie frequenti e recenti che verranno calcolate automaticamente per ogni applicazione che usa SHAddToRecentDocs (o indirettamente la usa come la shell lo chiamerà per conto dell'applicazione in alcuni scenari).

CJumpList::AddTask

Aggiunge elementi alla categoria Attività canonica.

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

BOOL AddTask(IShellLink* pShellLink);

Parametri

strTargetExecutablePath
Specifica il percorso dell'attività di destinazione.

strCommandLineArgs
Specifica gli argomenti della riga di comando dell'eseguibile specificato da strTargetExecutablePath.

strTitle
Nome dell'attività che verrà visualizzato nell'elenco di destinazione.

strIconLocation
Posizione dell'icona che verrà visualizzata nell'elenco di destinazione insieme al titolo.

iIconIndex
Indice icona.

pShellLink
Collegamento shell che rappresenta un'attività da aggiungere.

Valore restituito

Osservazioni:

L'istanza di CJumpList accumula le attività specificate e le aggiunge all'elenco di destinazione durante CommitList. Gli elementi attività verranno visualizzati in una categoria nella parte inferiore del menu di destinazione dell'applicazione. Questa categoria ha la precedenza su tutte le altre categorie quando viene compilata nell'interfaccia utente.

CJumpList::AddTasks

Aggiunge elementi alla categoria Attività canonica.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parametri

pObjectCollection
Raccolta di attività da aggiungere.

Valore restituito

Osservazioni:

L'istanza di CJumpList accumula le attività specificate e le aggiunge all'elenco di destinazione durante CommitList. Gli elementi attività verranno visualizzati in una categoria nella parte inferiore del menu di destinazione dell'applicazione. Questa categoria ha la precedenza su tutte le altre categorie quando viene compilata nell'interfaccia utente.

CJumpList::AddTaskSeparator

Aggiunge un separatore tra le attività.

BOOL AddTaskSeparator();

Valore restituito

Diverso da zero se ha esito positivo, 0 in caso contrario.

CJumpList::CJumpList

Costruisce un oggetto CJumpList.

CJumpList(BOOL bAutoCommit = TRUE);

Parametri

bAutoCommit
Se questo parametro è FALSE, l'elenco non viene eseguito automaticamente il commit nel distruttore.

CJumpList::ClearAll

Rimuove tutte le attività e le destinazioni aggiunte all'istanza corrente di CJumpList finora.

void ClearAll();

Osservazioni:

Questo metodo cancella e rilascia tutti i dati e le interfacce interne.

CJumpList::ClearAllDestinations

Rimuove tutte le destinazioni aggiunte all'istanza corrente di CJumpList finora.

void ClearAllDestinations();

Osservazioni:

Chiamare questa funzione se è necessario rimuovere tutte le destinazioni aggiunte finora nella sessione corrente della compilazione dell'elenco di destinazione e aggiungere di nuovo altre destinazioni. Se l'interno ICustomDestinationList è stato inizializzato, rimane attivo.

CJumpList::CommitList

Termina una transazione di compilazione elenco ed esegue il commit dell'elenco segnalato nell'archivio associato (in questo caso il Registro di sistema).

BOOL CommitList();

Valore restituito

Osservazioni:

Il commit è atomico. Se il commit ha esito negativo, verrà restituito un errore. Quando CommitList viene chiamato, l'elenco corrente di elementi rimossi verrà pulito. La chiamata a questo metodo reimposta l'oggetto in modo che non disponga di una transazione di compilazione elenco attiva. Per aggiornare l'elenco, BeginList deve essere chiamato di nuovo.

CJumpList::GetDestinationList

Recupera un puntatore di interfaccia all'elenco di destinazione.

ICustomDestinationList* GetDestinationList();

Valore restituito

Osservazioni:

Se il jump list non è stato inizializzato o è stato eseguito il commit o l'interruzione, il valore restituito sarà NULL.

CJumpList::GetMaxSlots

Recupera il numero massimo di elementi, incluse le intestazioni di categoria che possono essere visualizzate nel menu di destinazione dell'applicazione chiamante.

UINT GetMaxSlots() const;

Valore restituito

Osservazioni:

Le applicazioni possono segnalare solo diversi elementi e intestazioni di categoria combinati fino a questo valore. Se le chiamate a AppendCategory, AppendKnownCategoryo AddUserTasks superano questo numero, restituiranno un errore.

CJumpList::GetRemovedItems

Restituisce una matrice di elementi che rappresentano le destinazioni rimosse.

IObjectArray* GetRemovedItems();

Valore restituito

Osservazioni:

Le destinazioni rimosse vengono recuperate durante l'inizializzazione della jump list. Quando si genera un nuovo elenco di destinazione, le applicazioni devono prima elaborare l'elenco delle destinazioni rimosse, cancellando i dati di rilevamento per qualsiasi elemento restituito dall'enumeratore elenco rimosso. Se un'applicazione tenta di fornire un elemento appena rimosso nella transazione a cui è stata avviata la chiamata corrente, la chiamata al BeginList metodo che riaggiunse tale elemento avrà esito negativo, per assicurarsi che le applicazioni rispettino l'elenco rimosso.

CJumpList::InitializeList

Avvia una transazione di compilazione elenco.

BOOL InitializeList();

Valore restituito

Osservazioni:

Non è necessario chiamare questo metodo in modo esplicito, a meno che non si desideri recuperare un puntatore all'uso ICustomDestinationList GetDestinationListdi , il numero di slot disponibili usando GetMaxSlotso l'elenco di elementi rimossi usando GetRemovedItems.

CJumpList::SetAppID

Imposta l'ID modello utente applicazione per l'elenco che verrà compilato.

void SetAppID(LPCTSTR strAppID);

Parametri

strAppID
Stringa che specifica l'ID modello utente applicazione.

Vedi anche

Classi