SecondaryTile Classe

Definição

Namespace:

Windows.UI.StartScreen

Cria, enumera e fornece informações sobre um bloco secundário.

Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow e Fixar blocos secundários de aplicativos da área de trabalho.

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

Herança

Object Platform::Object IInspectable SecondaryTile

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Exemplos

O exemplo a seguir cria e fixa um bloco secundário na tela Inicial.

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

O exemplo a seguir demonstra como excluir (desafixar) um bloco secundário usando o método RequestDeleteAsync . Observe que este exemplo pressupõe que o bloco existe. Para determinar se o bloco está fixado antes de chamar RequestDeleteAsync, consulte o 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.
    }
}

O exemplo a seguir demonstra como usar o método FindAllForPackageAsync para recuperar uma lista de IDs para todos os blocos secundários criados para o aplicativo de chamada e qualquer outro aplicativo no mesmo pacote.

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

O exemplo a seguir demonstra como usar o método TileUpdateManager.createTileUpdaterForSecondaryTile para enviar uma notificação a um bloco secundário com uma ID de "SecondaryTile.Dynamic". Observe que o exemplo fornece uma versão ampla e quadrada da notificação porque o usuário tem controle sobre qual forma do bloco está sendo exibida.

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

O exemplo a seguir demonstra como usar o método BadgeUpdateManager.createBadgeUpdaterForSecondaryTile para enviar uma notificação de selo numérico a um bloco secundário com uma ID 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());

Construtores

SecondaryTile()	Cria um objeto SecondaryTile . Em seguida, o chamador deve definir todas as propriedades obrigatórias por meio do objeto antes de tentar fixar, atualizar ou excluir o bloco. Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow.
SecondaryTile(String)	Cria um objeto SecondaryTile com uma ID específica. Essa forma do construtor deve ser usada para criar um objeto de bloco secundário para executar uma atualização ou exclusão de bloco. Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri)	Observação Esse construtor pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize). Cria um objeto SecondaryTile como um bloco médio. Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri, Uri)	Observação Esse construtor pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) e forneça outros tamanhos e opções de bloco por meio do método SecondaryTile.VisualElements . Cria um objeto SecondaryTile como um bloco largo. Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow. No Windows Phone 8.1, todos os blocos, incluindo blocos secundários, são fixados como blocos médios, após os quais podem ser redimensionados pelo usuário. Esse construtor fornece essa opção de redimensionamento para um bloco largo.
SecondaryTile(String, String, String, Uri, TileSize)	Cria um objeto SecondaryTile que inclui todas as propriedades obrigatórias necessárias para criar um bloco médio. Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow.

Propriedades

Arguments	Obtém ou define um conjunto de informações definido pelo aplicativo que é passado do bloco secundário para o aplicativo na ativação. Essa propriedade é necessária quando você cria um bloco.
BackgroundColor	Observação BackgroundColor pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTileVisualElements.BackgroundColor. Obtém ou define a cor da tela de fundo do bloco.
DisplayName	Obtém ou define um nome associado e exibido no bloco. Esse nome é exibido no bloco em Iniciar, na dica de ferramenta do bloco, ao lado da representação de bloco pequeno na lista Aplicativos e em alguns aplicativos Painel de Controle. Essa propriedade é necessária quando você cria um bloco. É o equivalente ao nome de exibição declarado no manifesto do bloco main do aplicativo. No Windows Phone 8.1, o nome de exibição é mostrado apenas no bloco secundário largo.
ForegroundText	Observação ForegroundText pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTileVisualElements.ForegroundText. Obtém ou define se o bloco deve usar texto escuro ou claro.
LockScreenBadgeLogo	Obtém ou define o local de uma imagem de logotipo de selo para representar o bloco secundário na tela de bloqueio. Ao fornecer essa imagem, você declara que o bloco secundário está qualificado para exibir um selo na tela de bloqueio. Se você também quiser que o bloco secundário seja qualificado para o slot de bloco detalhado da tela de bloqueio, também deverá definir a propriedade LockScreenDisplayBadgeAndTileText como True. Observação Afirmar que seu bloco secundário está qualificado para uma presença de tela de bloqueio não garante que ele terá um. Somente o usuário pode adicionar um aplicativo a um dos sete slots de tela de bloqueio. Para obter mais informações, consulte Visão geral da tela de bloqueio.
LockScreenDisplayBadgeAndTileText	Obtém ou define se o bloco secundário está qualificado para exibir um selo e um bloco detalhado na tela de bloqueio. Se você definir essa propriedade como True, também deverá fornecer uma imagem de selo por meio da propriedade LockScreenBadgeLogo . Se você não quiser usar a funcionalidade de bloco detalhada, forneça uma imagem de selo por meio da propriedade LockScreenBadgeLogo e defina LockScreenDisplayBadgeAndTileText como False. Observação Afirmar que seu bloco secundário está qualificado para uma presença de tela de bloqueio não garante que ele terá um. Somente o usuário pode adicionar um aplicativo a um dos sete slots de tela de bloqueio, além de escolher qual deles pode exibir informações detalhadas do bloco. Para obter mais informações, consulte Visão geral da tela de bloqueio.
Logo	Observação O logotipo pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTileVisualElements.Square150x150Logo. Obtém ou define a imagem de logotipo usada em um bloco médio. Essa propriedade é necessária quando você cria um bloco quadrado ou largo.
PhoneticName	Obtém ou define uma versão fonética do nome do bloco secundário. Usado com linguagens baseadas em caracteres para fins de classificação de interface do usuário.
RoamingEnabled	Obtém ou define um valor que determina se o bloco secundário será requisitar pela nuvem quando o aplicativo pai for instalado pelo usuário, usando sua conta Microsoft, em outro computador. Observe que, a partir de Windows 8.1, roaming é o comportamento padrão. Isso é o oposto do comportamento padrão do Windows 8, em que o roaming foi aceito. Essa propriedade sempre retorna false no Windows Phone 8.1.
ShortName	Observação ShortName pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTile.DisplayName. Obtém ou define um nome curto a ser exibido diretamente no bloco. Observação A partir de Windows 8.1, essa propriedade é ignorada e o nome de exibição declarado no manifesto é usado em seu lugar.
SmallLogo	Observação SmallLogo pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTileVisualElements.Square30x30Logo. Obtém ou define a imagem de logotipo pequena, usada nos resultados da pesquisa, na lista Todos os Programas e em outros locais na interface do usuário. O logotipo pequeno não é usado com um bloco secundário Windows Phone 8.1.
TileId	Obtém ou define uma cadeia de caracteres exclusiva para identificar o bloco dentro do pacote. Essa propriedade é necessária quando você cria ou exclui um bloco.
TileOptions	Observação TileOptions pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTile.VisualElements. Obtém ou define as opções disponíveis para um bloco secundário.
VisualElements	Obtém um objeto por meio do qual você pode obter ou definir a cor da tela de fundo de um bloco secundário, o texto em primeiro plano, as imagens de bloco e as opções de exibição do nome do aplicativo. A partir de Windows 8.1, as propriedades desse objeto substituem estas propriedades SecondaryTile: SecondaryTile.BackgroundColor SecondaryTile.ForegroundText SecondaryTile.Logo SecondaryTile.SmallLogo SecondaryTile.WideLogo SecondaryTile.TileOptions (exceto CopyOnDeployment)
WideLogo	Observação O WideLogo pode estar alterado ou indisponível para versões após Windows 8.1. Em vez disso, use SecondaryTileVisualElements.Wide310x150Logo. Obtém ou define a imagem de logotipo usada em um bloco secundário largo. Essa propriedade é necessária quando você cria um bloco secundário largo e dá ao usuário a opção de um bloco largo quando ele redimensiona o bloco.

Métodos

Exists(String)	Verifica se existe um bloco secundário específico para o aplicativo de chamada.
FindAllAsync()	Recupera uma lista de blocos secundários criados para o aplicativo de chamada.
FindAllAsync(String)	Recupera uma lista de blocos secundários criados para outro aplicativo no mesmo pacote que o aplicativo de chamada.
FindAllForPackageAsync()	Recupera uma lista de blocos secundários criados para todos os aplicativos no pacote do aplicativo de chamada. Quando um aplicativo é iniciado, ele sempre deve enumerar seus blocos secundários por meio desse método, caso haja adições ou exclusões das quais ele não estava ciente. Quando um bloco secundário é excluído através da barra de aplicativos da tela inicial, o Windows simplesmente remove o bloco. O próprio aplicativo é responsável por liberar qualquer recurso que tenha sido usado pelo bloco secundário. Quando blocos secundários são copiados pela nuvem, as notificações de bloco ou selo atuais no bloco secundário, as notificações agendadas, os canais de notificação por push e o URI (Uniform Resource Identifier) usados com notificações periódicas não são copiados com o bloco secundário e devem ser redefinidos.
RequestCreateAsync()	Exibe o submenu Fixar para Iniciar , por meio do qual o usuário pode confirmar que deseja criar o bloco secundário, que, por sua vez, cria o bloco. As sobrecargas desse método permitem que você especifique o local na tela do submenu. Observação É uma prática recomendada exibir o submenu Fixar para Iniciar próximo ao botão que invocou a solicitação para criar o bloco. Portanto, recomendamos que você use a forma RequestCreateAsync(Point) dessa sobrecarga de método. No Windows Phone 8.1, o bloco secundário é criado por meio dessa chamada sem mostrar ao usuário um submenu, solicitando-lhe confirmação ou permitindo que ele escolha um tamanho de bloco ou texto de título. Observe que, ao usar o método RequestCreateAsync para fixar um bloco secundário em Windows Phone aplicativo 8.x, o aplicativo é suspenso e o usuário é levado para a tela Inicial. Essa mesma chamada à API em um computador não suspende o programa. Portanto, lembre-se de que qualquer código chamado após RequestCreateAsync não tem garantia de ser executado antes que o aplicativo seja suspenso. Para evitar esse possível problema, você deve usar o evento OnSuspended do seu aplicativo para executar qualquer código, como atualizar o bloco fixado, que deve ser executado antes que o aplicativo seja suspenso. Para ver um exemplo desse padrão, baixe e execute a atualização de bloco no exemplo de suspensão.
RequestCreateAsync(Point)	Exibe o submenu Fixar para Iniciar acima de um local especificado, por meio do qual o usuário pode confirmar que deseja criar o bloco secundário, que, por sua vez, cria o bloco. No Windows Phone 8.1, o bloco secundário é criado por meio dessa chamada sem mostrar ao usuário um submenu, solicitando-lhe confirmação ou permitindo que ele escolha um tamanho de bloco ou texto de título. Observe que, ao usar o método RequestCreateAsync para fixar um bloco secundário em Windows Phone aplicativo 8.x, o aplicativo é suspenso e o usuário é levado para a tela Inicial. Essa mesma chamada à API em um computador não suspende o programa. Portanto, lembre-se de que qualquer código chamado após RequestCreateAsync não tem garantia de ser executado antes que o aplicativo seja suspenso. Para evitar esse possível problema, você deve usar o evento OnSuspended do seu aplicativo para executar qualquer código, como atualizar o bloco fixado, que deve ser executado antes que o aplicativo seja suspenso. Para ver um exemplo desse padrão, baixe e execute a atualização de bloco no exemplo de suspensão.
RequestCreateForSelectionAsync(Rect)	Exibe o submenu Fixar para Iniciar acima de uma área especificada. Esse submenu é usado pelo usuário para confirmar que deseja criar o bloco secundário, que, por sua vez, cria o bloco. No Windows Phone 8.1, o bloco secundário é criado por meio dessa chamada sem mostrar ao usuário um submenu, solicitando-lhe confirmação ou permitindo que ele escolha um tamanho de bloco ou texto de título. Observe que, ao usar o método RequestCreateAsync para fixar um bloco secundário em Windows Phone aplicativo 8.x, o aplicativo é suspenso e o usuário é levado para a tela Inicial. Essa mesma chamada à API em um computador não suspende o programa. Portanto, lembre-se de que qualquer código chamado após RequestCreateAsync não tem garantia de ser executado antes que o aplicativo seja suspenso. Para evitar esse possível problema, você deve usar o evento OnSuspended do seu aplicativo para executar qualquer código, como atualizar o bloco fixado, que deve ser executado antes que o aplicativo seja suspenso. Para ver um exemplo desse padrão, baixe e execute a atualização de bloco no exemplo de suspensão.
RequestCreateForSelectionAsync(Rect, Placement)	Exibe o submenu Fixar para Iniciar no lado especificado de uma área especificada. Esse submenu é usado pelo usuário para confirmar que deseja criar o bloco secundário, que, por sua vez, cria o bloco. No Windows Phone 8.1, o bloco secundário é criado por meio dessa chamada sem mostrar ao usuário um submenu, solicitando-lhe confirmação ou permitindo que ele escolha um tamanho de bloco ou texto de título. Observe que, ao usar o método RequestCreateAsync para fixar um bloco secundário em Windows Phone aplicativo 8.x, o aplicativo é suspenso e o usuário é levado para a tela Inicial. Essa mesma chamada à API em um computador não suspende o programa. Portanto, lembre-se de que qualquer código chamado após RequestCreateAsync não tem garantia de ser executado antes que o aplicativo seja suspenso. Para evitar esse possível problema, você deve usar o evento OnSuspended do seu aplicativo para executar qualquer código, como atualizar o bloco fixado, que deve ser executado antes que o aplicativo seja suspenso. Para ver um exemplo desse padrão, baixe e execute a atualização de bloco no exemplo de suspensão.
RequestDeleteAsync()	Exibe o submenu Desafixar do submenu Iniciar. Esse submenu permite que o usuário confirme a remoção do bloco secundário.
RequestDeleteAsync(Point)	Exibe o submenu Desafixar de Iniciar em um ponto especificado. Esse submenu permite que o usuário confirme a remoção do bloco secundário.
RequestDeleteForSelectionAsync(Rect)	Exibe o submenu Desafixar de Iniciar acima de uma área especificada. Esse submenu permite que o usuário confirme a remoção do bloco secundário.
RequestDeleteForSelectionAsync(Rect, Placement)	Exibe o submenu Desafixar de Iniciar no lado especificado de uma área especificada. Esse submenu permite que o usuário confirme a remoção do bloco secundário.
UpdateAsync()	Atualizações um bloco secundário depois que esse bloco for fixado na tela Inicial. No Windows Phone 8.1, seu aplicativo é suspenso e o usuário é levado para a tela Inicial quando um bloco secundário é fixado. Portanto, lembre-se de que qualquer código chamado após RequestCreateAsync não tem garantia de ser executado antes que o aplicativo seja suspenso. Para evitar esse possível problema, você deve usar o evento OnSuspended do seu aplicativo para executar qualquer código, como atualizar o bloco fixado, que deve ser executado antes que o aplicativo seja suspenso. Para ver um exemplo desse padrão, baixe e execute a atualização de bloco no exemplo de suspensão.

Eventos

VisualElementsRequested

Acionado quando uma chamada é feita para RequestCreateAsync. Esse evento não é gerado no Windows Phone 8.1.

Confira também

• Diretriz de blocos secundários
• Exemplo de blocos secundários (Windows 10)
• exemplo de modelo de Realidade Misturada