Класс КжумплистCJumpList Class

А CJumpList — это список ярлыков, отображаемых при щелчке значка правой кнопкой мыши на панели задач.A CJumpList is the list of shortcuts revealed when you right-click on an icon in the task bar.

СинтаксисSyntax

class CJumpList;

ЧленыMembers

Открытые конструкторыPublic Constructors

nameName ОписаниеDescription
Кжумплист:: КжумплистCJumpList::CJumpList Формирует объект CJumpList.Constructs a CJumpList object.
Кжумплист:: ~ КжумплистCJumpList::~CJumpList Уничтожает объект CJumpList .Destroys a CJumpList object.
ИмяName ОписаниеDescription
Кжумплист:: АбортлистCJumpList::AbortList Прерывает транзакцию создания списка без фиксации.Aborts a list-building transaction without committing.
Кжумплист:: АдддестинатионCJumpList::AddDestination Перегружен.Overloaded. Добавляет назначение в список.Adds destination to the list.
Кжумплист:: АддкновнкатегориCJumpList::AddKnownCategory Добавляет к списку известную категорию.Appends a Known Category to the list.
Кжумплист:: AddTaskCJumpList::AddTask Перегружен.Overloaded. Добавляет элементы в категорию канонических задач.Adds items to the canonical Tasks category.
Кжумплист:: АддтасксCJumpList::AddTasks Добавляет элементы в категорию канонических задач.Adds items to the canonical Tasks category.
Кжумплист:: АддтасксепараторCJumpList::AddTaskSeparator Добавляет разделитель между задачами.Adds a separator between tasks.
Кжумплист:: ClearAllCJumpList::ClearAll Удаляет все задачи и назначения, добавленные в текущий экземпляр до CJumpList сих пор.Removes all tasks and destinations that have been added to the current instance of CJumpList so far.
Кжумплист:: КлеараллдестинатионсCJumpList::ClearAllDestinations Удаляет все назначения, которые были добавлены к текущему экземпляру CJumpList до сих пор.Removes all destinations that have been added to the current instance of CJumpList so far.
Кжумплист:: КоммитлистCJumpList::CommitList Завершает транзакцию сборки списка и фиксирует полученный список в связанном хранилище (в данном случае в реестре).Ends a list-building transaction and commits the reported list to the associated store (the registry in this case.)
Кжумплист:: ЖетдестинатионлистCJumpList::GetDestinationList Извлекает указатель интерфейса на список назначения.Retrieves an interface pointer to destination list.
Кжумплист:: ЖетмаксслотсCJumpList::GetMaxSlots Возвращает максимальное количество элементов, включая заголовки категорий, которые могут отображаться в меню назначения вызывающего приложения.Retrieves the maximum number of items, including category headers that can display in the calling application's destination menu.
Кжумплист:: ЖетремоведитемсCJumpList::GetRemovedItems Возвращает массив элементов, представляющих удаленные назначения.Returns array of items that represent removed destinations.
Кжумплист:: ИнитиализелистCJumpList::InitializeList Начинает транзакцию сборки списка.Begins a list-building transaction.
Кжумплист:: СетаппидCJumpList::SetAppID Задает идентификатор модели пользователя приложения для списка, который будет построен.Sets the Application User Model ID for the list that will be built.

Иерархия наследованияInheritance Hierarchy

CJumpListCJumpList

ТребованияRequirements

Заголовок: афксадв. hHeader: afxadv.h

Кжумплист:: ~ КжумплистCJumpList::~CJumpList

Уничтожает объект CJumpList .Destroys a CJumpList object.

~CJumpList();

Кжумплист:: АбортлистCJumpList::AbortList

Прерывает транзакцию создания списка без фиксации.Aborts a list-building transaction without committing.

void AbortList();

КомментарииRemarks

Вызов этого метода оказывает тот же результат, что и удаление CJumpList без вызова CommitList .Calling this method has the same effect as destroying CJumpList without calling CommitList.

Кжумплист:: АдддестинатионCJumpList::AddDestination

Добавляет назначение в список.Adds destination to the list.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

ПараметрыParameters

лпксзкатегоринамеlpcszCategoryName
Указывает имя категории.Specifies a category name. Если указанная категория не существует, она будет создана.If the specified category does not exist, it will be created.

стрдестинатионпасstrDestinationPath
Указывает путь к целевому файлу.Specifies a path to destination file.

стркатегоринамеstrCategoryName
Указывает имя категории.Specifies a category name. Если указанная категория не существует, она будет создана.If the specified category does not exist, it will be created.

пшеллитемpShellItem
Указывает элемент оболочки, представляющий добавляемый объект назначения.Specifies a Shell Item representing the destination being added.

пшелллинкpShellLink
Указывает ссылку на оболочку, представляющую добавляемый объект назначения.Specifies a Shell Link representing the destination being added.

Возвращаемое значениеReturn Value

КомментарииRemarks

Экземпляр CJumpList внутренне накапливает добавленные назначения и затем фиксирует их в CommitList .The instance of CJumpList internally accumulates added destinations and then commits them in CommitList.

Кжумплист:: АддкновнкатегориCJumpList::AddKnownCategory

Добавляет к списку известную категорию.Appends a Known Category to the list.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

ПараметрыParameters

categorycategory
Указывает известный тип категории.Specifies a known category type. Может быть либо KDC_RECENT, либо KDC_KNOWN.Can be either KDC_RECENT, or KDC_KNOWN.

Возвращаемое значениеReturn Value

КомментарииRemarks

Известные категории — это часто и последние категории, которые будут автоматически вычисляться для каждого приложения, использующего SHAddToRecentDocs (или неявно использующего его, так как оболочка вызовет его от имени приложения в некоторых сценариях).Known Categories are the Frequent and Recent categories that we will automatically calculate for every application that utilizes SHAddToRecentDocs (or indirectly uses it as the shell will call it on the application's behalf in some scenarios).

Кжумплист:: AddTaskCJumpList::AddTask

Добавляет элементы в категорию канонических задач.Adds items to the canonical Tasks category.

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

BOOL AddTask(IShellLink* pShellLink);

ПараметрыParameters

стртаржетексекутаблепасstrTargetExecutablePath
Указывает путь к целевой задаче.Specifies the target task path.

стркоммандлинеаргсstrCommandLineArgs
Задает аргументы командной строки исполняемого файла, заданного параметром стртаржетексекутаблепас.Specifies command-line arguments of the executable specified by strTargetExecutablePath.

стртитлеstrTitle
Имя задачи, которое будет отображаться в списке назначения.Task name that will be displayed in the Destination List.

стриконлокатионstrIconLocation
Расположение значка, который будет отображаться в списке назначения вместе с заголовком.Location of icon that will be displayed in the Destination List along with the title.

иикониндексiIconIndex
Индекс значка.Icon index.

пшелллинкpShellLink
Ссылка на оболочку, представляющая добавляемую задачу.Shell Link that represents a task to be added.

Возвращаемое значениеReturn Value

КомментарииRemarks

Экземпляр CJumpList накапливает указанные задачи и добавляет их в список назначения во время CommitList .The instance of CJumpList accumulates specified tasks and adds them to the Destination List during CommitList. Элементы задач будут отображаться в категории в нижней части меню назначения приложения.Task items will appear in a category at the bottom of the application's destination menu. Эта категория имеет приоритет над всеми другими категориями, если она заполнена в пользовательском интерфейсе.This category takes precedence over all other categories when it is filled in the UI.

Кжумплист:: АддтасксCJumpList::AddTasks

Добавляет элементы в категорию канонических задач.Adds items to the canonical Tasks category.

BOOL AddTasks(IObjectArray* pObjectCollection);

ПараметрыParameters

побжектколлектионpObjectCollection
Коллекция добавляемых задач.A collection of tasks to be added.

Возвращаемое значениеReturn Value

КомментарииRemarks

Экземпляр Кжумплист накапливает указанные задачи и добавляет их в список назначения во время CommitList .The instance of CJumpList accumulates specified tasks and adds them to the Destination List during CommitList. Элементы задач будут отображаться в категории в нижней части меню назначения приложения.Task items will appear in a category at the bottom of the application's destination menu. Эта категория имеет приоритет над всеми другими категориями, если она заполнена в пользовательском интерфейсе.This category takes precedence over all other categories when it is filled in the UI.

Кжумплист:: АддтасксепараторCJumpList::AddTaskSeparator

Добавляет разделитель между задачами.Adds a separator between tasks.

BOOL AddTaskSeparator();

Возвращаемое значениеReturn Value

Ненулевое значение, если оно выполнено успешно, 0 — если нет.Nonzero if it is successful, 0 if it is not.

Кжумплист:: КжумплистCJumpList::CJumpList

Формирует объект CJumpList.Constructs a CJumpList object.

CJumpList(BOOL bAutoCommit = TRUE);

ПараметрыParameters

баутокоммитbAutoCommit
Если этот параметр имеет значение FALSE, список не фиксируется автоматически в деструкторе.If this parameter is FALSE the list is not automatically committed in destructor.

Кжумплист:: ClearAllCJumpList::ClearAll

Удаляет все задачи и назначения, добавленные в текущий экземпляр до CJumpList сих пор.Removes all tasks and destinations that have been added to the current instance of CJumpList so far.

void ClearAll();

КомментарииRemarks

Этот метод очищает и освобождает все данные и внутренние интерфейсы.This method clears and releases all data and internal interfaces.

Кжумплист:: КлеараллдестинатионсCJumpList::ClearAllDestinations

Удаляет все назначения, добавленные в текущий экземпляр Кжумплист на данный момент.Removes all destinations that have been added to the current instance of CJumpList so far.

void ClearAllDestinations();

КомментарииRemarks

Вызывайте эту функцию, если необходимо удалить все назначения, добавленные до сих пор в текущем сеансе создания списка назначения, и снова добавить другие назначения.Call this function if you need to remove all destinations that have been added so far in the current session of destination list building and add other destinations again. Если внутренняя ICustomDestinationList Инициализация выполнена, она остается в активном состоянии.If the internal ICustomDestinationList has been initialized, it's left alive.

Кжумплист:: КоммитлистCJumpList::CommitList

Завершает транзакцию сборки списка и фиксирует полученный список в связанном хранилище (в данном случае в реестре).Ends a list-building transaction and commits the reported list to the associated store (the registry in this case).

BOOL CommitList();

Возвращаемое значениеReturn Value

КомментарииRemarks

Фиксация является атомарной.The commit is atomic. При сбое фиксации будет возвращена ошибка.An error will be returned if the commit fails. Когда CommitList вызывается, текущий список удаленных элементов будет очищен.When CommitList is called, the current list of removed items will be cleaned up. Вызов этого метода приводит к сбросу объекта, чтобы он не имел транзакции с активным списком.Calling this method resets the object so that it does not have an active list-building transaction. Чтобы обновить список, необходимо BeginList повторно вызвать метод.To update the list, BeginList needs to be called again.

Кжумплист:: ЖетдестинатионлистCJumpList::GetDestinationList

Извлекает указатель интерфейса на список назначения.Retrieves an interface pointer to destination list.

ICustomDestinationList* GetDestinationList();

Возвращаемое значениеReturn Value

КомментарииRemarks

Если список переходов не был инициализирован или был зафиксирован или прерван, возвращаемое значение будет равно NULL.If the jump list has not been initialized, or has been committed or aborted, the returned value will be NULL.

Кжумплист:: ЖетмаксслотсCJumpList::GetMaxSlots

Возвращает максимальное количество элементов, включая заголовки категорий, которые могут отображаться в меню назначения вызывающего приложения.Retrieves the maximum number of items, including category headers that can display in the calling application's destination menu.

UINT GetMaxSlots() const;

Возвращаемое значениеReturn Value

КомментарииRemarks

Приложения могут сообщать только о количестве элементов и заголовках категорий, Объединенных с этим значением.Applications may only report a number of items and category headers combined up to this value. Если вызывает метод AppendCategory , AppendKnownCategory или AddUserTasks превышает это число, он возвратит ошибку.If calls to AppendCategory, AppendKnownCategory, or AddUserTasks exceed this number, they will return failure.

Кжумплист:: ЖетремоведитемсCJumpList::GetRemovedItems

Возвращает массив элементов, представляющих удаленные назначения.Returns array of items that represent removed destinations.

IObjectArray* GetRemovedItems();

Возвращаемое значениеReturn Value

КомментарииRemarks

Удаленные назначения извлекаются во время инициализации списка переходов.The removed destinations are retrieved during initialization of jump list. При создании нового списка назначения предполагается, что приложения сначала обрабатывали список удаленных назначений, удаляя данные отслеживания для любого элемента, возвращенного перечислителем списка удаленных списков.When generating a new destination list, applications are expected to first process the removed destinations list, clearing their tracking data for any item returned by the removed list enumerator. Если приложение пытается предоставить элемент, который был только что удален в транзакции, которая была запущена текущим вызовом BeginList , вызов метода, повторно добавленный в этот элемент, завершится ошибкой, чтобы обеспечить соответствие приложений удаленному списку.If an application attempts to provide an item that was just removed in the transaction that the current call to BeginList started, the method call that re-added that item will fail, to ensure that applications are respecting the removed list.

Кжумплист:: ИнитиализелистCJumpList::InitializeList

Начинает транзакцию сборки списка.Begins a list-building transaction.

BOOL InitializeList();

Возвращаемое значениеReturn Value

КомментарииRemarks

Вам не нужно вызывать этот метод явно, если вы не хотите получить указатель на ICustomDestinationList использование GetDestinationList , число доступных слотов, использующих GetMaxSlots , или список удаленных элементов с помощью GetRemovedItems .You don't need to call this method explicitly unless you wish to retrieve a pointer to ICustomDestinationList using GetDestinationList, the number of available slots using GetMaxSlots, or list of removed items using GetRemovedItems.

Кжумплист:: СетаппидCJumpList::SetAppID

Задает идентификатор модели пользователя приложения для списка, который будет построен.Sets the Application User Model ID for the list that will be built.

void SetAppID(LPCTSTR strAppID);

ПараметрыParameters

страппидstrAppID
Строка, указывающая идентификатор модели пользователя приложения.A string that specifies the Application User Model ID.

См. также разделSee also

КлассыClasses