SecondaryTile Класс

Определение

Пространство имен:

Windows.UI.StartScreen

Создает, перечисляет и предоставляет сведения о вторичной плитке.

В классическом приложении перед использованием экземпляра этого класса таким образом, который отображает пользовательский интерфейс, необходимо связать объект с дескриптором окна его владельца. Дополнительные сведения и примеры кода см. в разделах Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow , и Закрепление дополнительных плиток из классических приложений.

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

Наследование

Object Platform::Object IInspectable SecondaryTile

Атрибуты

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute

Требования к Windows

Семейство устройств	Windows 10 (появилось в 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (появилось в v1.0)

Примеры

В следующем примере создается и закрепляется вспомогательная плитка на начальном экране.

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

В следующем примере показано, как удалить (открепить) вторичную плитку с помощью метода RequestDeleteAsync . Обратите внимание, что в этом примере предполагается, что плитка существует. Чтобы определить, закреплена ли плитка перед вызовом RequestDeleteAsync, см. метод 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.
    }
}

В следующем примере показано, как использовать метод FindAllForPackageAsync для получения списка идентификаторов для всех дополнительных плиток, созданных для вызывающего приложения и любого другого приложения в том же пакете.

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

В следующем примере показано, как использовать метод TileUpdateManager.createTileUpdaterForSecondaryTile для отправки уведомления на вторичную плитку с идентификатором SecondaryTile.Dynamic. Обратите внимание, что в примере представлена широкая и квадратная версия уведомления, так как пользователь может контролировать, какая форма плитки отображается.

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

В следующем примере показано, как использовать метод BadgeUpdateManager.createBadgeUpdaterForSecondaryTile для отправки цифрового уведомления индикатора событий на вторичную плитку с идентификатором 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());

Конструкторы

SecondaryTile()	Создает объект SecondaryTile . Затем вызывающий объект должен задать все обязательные свойства с помощью объекта , прежде чем пытаться закрепить, обновить или удалить плитку. В классическом приложении перед использованием экземпляра этого класса таким образом, который отображает пользовательский интерфейс, необходимо связать объект с дескриптором окна его владельца. Дополнительные сведения и примеры кода см. в разделе Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow.
SecondaryTile(String)	Создает объект SecondaryTile с определенным идентификатором. Эта форма конструктора должна использоваться для создания вторичного объекта плитки для выполнения обновления или удаления плитки. В классическом приложении перед использованием экземпляра этого класса таким образом, который отображает пользовательский интерфейс, необходимо связать объект с дескриптором окна его владельца. Дополнительные сведения и примеры кода см. в разделе Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri)	Примечание Этот конструктор может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize). Создает объект SecondaryTile в виде средней плитки. В классическом приложении перед использованием экземпляра этого класса таким образом, который отображает пользовательский интерфейс, необходимо связать объект с дескриптором окна его владельца. Дополнительные сведения и примеры кода см. в разделе Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow.
SecondaryTile(String, String, String, String, TileOptions, Uri, Uri)	Примечание Этот конструктор может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) и предоставьте другие размеры и параметры плитки с помощью метода SecondaryTile.VisualElements . Создает объект SecondaryTile в виде широкой плитки. В классическом приложении перед использованием экземпляра этого класса таким образом, который отображает пользовательский интерфейс, необходимо связать объект с дескриптором окна его владельца. Дополнительные сведения и примеры кода см. в разделе Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow. В Windows Phone 8.1 все плитки, включая вторичные, закрепляются как средние плитки, после чего пользователь может изменить их размер. Этот конструктор предоставляет возможность изменения размера до широкой плитки.
SecondaryTile(String, String, String, Uri, TileSize)	Создает объект SecondaryTile , включающий все обязательные свойства, необходимые для создания средней плитки. В классическом приложении перед использованием экземпляра этого класса таким образом, который отображает пользовательский интерфейс, необходимо связать объект с дескриптором окна его владельца. Дополнительные сведения и примеры кода см. в разделе Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow.

Свойства

Arguments	Возвращает или задает определяемый приложением набор сведений, который передается из дополнительной плитки в приложение при активации. Это свойство является обязательным при создании плитки.
BackgroundColor	Примечание BackgroundColor может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте SecondaryTileVisualElements.BackgroundColor. Возвращает или задает цвет фона плитки.
DisplayName	Возвращает или задает имя, связанное с элементом и отображаемое на плитке. Это имя отображается на плитке в меню "Пуск", в подсказке плитки, рядом с небольшим представлением плитки в списке "Приложения" и в некоторых панель управления приложениях. Это свойство является обязательным при создании плитки. Это эквивалент отображаемого имени, объявленного в манифесте для плитки main приложения. В Windows Phone 8.1 отображаемое имя отображается только на широкой вспомогательной плитке.
ForegroundText	Примечание ForegroundText может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте SecondaryTileVisualElements.ForegroundText. Возвращает или задает значение, указывающее, должна ли плитка использовать темный или светлый текст.
LockScreenBadgeLogo	Возвращает или задает расположение изображения эмблемы, представляющего вспомогательную плитку на экране блокировки. Предоставляя это изображение, вы объявляете, что вспомогательная плитка может отображать индикатор событий на экране блокировки. Если вы также хотите, чтобы вспомогательная плитка была подходить для подробного слота плитки экрана блокировки, необходимо также задать для свойства LockScreenDisplayBadgeAndTileText значение True. Примечание Указание того, что ваша вторичная плитка имеет право на наличие экрана блокировки, не гарантирует, что она будет иметь ее. Только пользователь может добавить приложение в один из семи слотов экрана блокировки. Дополнительные сведения см. в статье Общие сведения о экране блокировки.
LockScreenDisplayBadgeAndTileText	Возвращает или задает значение, указывающее, может ли вспомогательная плитка отображать индикатор событий и подробную плитку на экране блокировки. Если для этого свойства задано значение True, необходимо также предоставить изображение индикатора событий с помощью свойства LockScreenBadgeLogo . Если вы не хотите использовать функцию подробной плитки, укажите изображение индикатора событий с помощью свойства LockScreenBadgeLogo и задайте для параметра LockScreenDisplayBadgeAndTileText значение False. Примечание Указание того, что ваша вторичная плитка имеет право на наличие экрана блокировки, не гарантирует, что она будет иметь ее. Только пользователь может добавить приложение в один из семи слотов экрана блокировки, а также выбрать, какой из них может отображать подробные сведения о плитке. Дополнительные сведения см. в статье Общие сведения о экране блокировки.
Logo	Примечание Логотип может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте SecondaryTileVisualElements.Square150x150Logo. Возвращает или задает изображение логотипа, используемое в средней плитке. Это свойство является обязательным при создании квадратной или широкой плитки.
PhoneticName	Возвращает или задает фонетическую версию имени вторичной плитки. Используется с языками на основе символов для сортировки пользовательского интерфейса.
RoamingEnabled	Возвращает или задает значение, определяющее, будет ли вторичная плитка повторно запрашиваться в облаке при установке родительского приложения пользователем с помощью учетной записи Майкрософт на другом компьютере. Обратите внимание, что с Windows 8.1 роуминг является поведением по умолчанию. Это противоположно поведение по умолчанию в Windows 8, когда в роуминге было согласие. Это свойство всегда возвращает значение false в Windows Phone 8.1.
ShortName	Примечание ShortName может быть изменена или недоступна для выпусков после Windows 8.1. Вместо этого используйте SecondaryTile.DisplayName. Возвращает или задает короткое имя, отображаемое непосредственно на плитке. Примечание С Windows 8.1 это свойство игнорируется, а вместо нее используется отображаемое имя, объявленное в манифесте.
SmallLogo	Примечание SmallLogo может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте SecondaryTileVisualElements.Square30x30Logo. Возвращает или задает небольшое изображение логотипа, используемое в результатах поиска, списке "Все программы" и других расположениях в пользовательском интерфейсе. Небольшой логотип не используется со вторичной плиткой Windows Phone 8.1.
TileId	Возвращает или задает уникальную строку для идентификации плитки в пакете. Это свойство является обязательным при создании или удалении плитки.
TileOptions	Примечание TileOptions могут быть изменены или недоступны для выпусков после Windows 8.1. Вместо этого используйте SecondaryTile.VisualElements. Возвращает или задает параметры, доступные для вторичной плитки.
VisualElements	Возвращает объект, с помощью которого можно получить или задать цвет фона дополнительной плитки, текст переднего плана, изображения плиток и параметры отображения имени приложения. С Windows 8.1 свойства этого объекта заменяют следующие свойства SecondaryTile: SecondaryTile.BackgroundColor SecondaryTile.ForegroundText SecondaryTile.Logo SecondaryTile.SmallLogo SecondaryTile.WideLogo SecondaryTile.TileOptions (кроме CopyOnDeployment)
WideLogo	Примечание WideLogo может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте SecondaryTileVisualElements.Wide310x150Logo. Возвращает или задает изображение логотипа, используемое в широкой вспомогательной плитке. Это свойство является обязательным при создании широкой вторичной плитки и предоставляет пользователю возможность широкой плитки при изменении размера плитки.

Методы

Exists(String)	Проверяет, существует ли определенная вторичная плитка для вызывающего приложения.
FindAllAsync()	Извлекает список дополнительных плиток, созданных для вызывающего приложения.
FindAllAsync(String)	Извлекает список дополнительных плиток, созданных для другого приложения в том же пакете, что и вызывающее приложение.
FindAllForPackageAsync()	Извлекает список дополнительных плиток, созданных для всех приложений в пакете вызывающего приложения. При запуске приложение должно всегда перечислять свои вспомогательные плитки с помощью этого метода, если были какие-либо дополнения или удаления, о которых ему не известно. Если вспомогательная плитка удаляется с помощью панели приложения начального экрана, Windows просто удаляет плитку. Само приложение отвечает за высвобождение любых ресурсов, использовавшихся вспомогательной плиткой. Когда вторичные плитки копируются через облако, текущие плитки или уведомления индикатора событий на вторичной плитке, запланированные уведомления, каналы push-уведомлений и универсальный код ресурса (URI), используемые с периодическими уведомлениями, не копируются со вторичной плиткой и должны быть сброшены.
RequestCreateAsync()	Отображает всплывающий элемент Закрепить на начальном экране , с помощью которого пользователь может подтвердить, что он хочет создать вспомогательную плитку, которая, в свою очередь, создает плитку. Перегрузки этого метода позволяют указать расположение всплывающего элемента на экране. Примечание Рекомендуется отображать всплывающий элемент Закрепить на начальном экране рядом с кнопкой, которая вызвала запрос на создание плитки. Поэтому рекомендуется использовать форму RequestCreateAsync(Point) перегрузки этого метода. В Windows Phone 8.1 вспомогательная плитка создается с помощью этого вызова, не показывая пользователю всплывающий элемент, не предлагая ему подтвердить или не позволяя выбрать размер плитки или текст заголовка. Обратите внимание, что при использовании метода RequestCreateAsync для закрепления дополнительной плитки в приложении Windows Phone версии 8.x приложение приостанавливается, а пользователь перейдет на начальный экран. Этот же вызов API на компьютере не приостанавливает работу программы. Поэтому имейте в виду, что любой код, вызываемый после RequestCreateAsync, не гарантируется выполнение до приостановки приложения. Чтобы избежать этой потенциальной проблемы, следует использовать событие OnSuspended приложения для выполнения любого кода, например обновления закрепленной плитки, который должен выполняться до приостановки приложения. Чтобы просмотреть пример этого шаблона, скачайте и запустите пример обновления плитки при приостановке.
RequestCreateAsync(Point)	Отображает всплывающий элемент Закрепить на начальном экране над указанным расположением, с помощью которого пользователь может подтвердить, что он хочет создать вспомогательную плитку, которая, в свою очередь, создает плитку. В Windows Phone 8.1 вспомогательная плитка создается с помощью этого вызова, не показывая пользователю всплывающий элемент, не предлагая ему подтвердить или не позволяя выбрать размер плитки или текст заголовка. Обратите внимание, что при использовании метода RequestCreateAsync для закрепления вторичной плитки в приложении Windows Phone 8.x приложение приостанавливается, а пользователь перейдет на начальный экран. Этот же вызов API на компьютере не приостанавливает работу программы. Поэтому имейте в виду, что любой код, вызываемый после RequestCreateAsync , не гарантируется выполнение до приостановки приложения. Чтобы избежать этой потенциальной проблемы, следует использовать событие OnSuspended приложения для выполнения любого кода, например обновления закрепленной плитки, который должен выполняться до приостановки приложения. Чтобы просмотреть пример этого шаблона, скачайте и запустите пример обновления плитки при приостановке.
RequestCreateForSelectionAsync(Rect)	Отображает всплывающий элемент Закрепить на начальном экране над указанной областью. Этот всплывающий элемент используется пользователем для подтверждения того, что он хочет создать вспомогательную плитку, которая, в свою очередь, создает плитку. В Windows Phone 8.1 вспомогательная плитка создается с помощью этого вызова, не показывая пользователю всплывающий элемент, не предлагая ему подтвердить или не позволяя выбрать размер плитки или текст заголовка. Обратите внимание, что при использовании метода RequestCreateAsync для закрепления вторичной плитки в приложении Windows Phone 8.x приложение приостанавливается, а пользователь перейдет на начальный экран. Этот же вызов API на компьютере не приостанавливает работу программы. Поэтому имейте в виду, что любой код, вызываемый после RequestCreateAsync , не гарантируется выполнение до приостановки приложения. Чтобы избежать этой потенциальной проблемы, следует использовать событие OnSuspended приложения для выполнения любого кода, например обновления закрепленной плитки, который должен выполняться до приостановки приложения. Чтобы просмотреть пример этого шаблона, скачайте и запустите пример обновления плитки при приостановке.
RequestCreateForSelectionAsync(Rect, Placement)	Отображает всплывающий элемент Закрепить на начальном экране на указанной стороне указанной области. Этот всплывающий элемент используется пользователем для подтверждения того, что он хочет создать вспомогательную плитку, которая, в свою очередь, создает плитку. В Windows Phone 8.1 вспомогательная плитка создается с помощью этого вызова, не показывая пользователю всплывающий элемент, не предлагая ему подтвердить или не позволяя выбрать размер плитки или текст заголовка. Обратите внимание, что при использовании метода RequestCreateAsync для закрепления вторичной плитки в приложении Windows Phone 8.x приложение приостанавливается, а пользователь перейдет на начальный экран. Этот же вызов API на компьютере не приостанавливает работу программы. Поэтому имейте в виду, что любой код, вызываемый после RequestCreateAsync , не гарантируется выполнение до приостановки приложения. Чтобы избежать этой потенциальной проблемы, следует использовать событие OnSuspended приложения для выполнения любого кода, например обновления закрепленной плитки, который должен выполняться до приостановки приложения. Чтобы просмотреть пример этого шаблона, скачайте и запустите пример обновления плитки при приостановке.
RequestDeleteAsync()	Отображает всплывающий элемент Открепить от запуска . Этот всплывающий элемент позволяет пользователю подтвердить удаление дополнительной плитки.
RequestDeleteAsync(Point)	Отображает всплывающее окно Открепить от запуска в указанной точке. Этот всплывающий элемент позволяет пользователю подтвердить удаление дополнительной плитки.
RequestDeleteForSelectionAsync(Rect)	Отображает всплывающий элемент Открепить от запуска над указанной областью. Этот всплывающий элемент позволяет пользователю подтвердить удаление дополнительной плитки.
RequestDeleteForSelectionAsync(Rect, Placement)	Отображает всплывающий элемент Открепить от запуска на указанной стороне указанной области. Этот всплывающий элемент позволяет пользователю подтвердить удаление дополнительной плитки.
UpdateAsync()	Обновления вспомогательную плитку после того, как она будет закреплена на начальном экране. В Windows Phone 8.1 приложение приостанавливается, и пользователь перейдет на начальный экран при закреплении дополнительной плитки. Поэтому имейте в виду, что любой код, вызываемый после RequestCreateAsync , не гарантируется выполнение до приостановки приложения. Чтобы избежать этой потенциальной проблемы, следует использовать событие OnSuspended приложения для выполнения любого кода, например обновления закрепленной плитки, который должен выполняться до приостановки приложения. Чтобы просмотреть пример этого шаблона, скачайте и запустите пример обновления плитки при приостановке.

События

VisualElementsRequested

Возникает при вызове метода RequestCreateAsync. Это событие не вызывается в Windows Phone 8.1.

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

• Руководство по вспомогательным плиткам
• Пример дополнительных плиток (Windows 10)
• Пример модели Смешанная реальность