Klasa CJumpList

To CJumpList lista skrótów ujawnionych po kliknięciu prawym przyciskiem myszy ikony na pasku zadań.

Składnia

class CJumpList;

Elementy członkowskie

Konstruktory publiczne

Nazwa/nazwisko	opis
CJumpList::CJumpList	CJumpList Tworzy obiekt.
CJumpList::~CJumpList	CJumpList Niszczy obiekt.

Nazwa/nazwisko	opis
CJumpList::AbortList	Przerywa transakcję tworzenia listy bez zatwierdzania.
CJumpList::AddDestination	Przeciążone. Dodaje miejsce docelowe do listy.
CJumpList::AddKnownCategory	Dołącza do listy znaną kategorię.
CJumpList::AddTask	Przeciążone. Dodaje elementy do kategorii zadania kanoniczne.
CJumpList::AddTasks	Dodaje elementy do kategorii zadania kanoniczne.
CJumpList::AddTaskSeparator	Dodaje separator między zadaniami.
CJumpList::ClearAll	Usuwa wszystkie zadania i miejsca docelowe, które zostały dodane do bieżącego CJumpList wystąpienia do tej pory.
CJumpList::ClearAllDestinations	Usuwa wszystkie miejsca docelowe, które zostały dodane do bieżącego CJumpList wystąpienia do tej pory.
CJumpList::CommitList	Kończy transakcję tworzenia listy i zatwierdza zgłoszoną listę w skojarzonym magazynie (rejestr w tym przypadku).
CJumpList::GetDestinationList	Pobiera wskaźnik interfejsu do listy docelowej.
CJumpList::GetMaxSlots	Pobiera maksymalną liczbę elementów, w tym nagłówki kategorii, które mogą być wyświetlane w menu docelowym aplikacji wywołującej.
CJumpList::GetRemovedItems	Zwraca tablicę elementów reprezentujących usunięte miejsca docelowe.
CJumpList::InitializeList	Rozpoczyna transakcję tworzenia listy.
CJumpList::SetAppID	Ustawia identyfikator modelu użytkownika aplikacji dla listy, która zostanie skompilowana.

Hierarchia dziedziczenia

Lista CJumpList

Wymagania

Nagłówek: afxadv.h

CJumpList::~CJumpList

CJumpList Niszczy obiekt.

~CJumpList();

CJumpList::AbortList

Przerywa transakcję tworzenia listy bez zatwierdzania.

void AbortList();

Uwagi

Wywołanie tej metody ma taki sam efekt jak niszczenie CJumpList bez wywoływania metody CommitList.

CJumpList::AddDestination

Dodaje miejsce docelowe do listy.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parametry

lpcszCategoryName
Określa nazwę kategorii. Jeśli określona kategoria nie istnieje, zostanie utworzona.

strDestinationPath
Określa ścieżkę do pliku docelowego.

strCategoryName
Określa nazwę kategorii. Jeśli określona kategoria nie istnieje, zostanie utworzona.

pShellItem
Określa element powłoki reprezentujący dodawane miejsce docelowe.

pShellLink
Określa łącze powłoki reprezentujące dodawane miejsce docelowe.

Wartość zwracana

Uwagi

Wystąpienie CJumpList wewnętrznie gromadzi dodane miejsca docelowe, a następnie zatwierdza je w pliku CommitList.

CJumpList::AddKnownCategory

Dołącza do listy znaną kategorię.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parametry

kategoria
Określa znany typ kategorii. Może to być KDC_RECENT lub KDC_KNOWN.

Wartość zwracana

Uwagi

Znane kategorie to często używane i ostatnie kategorie, które będą automatycznie obliczane dla każdej używanej SHAddToRecentDocs aplikacji (lub pośrednio jej używa, ponieważ powłoka będzie wywoływać ją w imieniu aplikacji w niektórych scenariuszach).

CJumpList::AddTask

Dodaje elementy do kategorii zadania kanoniczne.

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

BOOL AddTask(IShellLink* pShellLink);

Parametry

strTargetExecutablePath
Określa docelową ścieżkę zadania.

strCommandLineArgs
Określa argumenty wiersza polecenia pliku wykonywalnego określonego przez strTargetExecutablePath.

strTitle
Nazwa zadania, która będzie wyświetlana na liście docelowej.

strIconLocation
Lokalizacja ikony, która będzie wyświetlana na liście docelowej wraz z tytułem.

iIconIndex
Indeks ikony.

pShellLink
Łącze powłoki reprezentujące zadanie do dodania.

Wartość zwracana

Uwagi

Wystąpienie określonego CJumpList zadania gromadzi określone zadania i dodaje je do listy docelowej podczas .CommitList Elementy zadań będą wyświetlane w kategorii w dolnej części menu docelowego aplikacji. Ta kategoria ma pierwszeństwo przed wszystkimi innymi kategoriami po wypełnieniu interfejsu użytkownika.

CJumpList::AddTasks

Dodaje elementy do kategorii zadania kanoniczne.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parametry

pObjectCollection
Kolekcja zadań do dodania.

Wartość zwracana

Uwagi

Wystąpienie listy CJumpList gromadzi określone zadania i dodaje je do listy docelowej podczas .CommitList Elementy zadań będą wyświetlane w kategorii w dolnej części menu docelowego aplikacji. Ta kategoria ma pierwszeństwo przed wszystkimi innymi kategoriami po wypełnieniu interfejsu użytkownika.

CJumpList::AddTaskSeparator

Dodaje separator między zadaniami.

BOOL AddTaskSeparator();

Wartość zwracana

Bezzeru, jeśli to się powiedzie, 0, jeśli nie.

CJumpList::CJumpList

CJumpList Tworzy obiekt.

CJumpList(BOOL bAutoCommit = TRUE);

Parametry

bAutoCommit
Jeśli ten parametr ma wartość FALSE, lista nie jest automatycznie zatwierdzana w destruktorze.

CJumpList::ClearAll

Usuwa wszystkie zadania i miejsca docelowe, które zostały dodane do bieżącego CJumpList wystąpienia do tej pory.

void ClearAll();

Uwagi

Ta metoda czyści i zwalnia wszystkie dane i interfejsy wewnętrzne.

CJumpList::ClearAllDestinations

Usuwa wszystkie miejsca docelowe, które zostały dodane do bieżącego wystąpienia CJumpList do tej pory.

void ClearAllDestinations();

Uwagi

Wywołaj tę funkcję, jeśli chcesz usunąć wszystkie miejsca docelowe, które zostały dodane do tej pory w bieżącej sesji kompilacji listy docelowej i ponownie dodać inne miejsca docelowe. Jeśli element wewnętrzny ICustomDestinationList został zainicjowany, pozostanie aktywny.

CJumpList::CommitList

Kończy transakcję tworzenia listy i zatwierdza zgłoszoną listę do skojarzonego magazynu (w tym przypadku rejestru).

BOOL CommitList();

Wartość zwracana

Uwagi

Zatwierdzenie jest niepodzielne. Jeśli zatwierdzenie zakończy się niepowodzeniem, zostanie zwrócony błąd. Po CommitList wywołaniu bieżąca lista usuniętych elementów zostanie wyczyszczona. Wywołanie tej metody powoduje zresetowanie obiektu tak, aby nie miał aktywnej transakcji tworzenia listy. Aby zaktualizować listę, BeginList należy wywołać ponownie.

CJumpList::GetDestinationList

Pobiera wskaźnik interfejsu do listy docelowej.

ICustomDestinationList* GetDestinationList();

Wartość zwracana

Uwagi

Jeśli lista skoków nie została zainicjowana lub została zatwierdzona lub przerwana, zwracana wartość będzie mieć wartość NULL.

CJumpList::GetMaxSlots

Pobiera maksymalną liczbę elementów, w tym nagłówki kategorii, które mogą być wyświetlane w menu docelowym aplikacji wywołującej.

UINT GetMaxSlots() const;

Wartość zwracana

Uwagi

Aplikacje mogą zgłaszać tylko liczbę elementów i nagłówków kategorii połączonych z tą wartością. Jeśli wywołania metody AppendCategory, AppendKnownCategorylub AddUserTasks przekraczają tę liczbę, zostaną zwrócone błędy.

CJumpList::GetRemovedItems

Zwraca tablicę elementów reprezentujących usunięte miejsca docelowe.

IObjectArray* GetRemovedItems();

Wartość zwracana

Uwagi

Usunięte miejsca docelowe są pobierane podczas inicjowania listy skoków. Podczas generowania nowej listy docelowej aplikacje powinny najpierw przetworzyć usuniętą listę miejsc docelowych, czyszcząc dane śledzenia dla dowolnego elementu zwróconego przez usunięty moduł wyliczający listy. Jeśli aplikacja próbuje podać element, który został właśnie usunięty w transakcji, do którego uruchomiono bieżące wywołanie BeginList , wywołanie metody, które ponownie dodało ten element, zakończy się niepowodzeniem, aby upewnić się, że aplikacje przestrzegają usuniętej listy.

CJumpList::InitializeList

Rozpoczyna transakcję tworzenia listy.

BOOL InitializeList();

Wartość zwracana

Uwagi

Nie musisz jawnie wywoływać tej metody, chyba że chcesz pobrać wskaźnik do ICustomDestinationList użycia , liczbę dostępnych miejsc przy użyciu GetDestinationListmetody lub listę usuniętych elementów przy użyciu GetMaxSlotspolecenia GetRemovedItems.

CJumpList::SetAppID

Ustawia identyfikator modelu użytkownika aplikacji dla listy, która zostanie skompilowana.

void SetAppID(LPCTSTR strAppID);

Parametry

strAppID
Ciąg określający identyfikator modelu użytkownika aplikacji.

Zobacz też

Klasy