SecondaryTile Classe

Définition

Espace de noms:

Windows.UI.StartScreen

Crée, énumère et fournit des informations sur une vignette secondaire.

Dans une application de bureau, avant d’utiliser un instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow et Épingler des vignettes secondaires à partir d’applications de bureau.

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

Héritage

Object Platform::Object IInspectable SecondaryTile

Attributs

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

L’exemple suivant crée et épingle une vignette secondaire à l’écran d’accueil.

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.
}

L’exemple suivant montre comment supprimer (désépiner) une vignette secondaire à l’aide de la méthode RequestDeleteAsync . Notez que cet exemple part du principe que la vignette existe. Pour déterminer si la vignette est épinglée avant d’appeler RequestDeleteAsync, consultez la méthode 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.
    }
}

L’exemple suivant montre comment utiliser la méthode FindAllForPackageAsync pour récupérer une liste d’ID pour toutes les vignettes secondaires créées pour l’application appelante et toute autre application dans le même package.

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

L’exemple suivant montre comment utiliser la méthode TileUpdateManager.createTileUpdaterForSecondaryTile pour envoyer une notification à une vignette secondaire avec l’ID « SecondaryTile.Dynamic ». Notez que l’exemple fournit une version large et carrée de la notification, car l’utilisateur contrôle la forme de la vignette qui s’affiche.

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());

L’exemple suivant montre comment utiliser la méthode BadgeUpdateManager.createBadgeUpdaterForSecondaryTile pour envoyer une notification de badge numérique à une vignette secondaire avec l’ID « 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());

Constructeurs

SecondaryTile()	Crée un objet SecondaryTile . L’appelant doit ensuite définir toutes les propriétés obligatoires via l’objet avant de tenter d’épingler, de mettre à jour ou de supprimer la vignette. Dans une application de bureau, avant d’utiliser une instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow.
SecondaryTile(String)	Crée un objet SecondaryTile avec un ID spécifique. Cette forme du constructeur doit être utilisée pour créer un objet de vignette secondaire afin d’effectuer une mise à jour ou une suppression de vignette. Dans une application de bureau, avant d’utiliser une instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri)	Notes Ce constructeur peut être modifié ou indisponible pour les mises en production après Windows 8.1. Utilisez plutôt SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) . Crée un objet SecondaryTile en tant que vignette moyenne. Dans une application de bureau, avant d’utiliser une instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri, Uri)	Notes Ce constructeur peut être modifié ou indisponible pour les mises en production après Windows 8.1. Utilisez plutôt SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) et fournissez d’autres tailles de vignette et options via la méthode SecondaryTile.VisualElements . Crée un objet SecondaryTile sous forme de vignette large. Dans une application de bureau, avant d’utiliser une instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow. Sur Windows Phone 8.1, toutes les vignettes, y compris les vignettes secondaires, sont épinglées en tant que vignettes moyennes, après quoi elles peuvent être redimensionnées par l’utilisateur. Ce constructeur fournit cette option de redimensionnement sur une vignette large.
SecondaryTile(String, String, String, Uri, TileSize)	Crée un objet SecondaryTile qui inclut toutes les propriétés obligatoires requises pour créer une vignette moyenne. Dans une application de bureau, avant d’utiliser une instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow.

Propriétés

Arguments	Obtient ou définit un ensemble d’informations défini par l’application qui est transmis de la vignette secondaire à l’application lors de l’activation. Cette propriété est requise lorsque vous créez une vignette.
BackgroundColor	Notes BackgroundColor peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt SecondaryTileVisualElements.BackgroundColor. Obtient ou définit la couleur d’arrière-plan de la vignette.
DisplayName	Obtient ou définit un nom associé à et affiché sur la vignette. Ce nom s’affiche sur la vignette dans l’écran de démarrage, dans l’info-bulle de la vignette, à côté de la petite représentation de vignette dans la liste Applications, et dans certaines applications Panneau de configuration. Cette propriété est requise lorsque vous créez une vignette. Il s’agit de l’équivalent du nom d’affichage déclaré dans le manifeste pour la vignette main de l’application. Sur Windows Phone 8.1, le nom d’affichage s’affiche uniquement sur la vignette secondaire large.
ForegroundText	Notes ForegroundText peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt SecondaryTileVisualElements.ForegroundText. Obtient ou définit si la vignette doit utiliser du texte sombre ou clair.
LockScreenBadgeLogo	Obtient ou définit l’emplacement d’une image de logo de badge pour représenter la vignette secondaire sur l’écran de verrouillage. En fournissant cette image, vous déclarez que la vignette secondaire est éligible pour afficher un badge sur l’écran de verrouillage. Si vous souhaitez également que la vignette secondaire soit éligible à l’emplacement de vignette détaillé de l’écran de verrouillage, vous devez également définir la propriété LockScreenDisplayBadgeAndTileText sur True. Notes Le fait d’indiquer que votre vignette secondaire est éligible à une présence d’écran de verrouillage ne garantit pas qu’elle en aura une. Seul l’utilisateur peut ajouter une application à l’un des sept emplacements d’écran de verrouillage. Pour plus d’informations, consultez vue d’ensemble de l’écran de verrouillage.
LockScreenDisplayBadgeAndTileText	Obtient ou définit si la vignette secondaire est éligible pour afficher à la fois un badge et une vignette détaillée sur l’écran de verrouillage. Si vous définissez cette propriété sur True, vous devez également fournir une image de badge via la propriété LockScreenBadgeLogo . Si vous ne souhaitez pas utiliser la fonctionnalité de vignette détaillée, fournissez une image de badge via la propriété LockScreenBadgeLogo et définissez LockScreenDisplayBadgeAndTileText sur False. Notes Le fait d’indiquer que votre vignette secondaire est éligible à une présence d’écran de verrouillage ne garantit pas qu’elle en aura une. Seul l’utilisateur peut ajouter une application à l’un des sept emplacements d’écran de verrouillage, et choisir l’un d’entre eux peut afficher des informations détaillées sur les vignettes. Pour plus d’informations, consultez vue d’ensemble de l’écran de verrouillage.
Logo	Notes Le logo peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt SecondaryTileVisualElements.Square150x150Logo. Obtient ou définit l’image de logo utilisée dans une vignette moyenne. Cette propriété est requise lorsque vous créez une vignette carrée ou large.
PhoneticName	Obtient ou définit une version phonétique du nom de la vignette secondaire. Utilisé avec les langages basés sur des caractères à des fins de tri de l’interface utilisateur.
RoamingEnabled	Obtient ou définit une valeur qui détermine si la vignette secondaire sera réacquistée via le cloud lorsque l’application parente est installée par l’utilisateur, à l’aide de son compte Microsoft, sur un autre ordinateur. Notez qu’à partir de Windows 8.1, l’itinérance est le comportement par défaut. Il s’agit de l’inverse du comportement par défaut de Windows 8, où l’itinérance a été activée. Cette propriété retourne toujours false sur Windows Phone 8.1.
ShortName	Notes ShortName peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt SecondaryTile.DisplayName. Obtient ou définit un nom court à afficher directement sur la vignette. Notes À partir de Windows 8.1, cette propriété est ignorée et le nom d’affichage déclaré dans le manifeste est utilisé à sa place.
SmallLogo	Notes SmallLogo peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt SecondaryTileVisualElements.Square30x30Logo. Obtient ou définit la petite image de logo utilisée dans les résultats de recherche, la liste Tous les programmes et d’autres emplacements de l’interface utilisateur. Le petit logo n’est pas utilisé avec une vignette secondaire Windows Phone 8.1.
TileId	Obtient ou définit une chaîne unique pour identifier la vignette dans le package. Cette propriété est requise lorsque vous créez ou supprimez une vignette.
TileOptions	Notes TileOptions peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt SecondaryTile.VisualElements. Obtient ou définit les options disponibles pour une vignette secondaire.
VisualElements	Obtient un objet à travers lequel vous pouvez obtenir ou définir la couleur d’arrière-plan, le texte de premier plan, les images de vignette et les options d’affichage du nom d’application d’une vignette secondaire. À partir de Windows 8.1, les propriétés de cet objet remplacent ces propriétés SecondaryTile : SecondaryTile.BackgroundColor SecondaryTile.ForegroundText SecondaryTile.Logo SecondaryTile.SmallLogo SecondaryTile.WideLogo SecondaryTile.TileOptions (à l’exception de CopyOnDeployment)
WideLogo	Notes WideLogo peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt SecondaryTileVisualElements.Wide310x150Logo. Obtient ou définit l’image de logo utilisée dans une vignette secondaire large. Cette propriété est requise lorsque vous créez une vignette secondaire large et donne à l’utilisateur la possibilité d’une vignette large lorsqu’il redimensionne la vignette.

Méthodes

Exists(String)	Vérifie si une vignette secondaire spécifique existe pour l’application appelante.
FindAllAsync()	Récupère une liste de vignettes secondaires créées pour l’application appelante.
FindAllAsync(String)	Récupère une liste de vignettes secondaires créées pour une autre application dans le même package que l’application appelante.
FindAllForPackageAsync()	Récupère une liste de vignettes secondaires créées pour toutes les applications dans le package de l’application appelante. Lorsqu’une application est lancée, elle doit toujours énumérer ses vignettes secondaires par le biais de cette méthode, au cas où des ajouts ou suppressions étaient ignorés. Lorsqu’une vignette secondaire est supprimée via la barre d’application de l’écran d’accueil, Windows supprime simplement la vignette. L’application elle-même est chargée de libérer toutes les ressources utilisées par la vignette secondaire. Lorsque des vignettes secondaires sont copiées via le cloud, les notifications par vignette ou badge actuelles sur la vignette secondaire, les notifications planifiées, les canaux de notification Push et l’URI (Uniform Resource Identifier) utilisés avec les notifications périodiques ne sont pas copiées avec la vignette secondaire et doivent être réinitialisées.
RequestCreateAsync()	Affiche le menu volant Épingler à l’écran d’accueil , via lequel l’utilisateur peut confirmer qu’il souhaite créer la vignette secondaire, qui à son tour crée la vignette. Les surcharges de cette méthode vous permettent de spécifier l’emplacement à l’écran du menu volant. Notes Il est recommandé d’afficher le menu volant Épingler à l’écran d’accueil près du bouton qui a appelé la demande de création de la vignette. Par conséquent, nous vous recommandons d’utiliser la forme RequestCreateAsync(Point) de cette surcharge de méthode. Sur Windows Phone 8.1, la vignette secondaire est créée via cet appel sans afficher à l’utilisateur un menu volant, l’inviter à confirmer ou lui permettre de choisir une taille de vignette ou un texte de titre. Notez que lorsque vous utilisez la méthode RequestCreateAsync pour épingler une vignette secondaire dans Windows Phone application 8.x, l’application est suspendue et l’utilisateur est dirigé vers l’écran d’accueil. Ce même appel d’API sur un PC ne suspend pas le programme. Par conséquent, n’oubliez pas que l’exécution de tout code appelé après RequestCreateAsync n’est pas garantie avant la suspension de l’application. Pour éviter ce problème potentiel, vous devez utiliser l’événement OnSuspended de votre application pour exécuter tout code, tel que la mise à jour de la vignette épinglée, qui doit être exécuté avant la suspension de l’application. Pour afficher un exemple de ce modèle, téléchargez et exécutez l’exemple De mise à jour des vignettes lors de la suspension.
RequestCreateAsync(Point)	Affiche le menu volant Épingler à l’écran de démarrage au-dessus d’un emplacement spécifié, par le biais duquel l’utilisateur peut confirmer qu’il souhaite créer la vignette secondaire, qui à son tour crée la vignette. Sur Windows Phone 8.1, la vignette secondaire est créée via cet appel sans afficher à l’utilisateur un menu volant, l’inviter à confirmer ou lui permettre de choisir une taille de vignette ou un texte de titre. Notez que lorsque vous utilisez la méthode RequestCreateAsync pour épingler une vignette secondaire dans Windows Phone application 8.x, l’application est suspendue et l’utilisateur est redirigé vers l’écran d’accueil. Ce même appel d’API sur un PC ne suspend pas le programme. Par conséquent, n’oubliez pas que l’exécution de tout code appelé après RequestCreateAsync n’est pas garantie avant la suspension de l’application. Pour éviter ce problème potentiel, vous devez utiliser l’événement OnSuspended de votre application pour exécuter tout code, tel que la mise à jour de la vignette épinglée, qui doit être exécuté avant la suspension de l’application. Pour afficher un exemple de ce modèle, téléchargez et exécutez l’exemple De mise à jour des vignettes lors de la suspension.
RequestCreateForSelectionAsync(Rect)	Affiche le menu volant Épingler à l’écran d’accueil au-dessus d’une zone spécifiée. Ce menu volant est utilisé par l’utilisateur pour confirmer qu’il souhaite créer la vignette secondaire, qui à son tour crée la vignette. Sur Windows Phone 8.1, la vignette secondaire est créée par le biais de cet appel sans afficher de menu volant à l’utilisateur, sans l’inviter à confirmer, ni lui permettre de choisir une taille de vignette ou un texte de titre. Notez que lorsque vous utilisez la méthode RequestCreateAsync pour épingler une vignette secondaire dans Windows Phone application 8.x, l’application est suspendue et l’utilisateur est redirigé vers l’écran d’accueil. Ce même appel d’API sur un PC ne suspend pas le programme. Par conséquent, n’oubliez pas que l’exécution de tout code appelé après RequestCreateAsync n’est pas garantie avant la suspension de l’application. Pour éviter ce problème potentiel, vous devez utiliser l’événement OnSuspended de votre application pour exécuter tout code, tel que la mise à jour de la vignette épinglée, qui doit être exécuté avant la suspension de l’application. Pour afficher un exemple de ce modèle, téléchargez et exécutez l’exemple Mise à jour des vignettes lors de la suspension.
RequestCreateForSelectionAsync(Rect, Placement)	Affiche le menu volant Épingler à démarrer sur le côté spécifié d’une zone spécifiée. Ce menu volant est utilisé par l’utilisateur pour confirmer qu’il souhaite créer la vignette secondaire, qui à son tour crée la vignette. Sur Windows Phone 8.1, la vignette secondaire est créée par le biais de cet appel sans afficher de menu volant à l’utilisateur, sans l’inviter à confirmer, ni lui permettre de choisir une taille de vignette ou un texte de titre. Notez que lorsque vous utilisez la méthode RequestCreateAsync pour épingler une vignette secondaire dans Windows Phone application 8.x, l’application est suspendue et l’utilisateur est redirigé vers l’écran d’accueil. Ce même appel d’API sur un PC ne suspend pas le programme. Par conséquent, n’oubliez pas que l’exécution de tout code appelé après RequestCreateAsync n’est pas garantie avant la suspension de l’application. Pour éviter ce problème potentiel, vous devez utiliser l’événement OnSuspended de votre application pour exécuter tout code, tel que la mise à jour de la vignette épinglée, qui doit être exécuté avant la suspension de l’application. Pour afficher un exemple de ce modèle, téléchargez et exécutez l’exemple Mise à jour des vignettes lors de la suspension.
RequestDeleteAsync()	Affiche le menu volant Désépiner à partir de l’écran de démarrage . Ce menu volant permet à l’utilisateur de confirmer la suppression de la vignette secondaire.
RequestDeleteAsync(Point)	Affiche le menu volant Désépiner à partir du menu volant Démarrer à un point spécifié. Ce menu volant permet à l’utilisateur de confirmer la suppression de la vignette secondaire.
RequestDeleteForSelectionAsync(Rect)	Affiche le menu volant Unpin from Start au-dessus d’une zone spécifiée. Ce menu volant permet à l’utilisateur de confirmer la suppression de la vignette secondaire.
RequestDeleteForSelectionAsync(Rect, Placement)	Affiche le menu volant Désépiner à partir du menu volant Démarrer sur le côté spécifié d’une zone spécifiée. Ce menu volant permet à l’utilisateur de confirmer la suppression de la vignette secondaire.
UpdateAsync()	Mises à jour une vignette secondaire une fois cette vignette épinglée à l’écran d’accueil. Sur Windows Phone 8.1, votre application est suspendue et l’utilisateur est redirigé vers l’écran d’accueil lorsqu’une vignette secondaire est épinglée. Par conséquent, n’oubliez pas que l’exécution de tout code appelé après RequestCreateAsync n’est pas garantie avant la suspension de l’application. Pour éviter ce problème potentiel, vous devez utiliser l’événement OnSuspended de votre application pour exécuter tout code, tel que la mise à jour de la vignette épinglée, qui doit être exécuté avant la suspension de l’application. Pour afficher un exemple de ce modèle, téléchargez et exécutez l’exemple Mise à jour des vignettes lors de la suspension.

Événements

VisualElementsRequested

Déclenché lorsqu’un appel est effectué à RequestCreateAsync. Cet événement n’est pas déclenché le Windows Phone 8.1.

Voir aussi

• Conseils sur les vignettes secondaires
• Exemple de vignettes secondaires (Windows 10)
• exemple de modèle Mixed Reality