CJumpList-Klasse

A CJumpList ist die Liste der Tastenkombinationen, die angezeigt werden, wenn Sie mit der rechten Maustaste auf ein Symbol in der Taskleiste klicken.

Syntax

class CJumpList;

Member

Öffentliche Konstruktoren

Vererbungshierarchie

CJumpList

Anforderungen

Kopfzeile: afxadv.h

CJumpList::~CJumpList

Zerstört ein CJumpList -Objekt.

~CJumpList();

CJumpList::AbortList

Bricht eine Listenerstellungstransaktion ab, ohne einen Commit durchzuführen.

void AbortList();

Hinweise

Das Aufrufen dieser Methode hat die gleiche Wirkung wie das CJumpList Zerstören ohne Aufrufen CommitList.

CJumpList::AddDestination

Fügt der Liste das Ziel hinzu.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parameter

lpcszCategoryName
Gibt einen Kategorienamen an. Wenn die angegebene Kategorie nicht vorhanden ist, wird sie erstellt.

strDestinationPath
Gibt einen Pfad zur Zieldatei an.

strCategoryName
Gibt einen Kategorienamen an. Wenn die angegebene Kategorie nicht vorhanden ist, wird sie erstellt.

pShellItem
Gibt ein Shellelement an, das das hinzugefügte Ziel darstellt.

pShellLink
Gibt einen Shelllink an, der das hinzugefügte Ziel darstellt.

Rückgabewert

Bemerkungen

Die Instanz der CJumpList intern hinzugefügten Ziele ansammelt und diese CommitListanschließend in .

CJumpList::AddKnownCategory

Fügt eine bekannte Kategorie an die Liste an.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parameter

category
Gibt einen bekannten Kategorietyp an. Kann entweder KDC_RECENT oder KDC_KNOWN sein.

Rückgabewert

Bemerkungen

Bekannte Kategorien sind die Kategorien "Häufig" und "Zuletzt verwendet", die automatisch für jede Anwendung berechnet werden, die verwendet SHAddToRecentDocs wird (oder indirekt verwendet wird, da die Shell sie in einigen Szenarien im Namen der Anwendung aufruft).

CJumpList::AddTask

Fügt der kategorie "Aufgaben" Elemente hinzu.

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

BOOL AddTask(IShellLink* pShellLink);

Parameter

strTargetExecutablePath
Gibt den Zielaufgabenpfad an.

strCommandLineArgs
Gibt Befehlszeilenargumente der ausführbaren Datei an, die von strTargetExecutablePath angegeben wird.

strTitle
Aufgabenname, der in der Zielliste angezeigt wird.

strIconLocation
Speicherort des Symbols, das zusammen mit dem Titel in der Zielliste angezeigt wird.

iIconIndex
Symbolindex.

pShellLink
Shelllink, der eine hinzuzufügende Aufgabe darstellt.

Rückgabewert

Bemerkungen

Die Instanz der CJumpList angegebenen Vorgänge und fügt sie während der CommitListZeit zur Zielliste hinzu. Aufgabenelemente werden in einer Kategorie unten im Zielmenü der Anwendung angezeigt. Diese Kategorie hat Vorrang vor allen anderen Kategorien, wenn sie in der Benutzeroberfläche ausgefüllt ist.

CJumpList::AddTasks

Fügt der kategorie "Aufgaben" Elemente hinzu.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parameter

pObjectCollection
Eine Sammlung von Aufgaben, die hinzugefügt werden sollen.

Rückgabewert

Bemerkungen

Die Instanz von CJumpList sammelt angegebene Vorgänge und fügt sie der Zielliste während der Zeit CommitListhinzu. Aufgabenelemente werden in einer Kategorie unten im Zielmenü der Anwendung angezeigt. Diese Kategorie hat Vorrang vor allen anderen Kategorien, wenn sie in der Benutzeroberfläche ausgefüllt ist.

CJumpList::AddTaskSeparator

Fügt ein Trennzeichen zwischen Vorgängen hinzu.

BOOL AddTaskSeparator();

Rückgabewert

Nonzero, wenn dies erfolgreich ist, 0, wenn dies nicht der Fehler ist.

CJumpList::CJumpList

Erstellt ein CJumpList-Objekt.

CJumpList(BOOL bAutoCommit = TRUE);

Parameter

bAutoCommit
Wenn dieser Parameter FALSE ist, wird die Liste nicht automatisch in destruktor zugesichert.

CJumpList::ClearAll

Entfernt alle Aufgaben und Ziele, die der aktuellen Instanz CJumpList bisher hinzugefügt wurden.

void ClearAll();

Hinweise

Mit dieser Methode werden alle Daten und internen Schnittstellen gelöscht und freigegeben.

CJumpList::ClearAllDestinations

Entfernt alle Ziele, die bisher zur aktuellen Instanz von CJumpList hinzugefügt wurden.

void ClearAllDestinations();

Hinweise

Rufen Sie diese Funktion auf, wenn Sie alle Ziele entfernen müssen, die bisher in der aktuellen Sitzung der Ziellistenerstellung hinzugefügt wurden, und weitere Ziele erneut hinzufügen. Wenn das interne ICustomDestinationList Initialisiert wurde, bleibt es lebendig.

CJumpList::CommitList

Beendet eine Listenerstellungstransaktion und führt einen Commit für die gemeldete Liste an den zugeordneten Speicher (in diesem Fall die Registrierung) durch.

BOOL CommitList();

Rückgabewert

Bemerkungen

Der Commit ist atom. Wenn der Commit fehlschlägt, wird ein Fehler zurückgegeben. Wenn CommitList sie aufgerufen wird, wird die aktuelle Liste der entfernten Elemente bereinigt. Durch Aufrufen dieser Methode wird das Objekt zurückgesetzt, sodass es keine aktive Listenerstellungstransaktion hat. Um die Liste zu aktualisieren, BeginList muss erneut aufgerufen werden.

CJumpList::GetDestinationList

Ruft einen Schnittstellenzeiger auf die Zielliste ab.

ICustomDestinationList* GetDestinationList();

Rückgabewert

Bemerkungen

Wenn die Sprungliste nicht initialisiert oder zugesichert oder abgebrochen wurde, ist der zurückgegebene Wert NULL.

CJumpList::GetMaxSlots

Ruft die maximale Anzahl von Elementen ab, einschließlich Kategoriekopfzeilen, die im Zielmenü der aufrufenden Anwendung angezeigt werden können.

UINT GetMaxSlots() const;

Rückgabewert

Bemerkungen

Anwendungen können nur eine Reihe von Elementen und Rubrikenüberschriften zusammen mit diesem Wert melden. Wenn Aufrufe an AppendCategory, AppendKnownCategoryoder AddUserTasks diese Zahl überschreiten, wird ein Fehler zurückgegeben.

CJumpList::GetRemovedItems

Gibt ein Array von Elementen zurück, die entfernte Ziele darstellen.

IObjectArray* GetRemovedItems();

Rückgabewert

Bemerkungen

Die entfernten Ziele werden während der Initialisierung der Sprungliste abgerufen. Beim Generieren einer neuen Zielliste wird erwartet, dass Anwendungen zuerst die Liste der entfernten Ziele verarbeiten und deren Nachverfolgungsdaten für alle elemente löschen, die vom Enumerator der entfernten Liste zurückgegeben werden. Wenn eine Anwendung versucht, ein Element bereitzustellen, das gerade in der Transaktion entfernt wurde, zu der der aktuelle BeginList Aufruf gestartet wurde, schlägt der Methodenaufruf, der das Element erneut hinzugefügt hat, fehl, um sicherzustellen, dass Anwendungen die entfernte Liste respektieren.

CJumpList::InitializeList

Beginnt eine Listenerstellungstransaktion.

BOOL InitializeList();

Rückgabewert

Bemerkungen

Sie müssen diese Methode nicht explizit aufrufen, es sei denn, Sie möchten einen Zeiger auf ICustomDestinationList die Verwendung GetDestinationList, die Anzahl der verfügbaren Steckplätze oder GetMaxSlotsdie Liste der entfernten Elemente mithilfe GetRemovedItemsvon .

CJumpList::SetAppID

Legt die Anwendungsbenutzermodell-ID für die Liste fest, die erstellt wird.

void SetAppID(LPCTSTR strAppID);

Parameter

strAppID
Eine Zeichenfolge, die die Anwendungsbenutzermodell-ID angibt.

Siehe auch

Klassen