SecondaryTile クラス

定義

名前空間:

Windows.UI.StartScreen

セカンダリ タイルに関する情報を作成、列挙、および提供します。

デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する 」と「 デスクトップ アプリからセカンダリ タイルをピン留めする」を参照してください。

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 メソッドを使用して、呼び出し元アプリと同じパッケージ内の他のアプリ用に作成されたすべてのセカンダリ タイルの ID の一覧を取得する方法を示します。

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

次の例では、 TileUpdateManager.createTileUpdaterForSecondaryTile メソッドを使用して、ID が "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 メソッドを使用して、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());

コンストラクター

SecondaryTile()	SecondaryTile オブジェクトを作成します。 呼び出し元は、タイルをピン留め、更新、または削除する前に、オブジェクトを通じて必須プロパティを設定する必要があります。 デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。
SecondaryTile(String)	特定の ID を持つ SecondaryTile オブジェクトを作成します。 この形式のコンストラクターを使用して、タイルの更新または削除を実行するセカンダリ タイル オブジェクトを作成する必要があります。 デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。
SecondaryTile(String, String, String, String, TileOptions, Uri)	Note このコンストラクターは、Windows 8.1後のリリースでは変更または使用できない場合があります。 代わりに、 SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) を使用します。 中のタイルとして SecondaryTile オブジェクトを作成します。 デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。
SecondaryTile(String, String, String, String, TileOptions, Uri, Uri)	Note このコンストラクターは、Windows 8.1後のリリースでは変更または使用できない場合があります。 代わりに、 SecondaryTile.SecondaryTile(String, String, String, Uri, TileSize) を使用し、 SecondaryTile.VisualElements メソッドを使用して他のタイル サイズとオプションを指定します。 SecondaryTile オブジェクトをワイド タイルとして作成します。 デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。 Windows Phone 8.1 では、セカンダリ タイルを含むすべてのタイルが中タイルとしてピン留めされ、その後、ユーザーがサイズを変更できます。 このコンストラクターは、幅の広いタイルにサイズ変更するオプションを提供します。
SecondaryTile(String, String, String, Uri, TileSize)	中のタイルを作成するために必要なすべての必須プロパティを含む SecondaryTile オブジェクトを作成します。 デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。

プロパティ

Arguments	アクティブ化時にセカンダリ タイルからアプリに渡されるアプリ定義の情報セットを取得または設定します。 このプロパティは、タイルを作成するときに必要です。
BackgroundColor	Note BackgroundColor は、Windows 8.1後のリリースでは変更または使用できない場合があります。 代わりに、 SecondaryTileVisualElements.BackgroundColor を使用します。 タイルの背景色を取得または設定します。
DisplayName	タイルに関連付けられて表示される名前を取得または設定します。 この名前は、[スタート] のタイル、タイルのツールヒント、アプリの一覧の小さなタイル表現の横、一部のコントロール パネル アプリケーションに表示されます。 このプロパティは、タイルを作成するときに必要です。 これは、アプリのメイン タイルのマニフェストで宣言された表示名と同じです。 Windows Phone 8.1 では、表示名はワイド セカンダリ タイルにのみ表示されます。
ForegroundText	Note foregroundText は、Windows 8.1後にリリースで変更または使用できない場合があります。 代わりに、 SecondaryTileVisualElements.ForegroundText を使用します。 タイルで暗いテキストと淡色のテキストのどちらを使用するかを取得または設定します。
LockScreenBadgeLogo	ロック画面のセカンダリ タイルを表すバッジ ロゴイメージの場所を取得または設定します。 このイメージを指定することで、セカンダリ タイルがロック画面にバッジを表示する資格があることを宣言します。 セカンダリ タイルもロック画面の詳細タイル スロットの対象にする場合は、 LockScreenDisplayBadgeAndTileText プロパティを True に設定する必要があります。 Note セカンダリ タイルがロック画面の存在の対象であることを示しても、そのタイルにロック画面が存在することは保証されません。 ユーザーのみが、7 つのロック画面スロットのいずれかにアプリを追加できます。 詳細については、「 ロック画面の概要」を参照してください。
LockScreenDisplayBadgeAndTileText	セカンダリ タイルがバッジと詳細タイルの両方をロック画面に表示できるかどうかを取得または設定します。 このプロパティを True に設定した場合は、 LockScreenBadgeLogo プロパティを使用してバッジ イメージも指定する必要があります。 詳細なタイル機能を使用しない場合は、 LockScreenBadgeLogo プロパティを使用してバッジ イメージを指定し、LockScreenDisplayBadgeAndTileText を False に設定 します。 Note セカンダリ タイルがロック画面の存在の対象であることを示しても、そのタイルにロック画面が存在することは保証されません。 ユーザーのみが 7 つのロック画面スロットのいずれかにアプリを追加でき、そのうちの 1 つを選択して詳細なタイル情報を表示できます。 詳細については、「 ロック画面の概要」を参照してください。
Logo	Note ロゴは、Windows 8.1後のリリースでは変更または使用できない場合があります。 代わりに、 SecondaryTileVisualElements.Square150x150Logo を使用します。 中間タイルで使用されるロゴ イメージを取得または設定します。 このプロパティは、正方形またはワイド タイルを作成するときに必要です。
PhoneticName	セカンダリ タイル名のふりがなバージョンを取得または設定します。 UI の並べ替えのために文字ベースの言語で使用されます。
RoamingEnabled	親アプリが別のコンピューターに Microsoft アカウントを使用してユーザーによってインストールされたときに、セカンダリ タイルをクラウド経由で再取得するかどうかを決定する値を取得または設定します。 Windows 8.1時点では、ローミングが既定の動作であることに注意してください。 これは、ローミングがオプトインされた既定の Windows 8 動作とは逆です。 このプロパティは、Windows Phone 8.1 では常に false を返します。
ShortName	Note shortName は、Windows 8.1後のリリースで変更または使用できない場合があります。 代わりに、 SecondaryTile.DisplayName を使用します。 タイルに直接表示する短い名前を取得または設定します。 Note Windows 8.1時点では、このプロパティは無視され、マニフェストで宣言された表示名がその場所で使用されます。
SmallLogo	Note smallLogo は、Windows 8.1後にリリースで変更または使用できない場合があります。 代わりに、 SecondaryTileVisualElements.Square30x30Logo を使用します。 検索結果、すべてのプログラムの一覧、および UI 内の他の場所で使用される小さなロゴイメージを取得または設定します。 小さなロゴは、Windows Phone 8.1 セカンダリ タイルでは使用されません。
TileId	パッケージ内のタイルを識別する一意の文字列を取得または設定します。 このプロパティは、タイルを作成または削除するときに必要です。
TileOptions	Note 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	Note wideLogo は、Windows 8.1後にリリースで変更または使用できない場合があります。 代わりに、 SecondaryTileVisualElements.Wide310x150Logo を使用します。 ワイド セカンダリ タイルで使用されるロゴ イメージを取得または設定します。 このプロパティは、ワイド セカンダリ タイルを作成するときに必要であり、タイルのサイズを変更するときにワイド タイルのオプションをユーザーに提供します。

メソッド

Exists(String)	呼び出し元アプリに特定のセカンダリ タイルが存在するかどうかを確認します。
FindAllAsync()	呼び出し元アプリ用に作成されたセカンダリ タイルの一覧を取得します。
FindAllAsync(String)	呼び出し元アプリと同じパッケージ内の別のアプリ用に作成されたセカンダリ タイルの一覧を取得します。
FindAllForPackageAsync()	呼び出し元アプリのパッケージ内のすべてのアプリに対して作成されたセカンダリ タイルの一覧を取得します。 アプリを起動するときは、追加または削除があった場合に備えて、常にこのメソッドを通じてセカンダリ タイルを列挙する必要があります。 スタート画面のアプリ バーを使ってセカンダリ タイルを削除すると、タイトルも削除されます。 セカンダリ タイルによって使われていたリソースは、アプリ自体で解放する必要があります。 セカンダリ タイルがクラウド経由でコピーされる場合、セカンダリ タイルの現在のタイルまたはバッジ通知、スケジュールされた通知、プッシュ通知チャネル、および定期的な通知で使用される Uniform Resource Identifier (URI) はセカンダリ タイルと共にコピーされず、リセットする必要があります。
RequestCreateAsync()	[ 開始にピン留め する] ポップアップが表示されます。これにより、ユーザーはセカンダリ タイルを作成することを確認できます。これにより、タイルが作成されます。 このメソッドのオーバーロードを使用すると、ポップアップの画面上の場所を指定できます。 Note タイルの作成要求を呼び出したボタンの近くに [ 開始にピン留め する] ポップアップを表示することをお勧めします。 そのため、このメソッド オーバーロードの RequestCreateAsync(Point) 形式を使用することをお勧めします。 Windows Phone 8.1 では、ユーザーにポップアップを表示したり、確認を求めたり、タイル サイズやタイトル テキストを選択したりすることなく、この呼び出しによってセカンダリ タイルが作成されます。 RequestCreateAsync メソッドを使用して 8.x アプリにセカンダリ タイルWindows Phoneピン留めすると、アプリは中断され、ユーザーは [スタート] 画面に表示されます。 PC でのこの同じ API 呼び出しは、プログラムを中断しません。 そのため、RequestCreateAsync の後に呼び出されたコードは、アプリが中断される前に実行される保証はされないことに注意してください。 この潜在的な問題を回避するには、アプリの OnSuspended イベントを使用して、アプリを中断する前に実行する必要があるコード (ピン留めされたタイルの更新など) を実行する必要があります。 このパターンの例を確認するには、 中断時のタイル更新プログラムのサンプルをダウンロードして実行します。
RequestCreateAsync(Point)	指定した場所の上 に [開始にピン留め する] ポップアップを表示します。これにより、ユーザーはセカンダリ タイルを作成することを確認できます。これにより、タイルが作成されます。 Windows Phone 8.1 では、ユーザーにポップアップを表示したり、確認を求めたり、タイル サイズやタイトル テキストを選択したりすることなく、この呼び出しによってセカンダリ タイルが作成されます。 RequestCreateAsync メソッドを使用して 8.x アプリでセカンダリ タイルWindows Phoneピン留めすると、アプリは中断され、ユーザーは [スタート] 画面に表示されます。 PC でのこの同じ API 呼び出しは、プログラムを中断しません。 そのため、 RequestCreateAsync の後に呼び出されたコードは、アプリが中断される前に実行される保証はされないことに注意してください。 この潜在的な問題を回避するには、アプリの OnSuspended イベントを使用して、アプリを中断する前に実行する必要があるコード (ピン留めされたタイルの更新など) を実行する必要があります。 このパターンの例を確認するには、 中断時のタイル更新プログラムのサンプルをダウンロードして実行します。
RequestCreateForSelectionAsync(Rect)	指定した領域の上 に [開始にピン留めする] ポップアップを表示します。 このポップアップは、ユーザーがセカンダリ タイルを作成することを確認するために使用され、タイルが作成されます。 Windows Phone 8.1 では、ユーザーにポップアップを表示したり、確認を求めたり、タイル サイズやタイトル テキストを選択したりすることなく、この呼び出しによってセカンダリ タイルが作成されます。 RequestCreateAsync メソッドを使用して 8.x アプリでセカンダリ タイルWindows Phoneピン留めすると、アプリは中断され、ユーザーは [スタート] 画面に表示されます。 PC でのこの同じ API 呼び出しは、プログラムを中断しません。 そのため、 RequestCreateAsync の後に呼び出されたコードは、アプリが中断される前に実行される保証はされないことに注意してください。 この潜在的な問題を回避するには、アプリの OnSuspended イベントを使用して、アプリを中断する前に実行する必要があるコード (ピン留めされたタイルの更新など) を実行する必要があります。 このパターンの例を確認するには、 中断時のタイル更新のサンプルをダウンロードして実行します。
RequestCreateForSelectionAsync(Rect, Placement)	指定した領域の指定した側に [ 開始位置にピン留め する] ポップアップを表示します。 このポップアップは、ユーザーがセカンダリ タイルを作成することを確認するために使用され、タイルが作成されます。 Windows Phone 8.1 では、ユーザーにポップアップを表示したり、確認を求めたり、タイル サイズやタイトル テキストを選択したりすることなく、この呼び出しによってセカンダリ タイルが作成されます。 RequestCreateAsync メソッドを使用して 8.x アプリでセカンダリ タイルWindows Phoneピン留めすると、アプリは中断され、ユーザーは [スタート] 画面に表示されます。 PC でのこの同じ 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)
• Mixed Reality モデルのサンプル