Clase CJumpList

CJumpList es la lista de métodos abreviados que aparece al hacer clic con el botón secundario en un icono de la barra de tareas.

Sintaxis

class CJumpList;

Miembros

Constructores públicos

Nombre	Descripción
CJumpList::CJumpList	Construye un objeto CJumpList.
CJumpList::~CJumpList	Destruye un objeto CJumpList .

Nombre	Descripción
CJumpList::AbortList	Anula una transacción de creación de listas sin confirmar.
CJumpList::AddDestination	Con sobrecarga. Agrega el destino a la lista.
CJumpList::AddKnownCategory	Anexa una categoría conocida a la lista.
CJumpList::AddTask	Con sobrecarga. Agrega elementos a la categoría de tareas canónicas.
CJumpList::AddTasks	Agrega elementos a la categoría de tareas canónicas.
CJumpList::AddTaskSeparator	Agrega un separador entre tareas.
CJumpList::ClearAll	Elimina todas las tareas y destinos que se han agregado a la instancia actual de CJumpList hasta el momento.
CJumpList::ClearAllDestinations	Elimina todos los destinos que se han agregado a la instancia actual de CJumpList hasta el momento.
CJumpList::CommitList	Finaliza una transacción de creación de listas y confirma la lista notificada en el almacén asociado (en este caso, el registro).
CJumpList::GetDestinationList	Recupera un puntero de interfaz a la lista de destino.
CJumpList::GetMaxSlots	Recupera el número máximo de elementos, incluidos los encabezados de categoría que se pueden mostrar en el menú de destino de la aplicación que llama.
CJumpList::GetRemovedItems	Devuelve una matriz de elementos que representan destinos eliminados.
CJumpList::InitializeList	Inicia una transacción de creación de listas.
CJumpList::SetAppID	Establece el identificador del modelo de usuario de la aplicación para la lista que se va a crear.

Jerarquía de herencia

CJumpList

Requisitos

Encabezado: afxadv.h

CJumpList::~CJumpList

Destruye un objeto CJumpList .

~CJumpList();

CJumpList::AbortList

Anula una transacción de creación de listas sin confirmar.

void AbortList();

Comentarios

Llamar a este método tiene el mismo efecto que destruir CJumpList sin llamar a CommitList.

CJumpList::AddDestination

Agrega el destino a la lista.

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

Parámetros

lpcszCategoryName
Especifica un nombre de categoría. Si la categoría especificada no existe, se creará.

strDestinationPath
Especifica una ruta de acceso al archivo de destino.

strCategoryName
Especifica un nombre de categoría. Si la categoría especificada no existe, se creará.

pShellItem
Especifica un elemento de shell que representa el destino que se va a agregar.

pShellLink
Especifica un vínculo de shell que representa el destino que se va a agregar.

Valor devuelto

Comentarios

La instancia de CJumpList acumula internamente destinos agregados y, a continuación, los confirma en CommitList.

CJumpList::AddKnownCategory

Anexa una categoría conocida a la lista.

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

Parámetros

category
Especifica un tipo de categoría conocido. Puede ser KDC_RECENT o KDC_KNOWN.

Valor devuelto

Comentarios

Las categorías conocidas son las categorías Frecuente y Reciente que calcularemos automáticamente para cada aplicación que use SHAddToRecentDocs (o que lo use indirectamente, ya que el shell lo llamará en nombre de la aplicación en algunos escenarios).

CJumpList::AddTask

Agrega elementos a la categoría de tareas canónicas.

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

BOOL AddTask(IShellLink* pShellLink);

Parámetros

strTargetExecutablePath
Especifica la ruta de acceso de la tarea de destino.

strCommandLineArgs
Especifica los argumentos de la línea de comandos del archivo ejecutable especificado por strTargetExecutablePath.

strTitle
Nombre de tarea que se mostrará en la lista de destino.

strIconLocation
Ubicación del icono que se mostrará en la lista de destino junto con el título.

iIconIndex
Índice de icono.

pShellLink
Vínculo de shell que representa una tarea que se va a agregar.

Valor devuelto

Comentarios

La instancia de CJumpList acumula tareas especificadas y las agrega a la lista de destino durante CommitList. Los elementos de la tarea aparecerán en una categoría en la parte inferior del menú de destino de la aplicación. Esta categoría tiene prioridad sobre todas las demás categorías cuando se rellena en la interfaz de usuario.

CJumpList::AddTasks

Agrega elementos a la categoría de tareas canónicas.

BOOL AddTasks(IObjectArray* pObjectCollection);

Parámetros

pObjectCollection
Colección de tareas que se van a agregar.

Valor devuelto

Comentarios

La instancia de CJumpList acumula tareas especificadas y las agrega a la lista de destino durante CommitList. Los elementos de la tarea aparecerán en una categoría en la parte inferior del menú de destino de la aplicación. Esta categoría tiene prioridad sobre todas las demás categorías cuando se rellena en la interfaz de usuario.

CJumpList::AddTaskSeparator

Agrega un separador entre tareas.

BOOL AddTaskSeparator();

Valor devuelto

Distinto de cero si es correcto, 0 si no lo es.

CJumpList::CJumpList

Construye un objeto CJumpList.

CJumpList(BOOL bAutoCommit = TRUE);

Parámetros

bAutoCommit
Si este parámetro es FALSE, la lista no se confirma automáticamente en el destructor.

CJumpList::ClearAll

Elimina todas las tareas y destinos que se han agregado a la instancia actual de CJumpList hasta el momento.

void ClearAll();

Comentarios

Este método borra y libera todos los datos e interfaces internas.

CJumpList::ClearAllDestinations

Elimina todos los destinos que se han agregado a la instancia actual de CJumpList hasta el momento.

void ClearAllDestinations();

Comentarios

Llame a esta función si necesita eliminar todos los destinos que se han agregado hasta el momento en la sesión actual de creación de listas de destino y volver a agregar otros destinos. Si se ha inicializado el elemento interno ICustomDestinationList, se deja activo.

CJumpList::CommitList

Finaliza una transacción de creación de listas y confirma la lista notificada en el almacén asociado (en este caso, el registro).

BOOL CommitList();

Valor devuelto

Comentarios

La confirmación es atómica. Se devolverá un error en caso de producirse en la confirmación. Cuando se llama a CommitList, se limpiará la lista actual de elementos eliminados. Al llamar a este método, se restablece el objeto para que no tenga una transacción activa de creación de listas. Para actualizar la lista, se debe llamar a BeginList de nuevo.

CJumpList::GetDestinationList

Recupera un puntero de interfaz a la lista de destino.

ICustomDestinationList* GetDestinationList();

Valor devuelto

Comentarios

Si la lista de accesos directos no se ha inicializado o se ha confirmado o anulado, el valor devuelto será NULL.

CJumpList::GetMaxSlots

Recupera el número máximo de elementos, incluidos los encabezados de categoría que se pueden mostrar en el menú de destino de la aplicación que llama.

UINT GetMaxSlots() const;

Valor devuelto

Comentarios

Las aplicaciones solo pueden notificar un número máximo de elementos y encabezados de categoría combinados. Si las llamadas a AppendCategory, AppendKnownCategory o AddUserTasks superan este número, devolverán un error.

CJumpList::GetRemovedItems

Devuelve una matriz de elementos que representan destinos eliminados.

IObjectArray* GetRemovedItems();

Valor devuelto

Comentarios

Los destinos eliminados se recuperan durante la inicialización de la lista de accesos directos. Al generar una nueva lista de destino, se espera que las aplicaciones procesen primero la lista de destinos eliminados, borrando sus datos de seguimiento de cualquier elemento devuelto por el enumerador de las listas eliminadas. Si una aplicación intenta proporcionar un elemento que se acaba de eliminar de la transacción que se inició con la llamada actual a BeginList, se producirá un error en la llamada de método que volvió agregar ese elemento, para asegurarse de que las aplicaciones respetan la lista eliminada.

CJumpList::InitializeList

Inicia una transacción de creación de listas.

BOOL InitializeList();

Valor devuelto

Comentarios

No es necesario llamar explícitamente a este método a menos que desee recuperar un puntero a ICustomDestinationList mediante GetDestinationList, el número de ranuras disponibles mediante GetMaxSlots o la lista de elementos eliminados mediante GetRemovedItems.

CJumpList::SetAppID

Establece el identificador del modelo de usuario de la aplicación para la lista que se va a crear.

void SetAppID(LPCTSTR strAppID);

Parámetros

strAppID
Cadena que especifica el identificador de modelo del usuario de la aplicación.

Consulte también

Clases