注
「ライブ タイル」は Windows 10 の機能であり、それ以降のバージョンの Windows ではサポートされていません。 新しいアプリの場合は、 App アイコンの現在のガイダンスに従うことをお勧めします。
ここでは、タイルのコンテンツ内にあるすべてのプロパティと要素について説明します。
Notifications ライブラリではなく生の XML を使う場合は、「XML スキーマ」をご覧ください。
TileContent
TileContent は、視覚効果などのタイル通知のコンテンツを説明する最上位のオブジェクトです。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| Visual | ToastVisual | true | タイル通知の視覚的な部分について説明します。 |
TileVisual
タイルの視覚的な部分には、すべてのタイルサイズを対象とした視覚的な仕様、および視覚に関連するプロパティが含まれています。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| TileSmall | TileBinding | false | 小さなタイル サイズのコンテンツを指定するための、オプションの小さなバインドを用意してください。 |
| TileMedium | TileBinding | false | 中サイズ タイル用のコンテンツを指定するための、オプションのバインドが提供されます。 |
| TileWide | TileBinding | false | ワイドなタイルのサイズに対応したコンテンツを指定するための、オプションのワイド サイズ バインディングを指定します。 |
| TileLarge | TileBinding | false | 大きなタイル サイズのコンテンツを指定するための、オプションの大きなバインドを用意してください。 |
| ブランディング | TileBranding | false | タイルでアプリのブランドを表示する際に使用する形式です。 既定では、既定のタイルからブランド設定を継承します。 |
| DisplayName | 文字列 | false | この通知が表示されているときにタイルの表示名を上書きする文字列です (オプション)。 |
| 引数 | 文字列 | false | Anniversary Update の新機能: ユーザーがライブ タイルからアプリを起動したときに、LaunchActivatedEventArgs の TileActivatedInfo プロパティを介してアプリに返される、アプリで定義されたデータ。 これにより、ユーザーがライブ タイルをタップしたときに表示されたタイル通知がどれであるかがわかります。 Anniversary Update が適用されていないデバイスでは、このプロパティは無視されるだけです。 |
| LockDetailedStatus1 | 文字列 | false | これを指定する場合は、TileWide バインディングも指定する必要があります。 ユーザーがあなたのタイルを「詳細状態アプリ」として選択した場合、ロック画面に表示される最初のテキストです。 |
| LockDetailedStatus2 | 文字列 | false | これを指定する場合は、TileWide バインディングも指定する必要があります。 ユーザーがあなたのタイルを「詳細状態アプリ」として選択した場合、ロック画面に表示される 2 つ目のテキストです。 |
| LockDetailedStatus3 | 文字列 | false | これを指定する場合は、TileWide バインディングも指定する必要があります。 ユーザーがあなたのタイルを状態の詳細を表示するアプリとして選択した場合に、ロック画面に表示されるテキストの 3 行目です。 |
| BaseUri | Uri | false | 画像ソースの属性において相対 URL と組み合わされる、既定のベース URL です。 |
| AddImageQuery | bool? | false | true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像のバリアントを返せるか、またはクエリ文字列を無視して、クエリ文字列なしで指定された画像を返せる場合です。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" に変わります。 |
| 言語 | 文字列 | false | ローカライズされたリソースを使用する際の視覚ペイロードの対象ロケールであり、"en-US" や "fr-FR" のような BCP-47 言語タグとして指定されます。 このロケールは、バインディングかテキストで指定されるあらゆるロケールによって上書きされます。 未指定の場合は、システム ロケールが代わりに使用されます。 |
TileBinding
バインディング オブジェクトには、特定のタイル サイズ向けの視覚的なコンテンツが含まれています。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| コンテンツ | ITileBindingContent | false | タイルに表示される視覚的なコンテンツです。 TileBindingContentAdaptive、TileBindingContentIconic、TileBindingContentContact、TileBindingContentPeople、または TileBindingContentPhotos のいずれかです。 |
| ブランディング | TileBranding | false | タイルでアプリのブランドを表示する際に使用する形式です。 既定では、既定のタイルからブランド設定を継承します。 |
| DisplayName | 文字列 | false | このタイルのサイズに対応したタイルの表示名を上書きする文字列です (オプション)。 |
| 引数 | 文字列 | false | Anniversary Update の新機能: ユーザーがライブ タイルからアプリを起動したときに、アプリで定義されたデータが LaunchActivatedEventArgs の TileActivatedInfo プロパティを介してアプリに返されます。 これにより、ユーザーがライブ タイルをタップしたときにユーザーが見たタイル通知がどれであるかがわかります。 Anniversary Update が適用されていないデバイスでは、このプロパティは無視されるだけです。 |
| BaseUri | Uri | false | 画像ソースの属性において相対 URL と組み合わされる、既定のベース URL です。 |
| AddImageQuery | bool? | false | true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 サーバーがイメージをホストしていて、クエリ文字列を処理できる場合 (クエリ文字列に基づいてイメージのバリエーションを取得する場合、あるいはクエリ文字列を無視して、クエリ文字列なしの指定されたイメージを返す場合)、この属性を使用してください。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" に変わります。 |
| 言語 | 文字列 | false | ローカライズされたリソースを使用する際の視覚的なペイロードの対象ロケールであり、"en-US" や "fr-FR" のような BCP-47 言語タグとして指定されます。 このロケールは、バインディングかテキストで指定されるあらゆるロケールによって上書きされます。 未指定の場合は、システム ロケールが代わりに使用されます。 |
ITileBindingContent
タイルのバインディング コンテンツのマーカー インターフェイスです。 これらを使用することで、タイルの視覚表現をどの形式で指定するかを選択できます。アダプティブ、または特別なテンプレートのいずれかを選択できます。
| 実装 |
|---|
| TileBindingContentAdaptive |
| TileBindingContentIconic |
| TileBindingContentContact |
| TileBindingContentPeople |
| TileBindingContentPhotos |
TileBindingContentAdaptive
すべてのサイズに対応しています。 タイルのコンテンツを指定する場合に推奨される方法です。 アダプティブ タイル テンプレートは Windows 10 の新機能で、アダプティブを使用してさまざまなカスタム タイルを作成できます。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 子 | IList<ITileBindingContentAdaptiveChild> | false | インラインの視覚要素です。 AdaptiveText、AdaptiveImage、および AdaptiveGroup の各オブジェクトを追加することができます。 子要素は、StackPanel のように縦方向に並べて表示されます。 |
| BackgroundImage | TileBackgroundImage | false | すべてのタイル コンテンツの背後に、フルスクリーンで表示されるオプションの背景画像です。 |
| PeekImage | TilePeekImage | false | タイルの上部からアニメーション表示されるプレビュー画像です (オプション)。 |
| TextStacking | TileTextStacking | false | 子コンテンツ全体のテキストの配置(縦方向の整列)を制御します。 |
AdaptiveText
適応型のテキスト要素
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| テキスト | 文字列 | false | 表示するテキスト。 |
| HintStyle | AdaptiveTextStyle | false | このスタイルは、テキストのフォント サイズ、太さ、および不透明度を制御します。 |
| HintWrap | bool? | false | これを true に設定すると、テキストの折り返しが有効になります。 既定値は false です。 |
| HintMaxLines | int? | false | 表示が許可される、テキスト要素の最大行数です。 |
| HintMinLines | int? | false | 表示する必要のある、テキスト要素の最小行数です。 |
| HintAlign | AdaptiveTextAlign | false | テキストの水平方向の配置。 |
| 言語 | 文字列 | false | XML ペイロードの対象ロケール。これは、「en-US」や「fr-FR」などの BCP-47 言語タグとして指定されます。 ここで指定されたロケールは、バインディングやビジュアルなどで指定されたロケールなど、他のすべてのロケール設定よりも優先されます。 この値がリテラル文字列の場合、この属性の既定値はユーザーの UI 言語になります。 この値が文字列リファレンスの場合、この属性の既定値は、文字列を解決する際に Windows ランタイムで選択されたロケールになります。 |
AdaptiveTextStyle
テキスト スタイルは、フォント サイズ、太さ、および不透明度を制御します。 「わずか」の不透明度は 60% です。
| 値 | 意味 |
|---|---|
| 既定 | 既定値です。 スタイルがレンダラーによって決定されます。 |
| キャプション | 段落のフォントサイズより小さいです。 |
| CaptionSubtle | Caption と同じですが、不透明度が控えめです。 |
| 本文 | 段落のフォントサイズ。 |
| BodySubtle | Body と同じですが、わずかに不透明感があります。 |
| Base | 段落のフォントサイズ、太字。 基本的には、Body の太字バージョンと言えます。 |
| BaseSubtle | Base と同じですが、わずかに不透明感があります。 |
| Subtitle | H4 フォント サイズ。 |
| SubtitleSubtle | Subtitle と同じですが、不透明度がわずかに低いです。 |
| タイトル | H3 フォント サイズ。 |
| TitleSubtle | Title と同じですが、不透明度がわずかに低くなっています。 |
| TitleNumeral | Title と同じですが、上/下のパディングが削除された状態です。 |
| サブヘッダー | H2 フォント サイズ。 |
| SubheaderSubtle | Subheader と同じですが、不透明度がわずかに低くなっています。 |
| SubheaderNumeral | Subheader と同じですが、上/下の余白が削除されています。 |
| Header | H1 フォント サイズ。 |
| HeaderSubtle | Header と同じですが、わずかに不透明感があります。 |
| HeaderNumeral | Header と同じですが、上/下の余白が削除されています。 |
AdaptiveTextAlign
テキストの水平方向の配置を制御します。
| 値 | 意味 |
|---|---|
| 既定 | 既定値です。 配置がレンダラーによって自動的に決定されます。 |
| Auto | 配置が現在の言語とカルチャによって決定されます。 |
| 左 | テキストを左揃えにします。 |
| 中央 | テキストを中央に水平方向に配置します。 |
| 右 | テキストを右揃えにします。 |
AdaptiveImage
インラインのイメージ。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| ソース | 文字列 | true | 画像への URL です。 ms-appx、ms-appdata、および http がサポートされます。 Fall Creators Update の時点で、Web 画像の上限は通常の接続で 3 MB、従量制課金接続で 1 MB です。 Fall Creators Update が実行されていないデバイスでは、Web イメージのサイズは 200 KB 以下である必要があります。 |
| HintCrop | AdaptiveImageCrop | false | イメージのトリミング範囲を自由に調整できます。 |
| HintRemoveMargin | bool? | false | 既定では、グループ/サブグループ内の画像には周囲に 8 ピクセルの余白があります。 このプロパティを true に設定することで余白を削除できます。 |
| HintAlign | AdaptiveImageAlign | false | 画像の水平方向の配置です。 |
| AlternateText | 文字列 | false | アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。 |
| AddImageQuery | bool? | false | "true" に設定すると、タイル通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。具体的には、クエリ文字列に基づいて画像のバリアントを取得できる場合、またはクエリ文字列を無視し、クエリ文字列なしで指定された画像を返すことができる場合です。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" に変わります。 |
AdaptiveImageCrop
希望する画像のトリミング設定を指定します。
| 値 | 意味 |
|---|---|
| 既定 | 既定値。 トリミングの動作がレンダラーによって決定されます。 |
| なし | 画像はトリミングされていません。 |
| サークル | 画像が円形にトリミングされます。 |
AdaptiveImageAlign
画像の水平方向の配置を指定します。
| 値 | 意味 |
|---|---|
| 既定 | 既定値です。 整列の動作がレンダラーによって決定されます。 |
| Stretch | 利用可能な幅いっぱいに画像が拡大されます (また同時に、画像が配置される位置に応じて、利用可能な高さいっぱいに拡大されることもあります)。 |
| 左 | 画像を左側に配置し、ネイディブの解像度で表示します。 |
| 中央 | イメージを水平方向の中央に配置し、ネイティブ解像度で画像を表示します。 |
| 右 | 画像を右側に配置し、ネイディブの解像度で表示します。 |
AdaptiveGroup
グループは、グループ内のコンテンツについて、全体を表示すべきか、収まりきらない場合は全体を表示すべきでないかを意味的に識別します。 グループは複数の列を作成することも可能にします。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 子 | IList<AdaptiveSubgroup> | false | サブグループが垂直方向の列として表示されます。 AdaptiveGroup 内の任意のコンテンツを提供するにはサブグループを使用する必要があります。 |
AdaptiveSubgroup
サブグループは垂直方向の列で、テキストと画像を含めることができます。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 子 | IList<IAdaptiveSubgroupChild> | false | AdaptiveText と AdaptiveImage は、サブグループの有効な子です。 |
| HintWeight | int? | false | 他のサブグループに対する相対的な重みを指定することで、このサブグループの列の幅を制御します。 |
| HintTextStacking | AdaptiveSubgroupTextStacking | false | このサブグループのコンテンツの垂直方向の配置を制御します。 |
IAdaptiveSubgroupChild
サブグループの子のマーカー インターフェイスです。
| 実装 |
|---|
| AdaptiveText |
| AdaptiveImage |
AdaptiveSubgroupTextStacking
TextStacking は、コンテンツの垂直方向の配置を指定します。
| 値 | 意味 |
|---|---|
| 既定 | 既定値です。 レンダラーは既定の垂直揃えを自動的に選択します。 |
| 先頭 | 上端に揃えます |
| 中央 | 垂直方向で中央揃えにします。 |
| 下 | 下揃えにします。 |
TileBackgroundImage
タイルにフルブリードで表示される背景画像です。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| ソース | 文字列 | true | 画像への URL です。 ms-appx、ms-appdata、および http(s) がサポートされます。 http の画像は、サイズを 200 KB 以下にする必要があります。 |
| HintOverlay | int? | false | 背景画像上の黒のオーバーレイです。 この値は、黒のオーバーレイの不透明度を制御します。0 ではオーバーレイなし、100 では完全に黒になります。 既定値は 20 です。 |
| HintCrop | TileBackgroundImageCrop | false | 1511 の新着機能: 画像をどのようにトリミングするかを指定します。 1511 よりも前のバージョンでは、このプロパティは無視され、背景画像はトリミングなしで表示されます。 |
| AlternateText | 文字列 | false | アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。 |
| AddImageQuery | bool? | false | "true" に設定すると、タイル通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 サーバーがイメージをホストしていて、クエリ文字列を処理できる場合 (クエリ文字列に基づいてイメージのバリエーションを取得する場合、あるいはクエリ文字列を無視して、クエリ文字列なしの指定されたイメージを返す場合)、この属性を使用してください。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" に変わります。 |
TileBackgroundImageCrop
背景画像のトリミングを制御します。
| 値 | 意味 |
|---|---|
| 既定 | トリミングでは、レンダラーのデフォルトの動作が使用されます。 |
| なし | 画像がトリミングされず、正方形で表示されます。 |
| 円 | 画像が円形にトリミングされます。 |
TilePeekImage
タイルの上部からアニメーション表示されるプレビュー画像です。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| ソース | 文字列 | true | 画像への URL です。 ms-appx、ms-appdata、および http(s) がサポートされます。 http の画像は、サイズを 200 KB 以下にする必要があります。 |
| HintOverlay | int? | false | 1511 の新機能: プレビュー画像に黒いオーバーレイが表示されます。 この値は、黒いオーバーレイの不透明度を制御します。0 はオーバーレイなし、100 は完全に黒になります。 既定値は 20 です。 以前のバージョンでは、この値は無視され、オーバーレイが 0 の状態でプレビュー イメージが表示されます。 |
| HintCrop | TilePeekImageCrop | false | 1511 の新機能: イメージのトリミング方法を指定できます。 バージョン 1511 以前では、この設定は無視され、イメージはトリミングされずにプレビュー表示されます。 |
| AlternateText | 文字列 | false | アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。 |
| AddImageQuery | bool? | false | "true" に設定すると、タイル通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 サーバーがイメージをホストしていて、クエリ文字列を処理できる場合 (クエリ文字列に基づいてイメージのバリエーションを取得する場合、あるいはクエリ文字列を無視して、クエリ文字列なしの指定されたイメージを返す場合)、この属性を使用してください。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知に指定された値 www.website.com/images/hello.png は www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us になります |
TilePeekImageCrop
プレビュー イメージのトリミングを設定します。
| 値 | 意味 |
|---|---|
| 既定 | トリミングでは、レンダラーのデフォルトの動作が使用されます。 |
| なし | 画像がトリミングされず、正方形で表示されます。 |
| サークル | 画像が円形にトリミングされます。 |
TileTextStacking
テキストの積み重ねは、コンテンツの垂直方向の配置を指定します。
| 値 | 意味 |
|---|---|
| 既定 | 既定値です。 レンダラーが既定の垂直方向の配置を自動的に選択します。 |
| トップ | 上端に垂直に揃えます。 |
| センター | 中央に垂直に揃えます。 |
| 下 | 底面に垂直に揃えます。 |
TileBindingContentIconic
Small と Medium でサポートされています。 アイコンとバッジをタイル上で並べて表示できるアイコン タイル テンプレートを有効にします。 アイコンの横にある数字は、別のバッジ通知によって表示されます。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| アイコン | TileBasicImage | true | 少なくとも、デスクトップとモバイル、および小さいタイルと中型のタイルの両方をサポートするために、縦横比が正方形となる画像を、解像度 200 x 200、PNG 形式、透過で、色は白以外を使用しないものとして指定します。 詳しくは、「特別なタイル テンプレート」をご覧ください。 |
TileBindingContentContact
モバイルのみ。 Small と Medium、Wide でサポートされています。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 画像 | TileBasicImage | true | 表示する画像。 |
| テキスト | TileBasicText | false | 表示されるテキストの行です。 小さいタイルには表示されません。 |
TileBindingContentPeople
1511 の新機能: Medium、Wide、Large でサポートされます (デスクトップおよびモバイル)。 以前は、モバイル限定で、サイズも Medium と Wide のみでした。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 画像 | IList<TileBasicImage> | true | 円を描くように回転するイメージ。 |
TileBindingContentPhotos
写真のスライド ショーを再生します。 すべてのサイズでサポートされます。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 画像 | IList<TileBasicImage> | true | 最大で 12 枚の画像を指定できます (モバイルの場合は 9 枚まで表示できます)。これらの画像はスライドショーに使用されます。 12 を超えて指定すると、例外がスローされます。 |
TileBasicImage
さまざまな特別なテンプレートで使用される画像です。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| ソース | 文字列 | true | 画像への URL です。 ms-appx、ms-appdata、および http(s) がサポートされます。 http の画像は、サイズを 200 KB 以下にする必要があります。 |
| AlternateText | 文字列 | false | アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。 |
| AddImageQuery | bool? | false | "true" に設定すると、タイル通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。 サーバーがイメージをホストしていて、クエリ文字列を処理できる場合 (クエリ文字列に基づいてイメージのバリエーションを取得する場合、あるいはクエリ文字列を無視して、クエリ文字列なしの指定されたイメージを返す場合)、この属性を使用してください。 このクエリ文字列は、スケール、コントラスト設定、言語を指定します。たとえば、通知で指定された "www.website.com/images/hello.png" の値は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" に変わります。 |
TileBasicText
さまざまな特別なテンプレートで使用される基本的なテキスト要素です。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| テキスト | 文字列 | false | 表示するテキスト。 |
| 言語 | 文字列 | false | XML ペイロードの対象ロケール。これは、「en-US」や「fr-FR」などの BCP-47 言語タグとして指定されます。 ここで指定されたロケールは、バインディングやビジュアルなどで指定されたロケールなど、他のすべてのロケール設定よりも優先されます。 この値がリテラル文字列の場合、この属性の既定値はユーザーの UI 言語になります。 この値が文字列リファレンスの場合、この属性は、文字列の解決時に Windows ランタイムによって選択されたロケールに既定で設定されます。 |