CJumpList-klasse

Opmerking

De Microsoft Foundation Classes-bibliotheek (MFC) wordt nog steeds ondersteund. We voegen echter geen functies meer toe of werken de documentatie bij.

A CJumpList is de lijst met sneltoetsen die worden weergegeven wanneer u met de rechtermuisknop op een pictogram op de taakbalk klikt.

Syntaxis

class CJumpList;

Leden

Openbare constructors

Naam	Description
CJumpList::CJumpList	Maakt een CJumpList object.
CJumpList::~CJumpList	Vernietigt een CJumpList object.

Naam	Description
CJumpList::AbortList	Hiermee wordt een transactie voor het maken van een lijst afgebroken zonder dat deze wordt doorgevoerd.
CJumpList::AddDestination	Overbelast. Hiermee voegt u het doel toe aan de lijst.
CJumpList::AddKnownCategory	Hiermee voegt u een bekende categorie toe aan de lijst.
CJumpList::AddTask	Overbelast. Hiermee voegt u items toe aan de categorie Canonieke taken.
CJumpList::AddTasks	Hiermee voegt u items toe aan de categorie Canonieke taken.
CJumpList::AddTaskSeparator	Hiermee voegt u een scheidingsteken tussen taken toe.
CJumpList::ClearAll	Hiermee verwijdert u alle taken en bestemmingen die tot nu toe zijn toegevoegd aan het huidige exemplaar CJumpList .
CJumpList::ClearAllDestinations	Hiermee verwijdert u alle bestemmingen die tot nu toe zijn toegevoegd aan het huidige exemplaar CJumpList .
CJumpList::CommitList	Hiermee wordt een transactie voor het maken van lijsten beëindigd en wordt de gerapporteerde lijst doorgevoerd in het bijbehorende archief (in dit geval het register.)
CJumpList::GetDestinationList	Hiermee haalt u een interfaceaanwijzer naar de doellijst op.
CJumpList::GetMaxSlots	Hiermee haalt u het maximum aantal items op, inclusief categoriekoppen die kunnen worden weergegeven in het doelmenu van de aanroepende toepassing.
CJumpList::GetRemovedItems	Retourneert een matrix met items die verwijderde bestemmingen vertegenwoordigen.
CJumpList::InitializeList	Hiermee begint u een transactie voor het maken van een lijst.
CJumpList::SetAppID	Hiermee stelt u de model-id van de toepassingsgebruiker in voor de lijst die wordt gemaakt.

Overnamehiërarchie

CJumpList

Requirements

Koptekst: afxadv.h

CJumpList::~CJumpList

Vernietigt een CJumpList object.

~CJumpList();

CJumpList::AbortList

Hiermee wordt een transactie voor het maken van een lijst afgebroken zonder dat deze wordt doorgevoerd.

void AbortList();

Opmerkingen

Het aanroepen van deze methode heeft hetzelfde effect als vernietigen CJumpList zonder aanroepen CommitList.

CJumpList::AddDestination

Hiermee voegt u het doel toe aan de lijst.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parameterwaarden

lpcszCategoryName
Hiermee geeft u een categorienaam. Als de opgegeven categorie niet bestaat, wordt deze gemaakt.

strDestinationPath
Hiermee geeft u een pad naar het doelbestand.

strCategoryName
Hiermee geeft u een categorienaam. Als de opgegeven categorie niet bestaat, wordt deze gemaakt.

pShellItem
Hiermee geeft u een Shell-item op dat de bestemming vertegenwoordigt die wordt toegevoegd.

pShellLink
Hiermee geeft u een Shell-koppeling op die de bestemming vertegenwoordigt die wordt toegevoegd.

Retourwaarde

Opmerkingen

Het exemplaar van CJumpList intern verzamelt toegevoegde bestemmingen en voert ze vervolgens door in CommitList.

CJumpList::AddKnownCategory

Hiermee voegt u een bekende categorie toe aan de lijst.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parameterwaarden

category
Hiermee geeft u een bekend categorietype. Kan KDC_RECENT of KDC_KNOWN zijn.

Retourwaarde

Opmerkingen

Bekende categorieën zijn de veelgebruikte en recente categorieën die in sommige scenario's automatisch worden berekend voor elke toepassing die deze gebruikt SHAddToRecentDocs (of indirect gebruikt als de shell deze namens de toepassing aanroept).

CJumpList::AddTask

Hiermee voegt u items toe aan de categorie Canonieke taken.

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

BOOL AddTask(IShellLink* pShellLink);

Parameterwaarden

strTargetExecutablePath
Hiermee geeft u het doeltaakpad op.

strCommandLineArgs
Hiermee geeft u opdrachtregelargumenten op van het uitvoerbare bestand dat is opgegeven door strTargetExecutablePath.

strTitle
Taaknaam die wordt weergegeven in de doellijst.

strIconLocation
Locatie van pictogram dat samen met de titel wordt weergegeven in de doellijst.

iIconIndex
Pictogramindex.

pShellLink
Shell-koppeling die een taak vertegenwoordigt die moet worden toegevoegd.

Retourwaarde

Opmerkingen

Het exemplaar van het verzamelen van CJumpList opgegeven taken en voegt deze toe aan de doellijst tijdens CommitList. Taakitems worden weergegeven in een categorie onderaan het doelmenu van de toepassing. Deze categorie heeft voorrang op alle andere categorieën wanneer deze wordt ingevuld in de gebruikersinterface.

CJumpList::AddTasks

Hiermee voegt u items toe aan de categorie Canonieke taken.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parameterwaarden

pObjectCollection
Een verzameling taken die moeten worden toegevoegd.

Retourwaarde

Opmerkingen

Het exemplaar van CJumpList verzamelt opgegeven taken en voegt deze toe aan de doellijst tijdens CommitList. Taakitems worden weergegeven in een categorie onderaan het doelmenu van de toepassing. Deze categorie heeft voorrang op alle andere categorieën wanneer deze wordt ingevuld in de gebruikersinterface.

CJumpList::AddTaskSeparator

Hiermee voegt u een scheidingsteken tussen taken toe.

BOOL AddTaskSeparator();

Retourwaarde

Nonzero als het lukt, 0 als dat niet het is.

CJumpList::CJumpList

Maakt een CJumpList object.

CJumpList(BOOL bAutoCommit = TRUE);

Parameterwaarden

bAutoCommit
Als deze parameter ONWAAR is, wordt de lijst niet automatisch doorgevoerd in destructor.

CJumpList::ClearAll

Hiermee verwijdert u alle taken en bestemmingen die tot nu toe zijn toegevoegd aan het huidige exemplaar CJumpList .

void ClearAll();

Opmerkingen

Met deze methode worden alle gegevens en interne interfaces gewist en vrijgegeven.

CJumpList::ClearAllDestinations

Hiermee verwijdert u alle bestemmingen die tot nu toe zijn toegevoegd aan het huidige exemplaar van CJumpList.

void ClearAllDestinations();

Opmerkingen

Roep deze functie aan als u alle bestemmingen wilt verwijderen die tot nu toe zijn toegevoegd in de huidige sessie van het bouwen van de doellijst en andere bestemmingen opnieuw wilt toevoegen. Als de interne ICustomDestinationList is geïnitialiseerd, blijft het levend.

CJumpList::CommitList

Hiermee wordt een transactie voor het maken van lijsten beëindigd en wordt de gerapporteerde lijst doorgevoerd in het bijbehorende archief (in dit geval het register).

BOOL CommitList();

Retourwaarde

Opmerkingen

De doorvoering is atomisch. Er wordt een fout geretourneerd als de doorvoering mislukt. Wanneer CommitList deze wordt aangeroepen, wordt de huidige lijst met verwijderde items opgeschoond. Als u deze methode aanroept, wordt het object opnieuw ingesteld, zodat het geen actieve transactie voor het maken van lijsten heeft. Als u de lijst wilt bijwerken, BeginList moet u opnieuw worden aangeroepen.

CJumpList::GetDestinationList

Hiermee haalt u een interfaceaanwijzer naar de doellijst op.

ICustomDestinationList* GetDestinationList();

Retourwaarde

Opmerkingen

Als de jumplist niet is geïnitialiseerd of is doorgevoerd of afgebroken, is de geretourneerde waarde NULL.

CJumpList::GetMaxSlots

Hiermee haalt u het maximum aantal items op, inclusief categoriekoppen die kunnen worden weergegeven in het doelmenu van de aanroepende toepassing.

UINT GetMaxSlots() const;

Retourwaarde

Opmerkingen

Toepassingen kunnen slechts een aantal items en categoriekoppen tot deze waarde rapporteren. Als oproepen naar AppendCategory, AppendKnownCategoryof AddUserTasks hoger zijn dan dit aantal, retourneren ze een fout.

CJumpList::GetRemovedItems

Retourneert een matrix met items die verwijderde bestemmingen vertegenwoordigen.

IObjectArray* GetRemovedItems();

Retourwaarde

Opmerkingen

De verwijderde bestemmingen worden opgehaald tijdens de initialisatie van de jumplist. Bij het genereren van een nieuwe doellijst zullen toepassingen naar verwachting eerst de lijst met verwijderde bestemmingen verwerken, waarbij de traceringsgegevens worden gewist voor elk item dat wordt geretourneerd door de verwijderde lijst-opsomming. Als een toepassing probeert een item op te geven dat zojuist is verwijderd in de transactie waaraan de huidige aanroep moet BeginList worden gestart, mislukt de methodeaanroep die dat item opnieuw heeft toegevoegd, om ervoor te zorgen dat toepassingen de verwijderde lijst respecteren.

CJumpList::InitializeList

Hiermee begint u een transactie voor het maken van een lijst.

BOOL InitializeList();

Retourwaarde

Opmerkingen

U hoeft deze methode niet expliciet aan te roepen, tenzij u een aanwijzer wilt ophalen voor ICustomDestinationList het gebruikGetDestinationList, het aantal beschikbare sleuven met behulp GetMaxSlotsvan of een lijst met verwijderde items.GetRemovedItems

CJumpList::SetAppID

Hiermee stelt u de model-id van de toepassingsgebruiker in voor de lijst die wordt gemaakt.

void SetAppID(LPCTSTR strAppID);

Parameterwaarden

strAppID
Een tekenreeks die de model-id van de toepassingsgebruiker aangeeft.

Zie ook

Klassen