トーストのコンテンツのスキーマToast content schema

ここでは、トーストのコンテンツ内のすべてのプロパティと要素を説明します。The following describes all of the properties and elements within toast content.

Notifications ライブラリではなく生の XML を使う場合は、「XML スキーマ」をご覧ください。If you would rather use raw XML instead of the Notifications library, please see the XML schema.

ToastContentToastContent

ToastContentToastContent

ToastContent は、視覚効果、アクション、オーディオなどの通知のコンテンツを説明する最上位のオブジェクトです。ToastContent is the top level object that describes a notification's content, including visuals, actions, and audio.

プロパティProperty 種類Type 必須Required 説明Description
起動Launch stringstring falsefalse トーストによってアプリケーションがアクティブ化されるときにアプリケーションに渡される文字列です。A string that is passed to the application when it is activated by the Toast. この文字列の形式とコンテンツは、アプリ独自の使用方法に合わせて、アプリによって定義されます。The format and contents of this string are defined by the app for its own use. ユーザーがトーストをタップまたはクリックして関連するアプリを起動すると、そのアプリは既定の方法では起動されません。起動文字列によってコンテキストがアプリに渡され、トーストのコンテンツに関連するビューがユーザーに表示されます。When the user taps or clicks the Toast to launch its associated app, the launch string provides the context to the app that allows it to show the user a view relevant to the Toast content, rather than launching in its default way.
ビジュアルVisual ToastVisualToastVisual truetrue トースト通知の視覚的な部分について説明します。Describes the visual portion of the toast notification.
操作Actions IToastActionsIToastActions falsefalse 必要に応じて、ボタンや入力によってカスタム動作を作成します。Optionally create custom actions with buttons and inputs.
オーディオAudio ToastAudioToastAudio falsefalse トースト通知のオーディオ部分について説明します。Describes the audio portion of the toast notification.
ActivationTypeActivationType ToastActivationTypeToastActivationType falsefalse ユーザーがトーストの本文をクリックしたときに使用されるアクティブ化の種類を指定します。Specifies what activation type will be used when the user clicks the body of this Toast.
ActivationOptionsActivationOptions ToastActivationOptionsToastActivationOptions falsefalse Creators Update: 新機能トースト通知のアクティブ化に関連する追加オプション。New in Creators Update: Additional options relating to activation of the toast notification.
ScenarioScenario ToastScenarioToastScenario falsefalse アラームやリマインダーなど、トーストが使用されるシナリオを宣言します。Declares the scenario your toast is used for, like an alarm or reminder.
DisplayTimestampDisplayTimestamp DateTimeOffset?DateTimeOffset? falsefalse Creators Update: 新機能通知の内容が実際に配信されると、Windows プラットフォームで、通知を受信した時点ではなく、カスタムのタイムスタンプの表すで既定のタイムスタンプをオーバーライドします。New in Creators Update: Override the default timestamp with a custom timestamp representing when your notification content was actually delivered, rather than the time the notification was received by the Windows platform.
ヘッダーHeader ToastHeaderToastHeader falsefalse Creators Update: 新機能アクション センター内の複数の通知をグループ化、通知にカスタム ヘッダーを追加します。New in Creators Update: Add a custom header to your notification to group multiple notifications together within Action Center.

ToastScenarioToastScenario

トーストが表すシナリオを指定します。Specifies what scenario the toast represents.

ValueValue 説明Meaning
DefaultDefault 通常のトーストの動作です。The normal toast behavior.
アラームReminder リマインダー通知です。A reminder notification. 既に展開された状態で表示され、無視されるまでユーザーの画面に表示されます。This will be displayed pre-expanded and stay on the user's screen till dismissed.
アラームAlarm アラーム通知です。An alarm notification. 既に展開された状態で表示され、無視されるまでユーザーの画面に表示されます。This will be displayed pre-expanded and stay on the user's screen till dismissed. オーディオは既定でループするようになっていて、アラームのオーディオを使用します。Audio will loop by default and will use alarm audio.
IncomingCallIncomingCall 着信通知です。An incoming call notification. 既に展開された状態で、特殊な呼び出しの形式で表示され、無視されるまでユーザーの画面に表示されます。This will be displayed pre-expanded in a special call format and stay on the user's screen till dismissed. オーディオは既定でループするようになっていて、着信音のオーディオを使用します。Audio will loop by default and will use ringtone audio.

ToastVisualToastVisual

トーストの視覚的な部分です。テキスト、画像、アダプティブ コンテンツなどを含むバインディングが含まれます。The visual portion of toasts contains the bindings, which contains text, images, adaptive content, and more.

プロパティProperty 種類Type 必須Required 説明Description
BindingGenericBindingGeneric ToastBindingGenericToastBindingGeneric truetrue すべてのデバイスでレンダリングすることができる、汎用的なトーストのバインディングです。The generic toast binding, which can be rendered on all devices. このバインディングは必須で、null にすることはできません。This binding is required and cannot be null.
BaseUriBaseUri UriUri falsefalse 画像ソースの属性において相対 URL と組み合わされる、既定のベース URL です。A default base URL that is combined with relative URLs in image source attributes.
AddImageQueryAddImageQuery bool?bool? falsefalse true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。Set to "true" to allow Windows to append a query string to the image URL supplied in the toast notification. この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. このクエリ文字列は、スケール、コントラスト設定、および言語を指定するものです。たとえば、通知で指定されている値 "www.website.com/images/hello.png" は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" になります。This query string specifies scale, contrast setting, and language; for instance, a value of "www.website.com/images/hello.png" given in the notification becomes "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us"
言語Language stringstring falsefalse ローカライズされたリソースを使用する際の視覚的なペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。The target locale of the visual payload when using localized resources, specified as BCP-47 language tags such as "en-US" or "fr-FR". このロケールは、バインディングかテキストで指定されるあらゆるロケールによって上書きされます。This locale is overridden by any locale specified in binding or text. 未指定の場合は、システム ロケールが代わりに使用されます。If not provided, the system locale will be used instead.

ToastBindingGenericToastBindingGeneric

汎用のバインディングは、トーストの既定のバインディングです。ここでテキスト、画像、アダプティブ コンテンツなどを指定します。The generic binding is the default binding for toasts, and is where you specify the text, images, adaptive content, and more.

プロパティProperty 種類Type 必須Required 説明Description
Children IList<IToastBindingGenericChild>IList<IToastBindingGenericChild> falsefalse トーストの本文のコンテンツです。テキスト、画像、および (Anniversary Update で追加された) グループを含めることができます。The contents of the body of the Toast, which can include text, images, and groups (added in Anniversary Update). テキスト要素は他の要素よりも上に表示される必要があります。サポートされるテキスト要素は 3 つのみです。Text elements must come before any other elements, and only 3 text elements are supported. テキスト要素が他の要素の後ろに配置されると、最上位にされるか、削除されます。If a text element is placed after any other element, it will either be pulled to the top or dropped. また、HintStyle などの特定のテキスト プロパティは、ルートの子テキスト要素ではサポートされず AdaptiveSubgroup 内でのみ機能します。And finally, certain text properties like HintStyle aren't supported on the root children text elements, and only work inside an AdaptiveSubgroup. Anniversary Update を行っていないデバイスで AdaptiveGroup を使用する場合、グループのコンテンツは単に削除されます。If you use AdaptiveGroup on devices without the Anniversary Update, the group content will simply be dropped.
AppLogoOverrideAppLogoOverride ToastGenericAppLogoToastGenericAppLogo falsefalse アプリ ロゴを上書きするロゴです (省略可能)。An optional logo to override the app logo.
HeroImageHeroImage ToastGenericHeroImageToastGenericHeroImage falsefalse トーストとアクション センターで表示される、特色となるヒーロー画像です (省略可能)。An optional featured "hero" image that is displayed on the toast and within Action Center.
属性Attribution ToastGenericAttributionTextToastGenericAttributionText falsefalse トースト通知の下部に表示される属性のテキストです (省略可能)。Optional attribution text which will be displayed at the bottom of the toast notification.
BaseUriBaseUri UriUri falsefalse 画像ソースの属性において相対 URL と組み合わされる、既定のベース URL です。A default base URL that is combined with relative URLs in image source attributes.
AddImageQueryAddImageQuery bool?bool? falsefalse true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。Set to "true" to allow Windows to append a query string to the image URL supplied in the toast notification. この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. このクエリ文字列は、スケール、コントラスト設定、および言語を指定するものです。たとえば、通知で指定されている値 "www.website.com/images/hello.png" は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" になります。This query string specifies scale, contrast setting, and language; for instance, a value of "www.website.com/images/hello.png" given in the notification becomes "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us"
言語Language stringstring falsefalse ローカライズされたリソースを使用する際の視覚的なペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。The target locale of the visual payload when using localized resources, specified as BCP-47 language tags such as "en-US" or "fr-FR". このロケールは、バインディングかテキストで指定されるあらゆるロケールによって上書きされます。This locale is overridden by any locale specified in binding or text. 未指定の場合は、システム ロケールが代わりに使用されます。If not provided, the system locale will be used instead.

IToastBindingGenericChildIToastBindingGenericChild

テキスト、画像、グループなどを含むトーストの子要素のマーカー インターフェイスです。Marker interface for toast child elements that include text, images, groups, and more.

実装Implementations
AdaptiveTextAdaptiveText
AdaptiveImageAdaptiveImage
AdaptiveGroupAdaptiveGroup
AdaptiveProgressBarAdaptiveProgressBar

AdaptiveTextAdaptiveText

アダプティブなテキスト要素です。An adaptive text element. 最上位の ToastBindingGeneric.Children に配置すると HintMaxLines のみが適用されます。If placed in the top level ToastBindingGeneric.Children, only HintMaxLines will be applied. ただし、グループ/サブグループの子として配置される場合、フル テキストのスタイル設定がサポートされます。But if this is placed as a child of a group/subgroup, full text styling is supported.

プロパティProperty 種類Type 必須Required 説明Description
TextText string または BindableStringstring or BindableString falsefalse 表示するテキストです。The text to display. Creators Update で追加されたデータ バインディングのサポートは、最上位のテキスト要素に対してのみ機能します。Data binding support added in Creators Update, but only works for top-level text elements.
HintStyleHintStyle AdaptiveTextStyleAdaptiveTextStyle falsefalse このスタイルは、テキストのフォント サイズ、太さ、および不透明度を制御します。The style controls the text's font size, weight, and opacity. グループ/サブグループ内のテキスト要素に対してのみ機能します。Only works for text elements inside a group/subgroup.
HintWrapHintWrap bool?bool? falsefalse true に設定すると、テキストの折り返しが有効になります。Set this to true to enable text wrapping. 最上位のテキスト要素はこのプロパティを無視し、常に折り返します (最上位のテキスト要素の折り返しを無効にするには HintMaxLines = 1 を使用します)。Top-level text elements ignore this property and always wrap (you can use HintMaxLines = 1 to disable wrapping for top-level text elements). グループ/サブグループ内のテキスト要素では、折り返しは既定で false に設定されています。Text elements inside groups/subgroups default to false for wrapping.
HintMaxLinesHintMaxLines int?int? falsefalse 表示が許可される、テキスト要素の最大行数です。The maximum number of lines the text element is allowed to display.
HintMinLinesHintMinLines int?int? falsefalse 表示する必要のある、テキスト要素の最小行数です。The minimum number of lines the text element must display. グループ/サブグループ内のテキスト要素に対してのみ機能します。Only works for text elements inside a group/subgroup.
HintAlignHintAlign AdaptiveTextAlignAdaptiveTextAlign falsefalse テキストの水平方向の配置です。The horizontal alignment of the text. グループ/サブグループ内のテキスト要素に対してのみ機能します。Only works for text elements inside a group/subgroup.
言語Language stringstring falsefalse XML ペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". ここで指定されたロケールは、バインディングか視覚的な要素で指定されたその他のあらゆるロケールを上書きします。The locale specified here overrides any other specified locale, such as that in binding or visual. この値がリテラル文字列の場合、この属性の既定値はユーザーの UI 言語になります。If this value is a literal string, this attribute defaults to the user's UI language. この値が文字列リファレンスの場合、この属性の既定値は、文字列を解決する際に Windows ランタイムで選択されたロケールになります。If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.

BindableStringBindableString

文字列のバインディング値です。A binding value for strings.

プロパティProperty 種類Type 必須Required 説明Description
BindingNameBindingName stringstring truetrue バインディング データ値に対してマップする名前を取得または設定します。Gets or sets the name that maps to your binding data value.

AdaptiveTextStyleAdaptiveTextStyle

テキスト スタイルは、フォント サイズ、太さ、および不透明度を制御します。Text style controls font size, weight, and opacity. "Subtle" の不透明度は 60% の不透明度になります。Subtle opacity is 60% opaque.

ValueValue 説明Meaning
DefaultDefault 既定値です。Default value. スタイルがレンダラーによって決定されます。Style is determined by the renderer.
キャプションCaption 段落のフォント サイズより小さいサイズです。Smaller than paragraph font size.
CaptionSubtleCaptionSubtle Caption と同じですが、不透明度が Subtle です。Same as Caption but with subtle opacity.
本文Body 段落本文のフォント サイズです。Paragraph font size.
BodySubtleBodySubtle Body と同じですが、不透明度が Subtle です。Same as Body but with subtle opacity.
ベースBase 段落本文のフォント サイズで、太字です。Paragraph font size, bold weight. 基本的には、Body の太字バージョンと言えます。Essentially the bold version of Body.
BaseSubtleBaseSubtle Base と同じですが、不透明度が Subtle です。Same as Base but with subtle opacity.
サブタイトルSubtitle H4 のフォント サイズです。H4 font size.
SubtitleSubtleSubtitleSubtle Subtitle と同じですが、不透明度が Subtle です。Same as Subtitle but with subtle opacity.
TitleTitle H3 のフォント サイズです。H3 font size.
TitleSubtleTitleSubtle Title と同じですが、不透明度が Subtle です。Same as Title but with subtle opacity.
TitleNumeralTitleNumeral Title と同じですが、上/下のパディングが削除されます。Same as Title but with top/bottom padding removed.
サブヘッダーSubheader H2 のフォント サイズです。H2 font size.
SubheaderSubtleSubheaderSubtle Subheader と同じですが、不透明度が Subtle です。Same as Subheader but with subtle opacity.
SubheaderNumeralSubheaderNumeral Subheader と同じですが、上/下のパディングが削除されます。Same as Subheader but with top/bottom padding removed.
ヘッダーHeader H1 のフォント サイズです。H1 font size.
HeaderSubtleHeaderSubtle Header と同じですが、不透明度が Subtle です。Same as Header but with subtle opacity.
HeaderNumeralHeaderNumeral Header と同じですが、上/下のパディングが削除されます。Same as Header but with top/bottom padding removed.

AdaptiveTextAlignAdaptiveTextAlign

テキストの水平方向の配置を制御します。Controls the horizontal alignmen of text.

ValueValue 説明Meaning
DefaultDefault 既定値です。Default value. 配置がレンダラーによって自動的に決定されます。Alignment is automatically determined by the renderer.
自動Auto 配置が現在の言語とカルチャによって決定されます。Alignment determined by the current language and culture.
Left テキストを左側に水平方向に配置します。Horizontally align the text to the left.
CenterCenter テキストを中央に水平方向に配置します。Horizontally align the text in the center.
そうですRight テキストを右側に水平方向に配置します。Horizontally align the text to the right.

AdaptiveImageAdaptiveImage

インライン画像です。An inline image.

プロパティProperty 種類Type 必須Required 説明Description
ソースSource stringstring truetrue 画像への URL です。The URL to the image. ms-appx、ms-appdata、および http がサポートされます。ms-appx, ms-appdata, and http are supported. Fall Creators Update の時点で、Web 画像の上限は通常の接続で 3 MB、従量制課金接続で 1 MB です。As of the Fall Creators Update, web images can be up to 3 MB on normal connections and 1 MB on metered connections. まだ Fall Creators Update を実行していないデバイスでは、Web イメージは 200 KB を上限とします。On devices not yet running the Fall Creators Update, web images must be no larger than 200 KB.
HintCropHintCrop AdaptiveImageCropAdaptiveImageCrop falsefalse Anniversary Update: 新機能必要な画像トリミングを制御します。New in Anniversary Update: Control the desired cropping of the image.
HintRemoveMarginHintRemoveMargin bool?bool? falsefalse 既定では、グループ/サブグループ内の画像には周囲に 8 ピクセルの余白があります。By default, images inside groups/subgroups have an 8px margin around them. このプロパティを true に設定することで余白を削除できます。You can remove this margin by setting this property to true.
HintAlignHintAlign AdaptiveImageAlignAdaptiveImageAlign falsefalse 画像の水平方向の配置です。The horizontal alignment of the image. グループ/サブグループ内の画像に対してのみ機能します。Only works for images inside a group/subgroup.
AlternateTextAlternateText stringstring falsefalse アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。Alternate text describing the image, used for accessibility purposes.
AddImageQueryAddImageQuery bool?bool? falsefalse true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。Set to "true" to allow Windows to append a query string to the image URL supplied in the toast notification. この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. このクエリ文字列は、スケール、コントラスト設定、および言語を指定するものです。たとえば、通知で指定されている値 "www.website.com/images/hello.png" は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" になります。This query string specifies scale, contrast setting, and language; for instance, a value of "www.website.com/images/hello.png" given in the notification becomes "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us"

AdaptiveImageCropAdaptiveImageCrop

必要な画像トリミングを指定します。Specifies the desired cropping of the image.

ValueValue 説明Meaning
DefaultDefault 既定値です。Default value. トリミングの動作がレンダラーによって決定されます。Cropping behavior determined by renderer.
NoneNone 画像がトリミングされません。Image is not cropped.
Circle 画像が円形にトリミングされます。Image is cropped to a circle shape.

AdaptiveImageAlignAdaptiveImageAlign

画像の水平方向の配置を指定します。Specifies the horizontal alignment for an image.

ValueValue 説明Meaning
DefaultDefault 既定値です。Default value. 配置の動作がレンダラーによって決定されます。Alignment behavior determined by renderer.
StretchStretch 利用可能な幅いっぱいに画像が拡大されます (また同時に、画像が配置される位置に応じて、利用可能な高さいっぱいに拡大されることもあります)。Image stretches to fill available width (and potentially available height too, depending on where the image is placed).
Left 画像を左側に配置し、ネイディブの解像度で表示します。Align the image to the left, displaying the image at its native resolution.
CenterCenter 画像を中央に水平方向に配置し、ネイティブの解像度で表示します。Align the image in the center horizontally, displayign the image at its native resolution.
そうですRight 画像を右側に配置し、ネイディブの解像度で表示します。Align the image to the right, displaying the image at its native resolution.

AdaptiveGroupAdaptiveGroup

Anniversary Update: 新機能グループは、グループ内のコンテンツについて、全体を表示すべきか、収まりきらない場合は全体を表示すべきでないかを意味的に識別します。New in Anniversary Update: Groups semantically identify that the content in the group must either be displayed as a whole, or not displayed if it cannot fit. 複数の列を作成することも可能にします。Groups also allow creating multiple columns.

プロパティProperty 種類Type 必須Required 説明Description
Children IList<AdaptiveSubgroup>IList<AdaptiveSubgroup> falsefalse サブグループが垂直方向の列として表示されます。Subgroups are displayed as vertical columns. AdaptiveGroup 内の任意のコンテンツを提供するにはサブグループを使用する必要があります。You must use subgroups to provide any content inside an AdaptiveGroup.

AdaptiveSubgroupAdaptiveSubgroup

Anniversary Update: 新機能サブグループは垂直方向の列で、テキストと画像を含めることができます。New in Anniversary Update: Subgroups are vertical columns that can contain text and images.

プロパティProperty 種類Type 必須Required 説明Description
Children IList<IAdaptiveSubgroupChild>IList<IAdaptiveSubgroupChild> falsefalse AdaptiveTextAdaptiveImage は、サブグループの有効な子です。AdaptiveText and AdaptiveImage are valid children of subgroups.
HintWeightHintWeight int?int? falsefalse 別のサブグループを基準として太さを指定することで、このサブグループの列の幅を制御します。Control the width of this subgroup column by specifying the weight, relative to the other subgroups.
HintTextStackingHintTextStacking AdaptiveSubgroupTextStackingAdaptiveSubgroupTextStacking falsefalse このサブグループのコンテンツの垂直方向の配置を制御します。Control the vertical alignment of this subgroup's content.

IAdaptiveSubgroupChildIAdaptiveSubgroupChild

サブグループの子のマーカー インターフェイスです。Marker interface for subgroup children.

実装Implementations
AdaptiveTextAdaptiveText
AdaptiveImageAdaptiveImage

AdaptiveSubgroupTextStackingAdaptiveSubgroupTextStacking

TextStacking は、コンテンツの垂直方向の配置を指定します。TextStacking specifies the vertical alignment of content.

ValueValue 説明Meaning
DefaultDefault 既定値です。Default value. レンダラーが既定の垂直方向の配置を自動的に選択します。Renderer automatically selects the default vertical alignment.
ページのトップへTop 上に合わせて垂直に配置されます。Vertical align to the top.
CenterCenter 中央に合わせて垂直に配置されます。Vertical align to the center.
下部にあります。Bottom 下に合わせて垂直に配置されます。Vertical align to the bottom.

AdaptiveProgressBarAdaptiveProgressBar

Creators Update: 新機能進行状況バー。New in Creators Update: A progress bar. デスクトップ版、ビルド 15063 以降のトースト通知でのみサポートされます。Only supported on toasts on Desktop, build 15063 or newer.

プロパティProperty 種類Type 必須Required 説明Description
TitleTitle string または BindableStringstring or BindableString falsefalse タイトルの文字列 (オプション) を取得または設定します。Gets or sets an optional title string. データ バインディングをサポートしています。Supports data binding.
Value double または AdaptiveProgressBarValueBindableProgressBarValuedouble or AdaptiveProgressBarValue or BindableProgressBarValue falsefalse 進行状況バーの値を取得または設定します。Gets or sets the value of the progress bar. データ バインディングをサポートしています。Supports data binding. 既定値は 0 です。Defaults to 0.
ValueStringOverrideValueStringOverride string または BindableStringstring or BindableString falsefalse 割合を示す既定の文字列に代わって表示される文字列 (オプション) を取得または設定します。Gets or sets an optional string to be displayed instead of the default percentage string. これを指定しない場合は、"70%" などの文字が表示されます。If this isn't provided, something like "70%" will be displayed.
状態Status string または BindableStringstring or BindableString truetrue 進行状況バーの下の左側に表示されるステータス文字列 (必須) を取得または設定します。Gets or sets a status string (required), which is displayed underneath the progress bar on the left. この文字列は、"ダウンロード中..." や "インストール中..." などのように、操作の状態を反映する必要があります。This string should reflect the status of the operation, like "Downloading..." or "Installing..."

AdaptiveProgressBarValueAdaptiveProgressBarValue

進行状況バーの値を表すクラスです。A class that represents the progress bar's value.

プロパティProperty 種類Type 必須Required 説明Description
Value doubledouble falsefalse 完了率を表す値 (0.0 ~ 1.0) を取得または設定します。Gets or sets the value (0.0 - 1.0) representing the percent complete.
IsIndeterminateIsIndeterminate boolbool falsefalse 進行状況バーが不確定型かどうかを示す値を取得または設定します。Gets or sets a value indicating whether the progress bar is indeterminate. true の場合、Value は無視されます。If this is true, Value will be ignored.

BindableProgressBarValueBindableProgressBarValue

バインディング可能な進行状況バーの値。A bindable progress bar value.

プロパティProperty 種類Type 必須Required 説明Description
BindingNameBindingName stringstring truetrue バインディング データ値に対してマップする名前を取得または設定します。Gets or sets the name that maps to your binding data value.

アプリ ロゴの代わりに表示されるロゴです。A logo to be displayed instead of the app logo.

プロパティProperty 種類Type 必須Required 説明Description
ソースSource stringstring truetrue 画像への URL です。The URL to the image. ms-appx、ms-appdata、および http がサポートされます。ms-appx, ms-appdata, and http are supported. http の画像は、サイズを 200 KB 以下にする必要があります。Http images must be 200 KB or less in size.
HintCropHintCrop ToastGenericAppLogoCropToastGenericAppLogoCrop falsefalse 画像をトリミングする方法を指定します。Specify how you would like the image to be cropped.
AlternateTextAlternateText stringstring falsefalse アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。Alternate text describing the image, used for accessibility purposes.
AddImageQueryAddImageQuery bool?bool? falsefalse true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。Set to "true" to allow Windows to append a query string to the image URL supplied in the toast notification. この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. このクエリ文字列は、スケール、コントラスト設定、および言語を指定するものです。たとえば、通知で指定されている値 "www.website.com/images/hello.png" は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" になります。This query string specifies scale, contrast setting, and language; for instance, a value of "www.website.com/images/hello.png" given in the notification becomes "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us"

ToastGenericAppLogoCropToastGenericAppLogoCrop

アプリ ロゴの画像のトリミングを制御します。Controls the cropping of the app logo image.

ValueValue 説明Meaning
DefaultDefault トリミングがレンダラーの既定の動作を使用します。Cropping uses the default behavior of the renderer.
NoneNone 画像がトリミングされず、正方形で表示されます。Image is not cropped, displayed square.
Circle 画像が円形にトリミングされます。Image is cropped to a circle.

ToastGenericHeroImageToastGenericHeroImage

トーストとアクション センターで表示される、特色となるヒーロー画像です。A featured "hero" image that is displayed on the toast and within Action Center.

プロパティProperty 種類Type 必須Required 説明Description
ソースSource stringstring truetrue 画像への URL です。The URL to the image. ms-appx、ms-appdata、および http がサポートされます。ms-appx, ms-appdata, and http are supported. http の画像は、サイズを 200 KB 以下にする必要があります。Http images must be 200 KB or less in size.
AlternateTextAlternateText stringstring falsefalse アクセシビリティ対応目的で使用される、画像を説明する代替テキストです。Alternate text describing the image, used for accessibility purposes.
AddImageQueryAddImageQuery bool?bool? falsefalse true に設定すると、トースト通知で指定された画像 URL に Windows がクエリ文字列を追加できるようになります。Set to "true" to allow Windows to append a query string to the image URL supplied in the toast notification. この属性は、サーバーが画像をホストしていてクエリ文字列を処理できる場合に使用します。サーバーがこのために、クエリ文字列に基づいて画像の変化形を取得しているか、またはクエリ文字列を無視して使わずに指定の画像を返しているかどうかは問いません。Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. このクエリ文字列は、スケール、コントラスト設定、および言語を指定するものです。たとえば、通知で指定されている値 "www.website.com/images/hello.png" は "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us" になります。This query string specifies scale, contrast setting, and language; for instance, a value of "www.website.com/images/hello.png" given in the notification becomes "www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us"

ToastGenericAttributionTextToastGenericAttributionText

トースト通知の下部に表示される属性のテキストです。Attribution text displayed at the bottom of the toast notification.

プロパティProperty 種類Type 必須Required 説明Description
TextText stringstring truetrue 表示するテキストです。The text to display.
言語Language stringstring falsefalse ローカライズされたリソースを使用する際の視覚的なペイロードの対象ロケールです。"en-US" や "fr-FR" のように BCP-47 言語タグとして指定されます。The target locale of the visual payload when using localized resources, specified as BCP-47 language tags such as "en-US" or "fr-FR". 未指定の場合は、システム ロケールが代わりに使用されます。If not provided, the system locale will be used instead.

IToastActionsIToastActions

トーストの操作/入力のマーカー インターフェイスです。Marker interface for toast actions/inputs.

実装Implementations
ToastActionsCustomToastActionsCustom
ToastActionsSnoozeAndDismissToastActionsSnoozeAndDismiss

ToastActionsCustomToastActionsCustom

実装IToastActionsImplements IToastActions

ボタン、テキスト ボックス、選択入力などのコントロールを使用して、カスタムの操作や入力を独自に作成します。Create your own custom actions and inputs, using controls like buttons, text boxes, and selection inputs.

プロパティProperty 種類Type 必須Required 説明Description
入力Inputs IList<IToastInput>IList<IToastInput> falsefalse テキスト ボックスや選択入力などの入力です。Inputs like text boxes and selection inputs. 最大 5 つの入力が許可されます。Only up to 5 inputs are allowed.
ボタンButtons IList<IToastButton>IList<IToastButton> falsefalse ボタンが、すべての入力の後ろに表示されます (または、ボタンがクイック返信ボタンとして使用されている場合は入力の隣に表示されます)。Buttons are displayed after all the inputs (or adjacent to an input if the button is used as a quick reply button). 最大 5 つのボタンが許可されます (コンテキスト メニュー項目もある場合はこれより少なくなります)。Only up to 5 buttons are allowed (or fewer if you also have context menu items).
ContextMenuItemsContextMenuItems IList<ToastContextMenuItem>IList<ToastContextMenuItem> falsefalse Anniversary Update: 新機能カスタム コンテキスト メニュー項目、ユーザーには、通知、右クリックした場合、その他のアクションを提供します。New in Anniversary Update: Custom context menu items, providing additional actions if the user right clicks the notification. ボタンとコンテキスト メニュー項目の数は、最大で合わせて 5 つに制限されます。You can only have up to 5 buttons and context menu items combined.

IToastInputIToastInput

トーストの入力のマーカー インターフェイスです。Marker interface for toast inputs.

実装Implementations
ToastTextBoxToastTextBox
ToastSelectionBoxToastSelectionBox

ToastTextBoxToastTextBox

実装IToastInputImplements IToastInput

ユーザーがテキストを入力できるテキスト ボックス コントロールです。A text box control that the user can type text into.

プロパティProperty 種類Type 必須Required 説明Description
IdId stringstring truetrue この Id は必須です。ユーザーが入力したテキストを、アプリが後に使用するキー/値のペアである id/値にマップします。The Id is required, and is used to map the user-inputted text into a key-value pair of id/value which your app later consumes.
TitleTitle stringstring falsefalse テキスト ボックスの上部に表示されるタイトル テキストです。Title text to display above the text box.
PlaceholderContentPlaceholderContent stringstring falsefalse ユーザーがまだテキストを入力していない場合にテキスト ボックスに表示されるプレースホルダー テキストです。Placeholder text to be displayed on the text box when the user hasn't typed any text yet.
DefaultInputDefaultInput stringstring falsefalse テキスト ボックスに配置される最初のテキストです。The initial text to place in the text box. テキスト ボックスを空白にするには null のままにします。Leave this null for a blank text box.

ToastSelectionBoxToastSelectionBox

実装IToastInputImplements IToastInput

ユーザーがドロップダウン リストから選択できるようにする、選択ボックス コントロールです。A selection box control, which lets users pick from a dropdown list of options.

プロパティProperty 種類Type 必須Required 説明Description
IdId stringstring truetrue この Id は必須です。The Id is required. ユーザーがこの項目を選択すると、この Id がアプリのコードに戻されて、ユーザーが選択したものを表します。If the user selected this item, this Id will be passed back to your app's code, representing which selection they chose.
コンテンツContent stringstring truetrue Content は必須です。選択項目に表示される文字列です。Content is required, and is a string that is displayed on the selection item.

ToastSelectionBoxItemToastSelectionBoxItem

選択ボックス項目 (ユーザーがドロップダウン リストから選択できる項目) です。A selection box item (an item that the user can select from the drop down list).

プロパティProperty 種類Type 必須Required 説明Description
IdId stringstring truetrue この Id は必須です。ユーザーが入力したテキストを、アプリが後に使用するキー/値のペアである id/値にマップします。The Id is required, and is used to map the user-inputted text into a key-value pair of id/value which your app later consumes.
TitleTitle stringstring falsefalse 選択ボックスの上部に表示されるタイトル テキストです。Title text to display above the selection box.
DefaultSelectionBoxItemIdDefaultSelectionBoxItemId stringstring falsefalse 既定で選択される項目を制御し、ToastSelectionBoxItem の Id プロパティを参照します。This controls which item is selected by default, and refers to the Id property of the ToastSelectionBoxItem. 未指定の場合、既定の選択が空になります (ユーザーに何も表示されません)。If you do not provide this, the default selection will be empty (user sees nothing).
項目Items IList<ToastSelectionBoxItem>IList<ToastSelectionBoxItem> falsefalse この SelectionBox からユーザーが選択できる選択項目です。The selection items that the user can pick from in this SelectionBox. 追加できる項目数は 5 個のみです。Only 5 items can be added.

IToastButtonIToastButton

トースト ボタンのマーカー インターフェイスです。Marker interface for toast buttons.

実装Implementations
ToastButtonToastButton
ToastButtonSnoozeToastButtonSnooze
ToastButtonDismissToastButtonDismiss

ToastButtonToastButton

実装IToastButtonImplements IToastButton

ユーザーがクリックするボタンです。A button that the user can click.

プロパティProperty 種類Type 必須Required 説明Description
コンテンツContent stringstring truetrue 必須。Required. ボタンに表示されるテキストです。The text to display on the button.
引数Arguments stringstring truetrue 必須。Required. ユーザーがこのボタンをクリックした場合にアプリが後から受け取る、アプリで定義された引数の文字列です。App-defined string of arguments that the app will later receive if the user clicks this button.
ActivationTypeActivationType ToastActivationTypeToastActivationType falsefalse ユーザーがクリックしたときにこのボタンが使用するアクティブ化の種類を制御します。Controls what type of activation this button will use when clicked. 既定では Foreground に設定されます。Defaults to Foreground.
ActivationOptionsActivationOptions ToastActivationOptionsToastActivationOptions falsefalse Creators Update: 新機能取得またはトースト ボタンのアクティブ化に関連する追加のオプションを設定します。New in Creators Update: Gets or sets additional options relating to activation of the toast button.

ToastActivationTypeToastActivationType

ユーザーが特定の操作を行った際に使用されるアクティブ化の種類を決定します。Decides the type of activation that will be used when the user interacts with a specific action.

ValueValue 説明Meaning
フォア グラウンドForeground 既定値です。Default value. フォアグラウンド アプリが起動します。Your foreground app is launched.
背景情報Background (すべての設定が完了したと想定して) 対応するバックグラウンド タスクがトリガーされ、ユーザーの作業を中断することなくバックグラウンドでコードを実行できます (ユーザーのクイック返信メッセージの送信など)。Your corresponding background task (assuming you set everything up) is triggered, and you can execute code in the background (like sending the user's quick reply message) without interrupting the user.
[プロトコル]Protocol プロトコルのアクティブ化を使用して別のアプリを起動します。Launch a different app using protocol activation.

ToastActivationOptionsToastActivationOptions

Creators Update: 新機能アクティブ化に関連する追加オプション。New in Creators Update: Additional options relating to activation.

プロパティProperty 種類Type 必須Required 説明Description
AfterActivationBehaviorAfterActivationBehavior ToastAfterActivationBehaviorToastAfterActivationBehavior falsefalse Fall Creators Update:取得または設定、動作、ユーザーがこの操作を呼び出すと、トーストを使用する必要があります。New in Fall Creators Update: Gets or sets the behavior that the toast should use when the user invokes this action. デスクトップで、ToastButtonToastContextMenuItem についてのみ機能します。This only works on Desktop, for ToastButton and ToastContextMenuItem.
ProtocolActivationTargetApplicationPfnProtocolActivationTargetApplicationPfn stringstring falsefalse ToastActivationType.Protocol を使用している場合、対象の PFN を指定することもできます。こうすると、複数のアプリが同じプロトコル URI を処理するように登録されているかどうかに関係なく、常に目的のアプリが起動します。If you are using ToastActivationType.Protocol, you can optionally specify the target PFN, so that regardless of whether multiple apps are registered to handle the same protocol uri, your desired app will always be launched.

ToastAfterActivationBehaviorToastAfterActivationBehavior

ユーザーがトーストに対して操作を行ったときに、トーストが使用する動作を指定します。Specifies the behavior that the toast should use when the user takes action on the toast.

ValueValue 説明Meaning
DefaultDefault 既定の動作。Default behavior. ユーザーがトーストに対して操作を行うと、トーストが無視されます。The toast will be dismissed when the user takes action on the toast.
PendingUpdatePendingUpdate ユーザーがトースト上のボタンをクリックすると、通知が "更新の保留中" の表示状態で表示されたままになります。After the user clicks a button on your toast, the notification will remain present, in a "pending update" visual state. この "更新の保留中" の表示状態が長時間続くことを避けるため、バックグラウンド タスクから即座にトーストを更新する必要があります。You should immediately update your toast from a background task so that the user does not see this "pending update" visual state for too long.

ToastButtonSnoozeToastButtonSnooze

実装IToastButtonImplements IToastButton

システムによって処理される "再通知" ボタンです。通知の再通知を自動的に処理します。A system-handled snooze button that automatically handles snoozing of the notification.

プロパティProperty 種類Type 必須Required 説明Description
CustomContentCustomContent stringstring falsefalse ボタンに表示される、省略可能なカスタム テキストです。既定のローカライズされた "再通知" テキストを上書きします。Optional custom text displayed on the button that overrides the default localized "Snooze" text.

ToastButtonDismissToastButtonDismiss

実装IToastButtonImplements IToastButton

システムによって処理される "無視" ボタンです。クリックすると通知が閉じます。A system-handled dismiss button that dismisses the notification when clicked.

プロパティProperty 種類Type 必須Required 説明Description
CustomContentCustomContent stringstring falsefalse ボタンに表示される、省略可能なカスタム テキストです。既定のローカライズされた "無視" テキストを上書きします。Optional custom text displayed on the button that overrides the default localized "Dismiss" text.

ToastActionsSnoozeAndDismissToastActionsSnoozeAndDismiss

*Implements IToastActions*Implements IToastActions

再通知の間隔を選択するボックスが自動的に作成されます。また、[snooze] (一時停止する) /[dismiss] (無視) ボタンがすべて自動的にローカライズされます。さらに、再通知ロジックがシステムによって自動的に処理されます。Automatically constructs a selection box for snooze intervals, and snooze/dismiss buttons, all automatically localized, and snoozing logic is automatically handled by the system.

プロパティProperty 種類Type 必須Required 説明Description
ContextMenuItemsContextMenuItems IList<ToastContextMenuItem>IList<ToastContextMenuItem> falsefalse Anniversary Update: 新機能カスタム コンテキスト メニュー項目、ユーザーには、通知、右クリックした場合、その他のアクションを提供します。New in Anniversary Update: Custom context menu items, providing additional actions if the user right clicks the notification. 項目の数は最大 5 つに制限されます。You can only have up to 5 items.

ToastContextMenuItemToastContextMenuItem

コンテキスト メニュー項目のエントリです。A context menu item entry.

プロパティProperty 種類Type 必須Required 説明Description
コンテンツContent stringstring truetrue 必須。Required. 表示するテキストです。The text to display.
引数Arguments stringstring truetrue 必須。Required. アプリで定義された引数の文字列です。ユーザーがメニュー項目をクリックしたときにアクティブ化されたら、アプリが後から取得することが可能になります。App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the menu item.
ActivationTypeActivationType ToastActivationTypeToastActivationType falsefalse ユーザーがクリックしたときにこのメニュー項目が使用するアクティブ化の種類を制御します。Controls what type of activation this menu item will use when clicked. 既定では Foreground に設定されます。Defaults to Foreground.
ActivationOptionsActivationOptions ToastActivationOptionsToastActivationOptions falsefalse Creators Update: 新機能トーストのコンテキスト メニュー項目のアクティブ化に関連する追加オプション。New in Creators Update: Additional options relating to activation of the toast context menu item.

ToastAudioToastAudio

トースト通知を受け取ったときに再生するオーディオを指定します。Specify audio to be played when the Toast notification is received.

プロパティProperty 種類Type 必須Required 説明Description
srcSrc uriuri falsefalse 既定のサウンドの代わりに再生するメディア ファイルです。The media file to play in place of the default sound. ms-appx と ms-appdata のみがサポートされます。Only ms-appx and ms-appdata are supported.
ループLoop booleanboolean falsefalse トーストが表示されている間サウンドを繰り返す必要がある場合は true に、一度だけ再生する場合 (既定) は false に設定します。Set to true if the sound should repeat as long as the Toast is shown; false to play only once (default).
サイレントSilent booleanboolean falsefalse true に設定するとサウンドがミュートされ、false に設定するとトースト通知のサウンドが再生されます (既定)。True to mute the sound; false to allow the toast notification sound to play (default).

ToastHeaderToastHeader

Creators Update: 新機能アクション センターで複数の通知をグループ化するカスタム ヘッダーです。New in Creators Update: A custom header that groups multiple notifications together within Action Center.

プロパティProperty 種類Type 必須Required 説明Description
IdId stringstring truetrue 開発者が作成した識別子です。このヘッダーを一意に識別します。A developer-created identifier that uniquely identifies this header. 2 つの通知が同じヘッダー ID を持つ場合、アクション センターで同じヘッダーの下に表示されます。If two notifications have the same header id, they will be displayed underneath the same header in Action Center.
TitleTitle stringstring truetrue ヘッダーのタイトルです。A title for the header.
引数Arguments stringstring truetrue ユーザーがこのヘッダーをクリックすると、アプリに返された引数の開発者によって定義された文字列を取得または設定します。Gets or sets a developer-defined string of arguments that is returned to the app when the user clicks this header. null にすることはできません。Cannot be null.
ActivationTypeActivationType ToastActivationTypeToastActivationType falsefalse ユーザーがクリックしたときにこのヘッダーが使用するアクティブ化の種類を取得または設定します。Gets or sets the type of activation this header will use when clicked. 既定では Foreground に設定されます。Defaults to Foreground. サポートされる値は、Foreground と Protocol のみです。Note that only Foreground and Protocol are supported.
ActivationOptionsActivationOptions ToastActivationOptionsToastActivationOptions falsefalse トースト ヘッダーのアクティブ化に関する追加オプションを取得または設定します。Gets or sets additional options relating to activation of the toast header.