SecondaryTile Clase

Definición

Espacio de nombres:

Windows.UI.StartScreen

Crea, enumera y proporciona información sobre un icono secundario.

En una aplicación de escritorio, antes de usar una instancia de esta clase de forma que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de los iconos secundarios CoreWindow y Anclar iconos secundarios desde aplicaciones de escritorio.

public ref class SecondaryTile sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.StartScreen.ISecondaryTileFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.StartScreen.ISecondaryTileFactory2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SecondaryTile final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.StartScreen.ISecondaryTileFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.StartScreen.ISecondaryTileFactory2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SecondaryTile

function SecondaryTile(tileId, shortName, displayName, arguments, tileOptions, logoReference, wideLogoReference)

Public NotInheritable Class SecondaryTile

Herencia

Object Platform::Object IInspectable SecondaryTile

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)

Ejemplos

En el ejemplo siguiente se crea y se ancla un icono secundario a la pantalla Inicio.

using Windows.UI.StartScreen;

// Prepare package images for all four tile sizes in our tile to be pinned as well as for the square30x30 logo used in the Apps view.  
Uri square150x150Logo = new Uri("ms-appx:///Assets/square150x150Tile-sdk.png");
Uri wide310x150Logo = new Uri("ms-appx:///Assets/wide310x150Tile-sdk.png");
Uri square310x310Logo = new Uri("ms-appx:///Assets/square310x310Tile-sdk.png"); 
Uri square30x30Logo = new Uri("ms-appx:///Assets/square30x30Tile-sdk.png");

// During creation of secondary tile, an application may set additional arguments on the tile that will be passed in during activation.
// These arguments should be meaningful to the application. In this sample, we'll pass in the date and time the secondary tile was pinned.
string tileActivationArguments = MainPage.logoSecondaryTileId + " WasPinnedAt=" + DateTime.Now.ToLocalTime().ToString();

// Create a Secondary tile with all the required arguments.
// Note the last argument specifies what size the Secondary tile should show up as by default in the Pin to start fly out.
// It can be set to TileSize.Square150x150, TileSize.Wide310x150, or TileSize.Default.  
// If set to TileSize.Wide310x150, then the asset for the wide size must be supplied as well.
// TileSize.Default will default to the wide size if a wide size is provided, and to the medium size otherwise. 
SecondaryTile secondaryTile = new SecondaryTile(MainPage.logoSecondaryTileId,
                                                "Title text shown on the tile",
                                                tileActivationArguments,
                                                square150x150Logo,
                                                TileSize.Square150x150);

// Pin the tile
bool isPinned = await tile.RequestCreateAsync();
if (isPinned) {
    // Secondary tile successfully pinned.
} 
else {
    // Secondary tile not pinned.
}

En el ejemplo siguiente se muestra cómo eliminar (desanclar) un icono secundario mediante el método RequestDeleteAsync . Tenga en cuenta que en este ejemplo se supone que el icono existe. Para determinar si el icono está anclado antes de llamar a RequestDeleteAsync, consulte el método Exists .

// Check if the secondary tile is pinned
if (SecondaryTile.Exists(tileId)) {
    // Initialize a secondary tile with the same tile ID you want removed
    SecondaryTile toBeDeleted = new SecondaryTile(tileId);

    // And then unpin the tile
    bool isDeleted = await toBeDeleted.RequestDeleteAsync();
    if (isDeleted) {
        // Secondary tile successfully deleted.
    } else {
        // Secondary tile not deleted.
    }
}

En el ejemplo siguiente se muestra cómo usar el método FindAllForPackageAsync para recuperar una lista de identificadores para todos los iconos secundarios creados para la aplicación que realiza la llamada y cualquier otra aplicación del mismo paquete.

// Get all secondary tiles
var tiles = await SecondaryTile.FindAllForPackageAsync();

En el ejemplo siguiente se muestra cómo usar el método TileUpdateManager.createTileUpdaterForSecondaryTile para enviar una notificación a un icono secundario con un identificador de "SecondaryTile.Dynamic". Tenga en cuenta que en el ejemplo se proporciona una versión ancha y cuadrada de la notificación porque el usuario tiene control sobre qué forma del icono se muestra.

using NotificationsExtensions.TileContent;

// Define the notification context.
// Note: This sample contains an additional reference, NotificationsExtensions, which you can use in your apps
ITileWide310x150Text04 tileContent = TileContentFactory.CreateTileWide310x150Text04();
tileContent.TextBodyWrap.Text = "Sent to a secondary tile from NotificationsExtensions!";

// Provide a square version of the notification.
ITileSquare150x150Text04 squareContent = TileContentFactory.CreateTileSquare150x150Text04();
squareContent.TextBodyWrap.Text = "Sent to a secondary tile from NotificationExtensions!";
tileContent.Square150x150Content = squareContent;

// Send the notification to the secondary tile by creating a secondary tile updater
TileUpdateManager.CreateTileUpdaterForSecondaryTile(MainPage.dynamicTileId).Update(tileContent.CreateNotification());

En el ejemplo siguiente se muestra cómo usar el método BadgeUpdateManager.createBadgeUpdaterForSecondaryTile para enviar una notificación de distintivo numérico a un icono secundario con un identificador de "SecondaryTile.Dynamic".

using NotificationsExtensions.BadgeContent;

// Define the badge content
BadgeNumericNotificationContent badgeContent = new BadgeNumericNotificationContent(6);

// Send the notification to the secondary tile
BadgeUpdateManager.CreateBadgeUpdaterForSecondaryTile(MainPage.dynamicTileId).Update(badgeContent.CreateNotification());

Constructores

SecondaryTile()	Crea un objeto SecondaryTile . A continuación, el autor de la llamada debe establecer las propiedades obligatorias a través del objeto antes de intentar anclar, actualizar o eliminar el icono. En una aplicación de escritorio, antes de usar una instancia de esta clase de una manera que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de CoreWindow.
SecondaryTile(String)	Crea un objeto SecondaryTile con un identificador específico. Este formato del constructor debe usarse para crear un objeto de icono secundario para realizar una actualización o eliminación de iconos. En una aplicación de escritorio, antes de usar una instancia de esta clase de una manera que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri)	Nota Este constructor puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize). Crea un objeto SecondaryTile como un icono medio. En una aplicación de escritorio, antes de usar una instancia de esta clase de una manera que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri, Uri)	Nota Este constructor puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) y proporcione otros tamaños y opciones de icono a través del método SecondaryTile.VisualElements . Crea un objeto SecondaryTile como un icono ancho. En una aplicación de escritorio, antes de usar una instancia de esta clase de una manera que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de CoreWindow. En Windows Phone 8.1, todos los iconos (incluidos los iconos secundarios) se anclan como iconos medianos, después de los cuales el usuario puede cambiar su tamaño. Este constructor proporciona la opción de cambiar el tamaño a un icono ancho.
SecondaryTile(String, String, String, Uri, TileSize)	Crea un objeto SecondaryTile que incluye todas las propiedades obligatorias necesarias para crear un icono medio. En una aplicación de escritorio, antes de usar una instancia de esta clase de una manera que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de CoreWindow.

Propiedades

Arguments	Obtiene o establece un conjunto de información definido por la aplicación que se pasa desde el icono secundario a la aplicación durante la activación. Esta propiedad es necesaria al crear un icono.
BackgroundColor	Nota BackgroundColor puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTileVisualElements.BackgroundColor. Obtiene o establece el color de fondo del icono.
DisplayName	Obtiene o establece un nombre asociado a y que se muestra en el icono. Este nombre se muestra en el icono de Inicio, en la información sobre herramientas del icono, junto a la representación de icono pequeña en la lista Aplicaciones y en algunas aplicaciones Panel de control. Esta propiedad es necesaria al crear un icono. Es el equivalente del nombre para mostrar declarado en el manifiesto para el icono principal de la aplicación. En Windows Phone 8.1, el nombre para mostrar solo se muestra en el icono secundario ancho.
ForegroundText	Nota ForegroundText puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTileVisualElements.ForegroundText. Obtiene o establece si el icono debe usar texto oscuro o claro.
LockScreenBadgeLogo	Obtiene o establece la ubicación de una imagen de logotipo de distintivo para representar el icono secundario en la pantalla de bloqueo. Al proporcionar esta imagen, declara que el icono secundario es apto para mostrar un distintivo en la pantalla de bloqueo. Si también desea que el icono secundario sea apto para la ranura de mosaico detallada de la pantalla de bloqueo, también debe establecer la propiedad LockScreenDisplayBadgeAndTileText en True. Nota Indicar que el icono secundario es apto para una presencia de pantalla de bloqueo no garantiza que tenga uno. Solo el usuario puede agregar una aplicación a una de las siete ranuras de pantalla de bloqueo. Para obtener más información, consulte información general sobre la pantalla de bloqueo.
LockScreenDisplayBadgeAndTileText	Obtiene o establece si el icono secundario es apto para mostrar un distintivo y un icono detallado en la pantalla de bloqueo. Si establece esta propiedad en True, también debe proporcionar una imagen de distintivo a través de la propiedad LockScreenBadgeLogo . Si no desea usar la funcionalidad detallada del icono, proporcione una imagen de distintivo a través de la propiedad LockScreenBadgeLogo y establezca LockScreenDisplayBadgeAndTileText en False. Nota Indicar que el icono secundario es apto para una presencia de pantalla de bloqueo no garantiza que tenga uno. Solo el usuario puede agregar una aplicación a una de las siete ranuras de pantalla de bloqueo, así como elegir cuál de ellas puede mostrar información detallada del icono. Para obtener más información, consulte información general sobre la pantalla de bloqueo.
Logo	Nota El logotipo puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTileVisualElements.Square150x150Logo. Obtiene o establece la imagen de logotipo usada en un icono medio. Esta propiedad es necesaria cuando se crea un cuadrado o un icono ancho.
PhoneticName	Obtiene o establece una versión fonética del nombre del icono secundario. Se usa con lenguajes basados en caracteres con fines de ordenación de la interfaz de usuario.
RoamingEnabled	Obtiene o establece un valor que determina si el icono secundario se volverá a adquirir a través de la nube cuando el usuario instale la aplicación primaria, con su cuenta Microsoft, en otro equipo. Tenga en cuenta que a partir de Windows 8.1, la itinerancia es el comportamiento predeterminado. Esto es lo contrario al comportamiento predeterminado de Windows 8, donde la itinerancia era opcional. Esta propiedad siempre devuelve false en Windows Phone 8.1.
ShortName	Nota ShortName puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTile.DisplayName. Obtiene o establece un nombre corto que se mostrará directamente en el icono. Nota A partir de Windows 8.1, esta propiedad se omite y el nombre para mostrar declarado en el manifiesto se usa en su lugar.
SmallLogo	Nota SmallLogo puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTileVisualElements.Square30x30Logo. Obtiene o establece la imagen de logotipo pequeña, usada en los resultados de búsqueda, la lista Todos los programas y otras ubicaciones de la interfaz de usuario. El logotipo pequeño no se usa con un icono secundario de Windows Phone 8.1.
TileId	Obtiene o establece una cadena única para identificar el icono dentro del paquete. Esta propiedad es necesaria al crear o eliminar un icono.
TileOptions	Nota TileOptions puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTile.VisualElements. Obtiene o establece las opciones disponibles para un icono secundario.
VisualElements	Obtiene un objeto a través del cual puede obtener o establecer el color de fondo de un icono secundario, el texto en primer plano, las imágenes de mosaico y las opciones para mostrar del nombre de la aplicación. A partir de Windows 8.1, las propiedades de este objeto reemplazan estas propiedades SecondaryTile: SecondaryTile.BackgroundColor SecondaryTile.ForegroundText SecondaryTile.Logo SecondaryTile.SmallLogo SecondaryTile.WideLogo SecondaryTile.TileOptions (excepto CopyOnDeployment)
WideLogo	Nota WideLogo puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use SecondaryTileVisualElements.Wide310x150Logo. Obtiene o establece la imagen de logotipo usada en un icono secundario ancho. Esta propiedad es necesaria cuando se crea un icono secundario ancho y se proporciona al usuario la opción de un icono ancho cuando cambia el tamaño del icono.

Métodos

Exists(String)	Comprueba si existe un icono secundario específico para la aplicación que realiza la llamada.
FindAllAsync()	Recupera una lista de iconos secundarios creados para la aplicación que llama.
FindAllAsync(String)	Recupera una lista de iconos secundarios creados para otra aplicación en el mismo paquete que la aplicación que llama.
FindAllForPackageAsync()	Recupera una lista de iconos secundarios creados para todas las aplicaciones del paquete de la aplicación que llama. Cuando se inicia una aplicación, siempre debe enumerar sus iconos secundarios a través de este método, en caso de que haya adiciones o eliminaciones de las que no era consciente. Cuando se elimina un icono secundario a través de la barra de la aplicación Pantalla de inicio, Windows simplemente quita el icono. La propia aplicación es responsable de liberar los recursos usados por el icono secundario. Cuando los iconos secundarios se copian a través de la nube, las notificaciones de icono o distintivo actuales en el icono secundario, las notificaciones programadas, los canales de notificación push y el identificador uniforme de recursos (URI) usados con las notificaciones periódicas no se copian con el icono secundario y deben restablecerse.
RequestCreateAsync()	Muestra el control flotante Anclar a inicio , a través del cual el usuario puede confirmar que desea crear el icono secundario, que a su vez crea el icono. Las sobrecargas de este método permiten especificar la ubicación en pantalla del control flotante. Nota Se recomienda mostrar el control flotante Anclar a inicio cerca del botón que invocó la solicitud para crear el icono. Por lo tanto, se recomienda usar el formulario RequestCreateAsync(Point) de esta sobrecarga de método. En Windows Phone 8.1, el icono secundario se crea a través de esta llamada sin mostrar al usuario un control flotante, pedirle confirmación o permitirle elegir un tamaño de icono o texto de título. Tenga en cuenta que al usar el método RequestCreateAsync para anclar un icono secundario en Windows Phone aplicación 8.x, la aplicación se suspende y el usuario se lleva a la pantalla Inicio. Esta misma llamada API en un equipo no suspende el programa. Por lo tanto, tenga en cuenta que no se garantiza que se ejecute ningún código llamado después de RequestCreateAsync antes de que se suspenda la aplicación. Para evitar este posible problema, debes usar el evento OnSuspended de la aplicación para ejecutar cualquier código, como actualizar el icono anclado, que debe ejecutarse antes de que se suspenda la aplicación. Para ver un ejemplo de este patrón, descargue y ejecute la actualización del icono en el ejemplo de suspensión.
RequestCreateAsync(Point)	Muestra el control flotante Anclar a inicio encima de una ubicación especificada, a través de la cual el usuario puede confirmar que desea crear el icono secundario, que a su vez crea el icono. En Windows Phone 8.1, el icono secundario se crea a través de esta llamada sin mostrar al usuario un control flotante, pedirle confirmación o permitirle elegir un tamaño de icono o texto de título. Tenga en cuenta que al usar el método RequestCreateAsync para anclar un icono secundario en Windows Phone aplicación 8.x, la aplicación se suspende y el usuario se lleva a la pantalla Inicio. Esta misma llamada API en un equipo no suspende el programa. Por lo tanto, tenga en cuenta que no se garantiza que se ejecute ningún código llamado después de RequestCreateAsync antes de que se suspenda la aplicación. Para evitar este posible problema, debes usar el evento OnSuspended de la aplicación para ejecutar cualquier código, como actualizar el icono anclado, que debe ejecutarse antes de que se suspenda la aplicación. Para ver un ejemplo de este patrón, descargue y ejecute la actualización del icono en el ejemplo de suspensión.
RequestCreateForSelectionAsync(Rect)	Muestra el control flotante Anclar a Inicio encima de un área especificada. El usuario usa este control flotante para confirmar que desea crear el icono secundario, que a su vez crea el icono. En Windows Phone 8.1, el icono secundario se crea a través de esta llamada sin mostrar al usuario un control flotante, solicitarles confirmación o permitirle elegir un tamaño de icono o texto de título. Tenga en cuenta que al usar el método RequestCreateAsync para anclar un icono secundario en Windows Phone aplicación 8.x, la aplicación se suspende y el usuario se lleva a la pantalla Inicio. Esta misma llamada API en un equipo no suspende el programa. Por lo tanto, tenga en cuenta que cualquier código al que se llama después de RequestCreateAsync no se garantiza que se ejecute antes de que se suspenda la aplicación. Para evitar este posible problema, debes usar el evento OnSuspended de la aplicación para ejecutar cualquier código, como actualizar el icono anclado, que debe ejecutarse antes de que se suspenda la aplicación. Para ver un ejemplo de este patrón, descargue y ejecute la actualización de icono en el ejemplo de suspensión.
RequestCreateForSelectionAsync(Rect, Placement)	Muestra el control flotante Anclar a Inicio en el lado especificado de un área especificada. El usuario usa este control flotante para confirmar que desea crear el icono secundario, que a su vez crea el icono. En Windows Phone 8.1, el icono secundario se crea a través de esta llamada sin mostrar al usuario un control flotante, solicitarles confirmación o permitirle elegir un tamaño de icono o texto de título. Tenga en cuenta que al usar el método RequestCreateAsync para anclar un icono secundario en Windows Phone aplicación 8.x, la aplicación se suspende y el usuario se lleva a la pantalla Inicio. Esta misma llamada API en un equipo no suspende el programa. Por lo tanto, tenga en cuenta que cualquier código al que se llama después de RequestCreateAsync no se garantiza que se ejecute antes de que se suspenda la aplicación. Para evitar este posible problema, debes usar el evento OnSuspended de la aplicación para ejecutar cualquier código, como actualizar el icono anclado, que debe ejecutarse antes de que se suspenda la aplicación. Para ver un ejemplo de este patrón, descargue y ejecute la actualización de icono en el ejemplo de suspensión.
RequestDeleteAsync()	Muestra el control flotante Desanclar desde Inicio . Este control flotante permite al usuario confirmar la eliminación del icono secundario.
RequestDeleteAsync(Point)	Muestra el control flotante Desanclar desde Inicio en un punto especificado. Este control flotante permite al usuario confirmar la eliminación del icono secundario.
RequestDeleteForSelectionAsync(Rect)	Muestra el control flotante Desanclar desde Inicio encima de un área especificada. Este control flotante permite al usuario confirmar la eliminación del icono secundario.
RequestDeleteForSelectionAsync(Rect, Placement)	Muestra el control flotante Desanclar desde Inicio en el lado especificado de un área especificada. Este control flotante permite al usuario confirmar la eliminación del icono secundario.
UpdateAsync()	Novedades un icono secundario después de que el icono esté anclado a la pantalla Inicio. En Windows Phone 8.1, la aplicación se suspende y el usuario se lleva a la pantalla Inicio cuando se ancla un icono secundario. Por lo tanto, tenga en cuenta que cualquier código al que se llama después de RequestCreateAsync no se garantiza que se ejecute antes de que se suspenda la aplicación. Para evitar este posible problema, debes usar el evento OnSuspended de la aplicación para ejecutar cualquier código, como actualizar el icono anclado, que debe ejecutarse antes de que se suspenda la aplicación. Para ver un ejemplo de este patrón, descargue y ejecute la actualización de icono en el ejemplo de suspensión.

Eventos

VisualElementsRequested

Se desencadena cuando se realiza una llamada a RequestCreateAsync. Este evento no se genera en Windows Phone 8.1.

Consulte también

• Guía de iconos secundarios
• Ejemplo de iconos secundarios (Windows 10)
• Ejemplo de modelo de Mixed Reality