磚內容結構描述

以下說明磚內容中的所有屬性和元素。

如果您想要使用原始 XML 而非通知程式庫,請參閱 XML 結構描述

TileContent

TileContent

TileContent 是描述磚通知內容的最上層物件,包括視覺效果。

屬性 型別 必要 描述
視覺效果 ToastVisual true 描述磚通知的視覺效果部分。

TileVisual

磚的視覺效果部分包含所有磚大小的視覺效果規格,以及更多視覺效果相關屬性。

屬性 型別 必要 描述
TileSmall TileBinding false 提供選用的小型繫結,用來指定小型磚大小的內容。
TileMedium TileBinding false 提供選用的中型繫結,用來指定中型磚大小的內容。
TileWide TileBinding false 提供選用的寬版繫結,用來指定寬版磚大小的內容。
TileLarge TileBinding false 提供選用的大型繫結,用來指定大型磚大小的內容。
商標 TileBranding false 磚應用來顯示應用程式品牌的形式。 預設為繼承預設磚的商標。
DisplayName string false 顯示此通知時,用來覆寫磚的顯示名稱的選用字串。
引數 string false 年度更新版的新功能:當使用者從動態磚啟動您的應用程式時,透過 LaunchActivatedEventArgs 上的 TileActivatedInfo 屬性傳回您的應用程式的應用程式定義資料。 此資訊可讓您得知,您的使用者點選您的動態磚時看過哪些磚通知。 在沒有年度更新版的裝置上,則會直接忽略此資訊。
LockDetailedStatus1 string false 如果您指定此項,也必須提供 TileWide 繫結。 如果使用者選取了您的磚做為其詳細狀態應用程式,則這會是鎖定畫面上所顯示的第一行文字。
LockDetailedStatus2 string false 如果您指定此項,也必須提供 TileWide 繫結。 如果使用者選取了您的磚做為其詳細狀態應用程式,則這會是鎖定畫面上所顯示的第二行文字。
LockDetailedStatus3 string false 如果您指定此項,也必須提供 TileWide 繫結。 如果使用者選取了您的磚做為其詳細狀態應用程式,則這會是鎖定畫面上所顯示的第三行文字。
BaseUri URI false 預設基底 URL,會結合影像來源屬性中的相對 URL。
AddImageQuery bool? false 設定為「true」,表示允許 Windows 將查詢字串附加至快顯通知中提供的影像 URL。 如果您的伺服器裝載影像並且可以處理查詢字串,您可以根據查詢字串擷取影像變體,或忽略查詢字串並傳回指定的影像,但不包含查詢字串,透過這兩種方式之一使用此屬性。 此查詢字串會指定縮放比例、對比設定和語言;例如,通知中指定的「www.website.com/images/hello.png」值會變成「www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us」
語言 string false 使用當地語系化資源時,視覺效果承載的目標地區設定,會指定為 BCP-47 語言標記,例如 “en-US” 或 “fr-FR”。 此地區設定會被繫結或文字中指定的任何地區設定覆寫。 如果未提供,則會改用系統地區設定。

TileBinding

繫結物件包含特定磚大小的視覺效果內容。

屬性 型別 必要 描述
內容 ITileBindingContent false 在磚上顯示的視覺效果內容。 TileBindingContentAdaptiveTileBindingContentIconicTileBindingContentContactTileBindingContentPeopleTileBindingContentPhotos 其中之一。
商標 TileBranding false 磚應用來顯示應用程式品牌的形式。 預設為繼承預設磚的商標。
DisplayName string false 覆寫此磚大小的磚顯示名稱的選用字串。
引數 string false 年度更新版的新功能:當使用者從動態磚啟動您的應用程式時,透過 LaunchActivatedEventArgs 上的 TileActivatedInfo 屬性傳回您的應用程式的應用程式定義資料。 此資訊可讓您得知,您的使用者點選您的動態磚時看過哪些磚通知。 在沒有年度更新版的裝置上,則會直接忽略此資訊。
BaseUri URI false 預設基底 URL,會結合影像來源屬性中的相對 URL。
AddImageQuery bool? false 設定為「true」,表示允許 Windows 將查詢字串附加至快顯通知中提供的影像 URL。 如果您的伺服器裝載影像並且可以處理查詢字串,您可以根據查詢字串擷取影像變體,或忽略查詢字串並傳回指定的影像,但不包含查詢字串,透過這兩種方式之一使用此屬性。 此查詢字串會指定縮放比例、對比設定和語言;例如,通知中指定的「www.website.com/images/hello.png」值會變成「www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us」
語言 string false 使用當地語系化資源時,視覺效果承載的目標地區設定,會指定為 BCP-47 語言標記,例如 “en-US” 或 “fr-FR”。 此地區設定會被繫結或文字中指定的任何地區設定覆寫。 如果未提供,則會改用系統地區設定。

ITileBindingContent

磚繫結內容的標記介面。 這些可讓您選擇要在 - Adaptive 或其中一個特殊範本中指定的磚視覺效果內容。

實作
TileBindingContentAdaptive
TileBindingContentIconic
TileBindingContentContact
TileBindingContentPeople
TileBindingContentPhotos

TileBindingContentAdaptive

所有大小都支援。 這是指定磚內容的建議方式。 Windows 10 中新的彈性磚範本,您可以透過彈性建立各種不同的自訂磚。

屬性 型別 必要 描述
子系 IList<ITileBindingContentAdaptiveChild> false 內嵌視覺效果元素。 您可以新增 AdaptiveTextAdaptiveImageAdaptiveGroup 物件。 子系會以垂直 StackPanel 形式顯示。
BackgroundImage TileBackgroundImage false 選用的背景影像,會在所有磚內容後方顯示,並完全跨頁。
PeekImage TilePeekImage false 選用的預覽影像,會從磚頂端以動畫方式進場顯示。
TextStacking TileTextStacking false 控制整個子系內容的文字堆疊 (垂直對齊)。

AdaptiveText

彈性文字元素。

屬性 型別 必要 描述
文字 string false 要顯示的文字。
HintStyle AdaptiveTextStyle false 樣式可控制文字的字型大小、粗細和不透明度。
HintWrap bool? false 將此設定為 true,以啟用文字換行。 預設為 false。
HintMaxLines int? false 文字元素可顯示的行數上限。
HintMinLines int? false 文字元素必須顯示的行數下限。
HintAlign AdaptiveTextAlign false 文字的水平對齊方式。
語言 string false XML 承載的目標地區設定,會指定為 BCP-47 語言標記,例如 “en-US” 或 “fr-FR”。 此處指定的地區設定會覆寫任何其他指定的地區設定,例如繫結或視覺效果中的地區設定。 如果此值是常值字串,則此屬性會預設為使用者的 UI 語言。 如果此值是字串參考,則此屬性會預設為 Windows 執行階段解析字串時選擇的地區設定。

AdaptiveTextStyle

文字樣式會控制字型大小、粗細和不透明度。 淡色不透明度為 60% 不透明。

意義
Default 預設值。 樣式是由轉譯器決定。
標題 小於段落字型大小。
CaptionSubtle 與 Caption 相同,但帶有淡色不透明度。
本文 段落字型大小。
BodySubtle 與 Body 相同,但帶有淡色不透明度。
Base 段落字型大小,粗體粗細。 基本上是本文的粗體版本。
BaseSubtle 與 Base 相同,但帶有淡色不透明度。
Subtitle H4 字型大小。
SubtitleSubtle 與 Subtitle 相同,但帶有淡色不透明度。
職稱 H3 字型大小。
TitleSubtle 與 Title 相同,但帶有淡色不透明度。
TitleNumeral 與 Title 相同,但移除了上/下邊框間距。
Subheader H2 字型大小。
SubheaderSubtle 與 Subheader 相同,但帶有淡色不透明度。
SubheaderNumeral 與 Subheader 相同,但移除了上/下邊框間距。
頁首 H1 字型大小。
HeaderSubtle 與 Header 相同,但帶有淡色不透明度。
HeaderNumeral 與 Header 相同,但移除了上/下邊框間距。

AdaptiveTextAlign

控制文字的水平對齊方式。

意義
Default 預設值。 對齊方式會由轉譯器自動決定。
Auto 由目前語言和文化特性決定的對齊方式。
Left 水平靠左對齊文字。
Center 水平置中對齊文字。
Right 水平靠右對齊文字。

AdaptiveImage

內嵌影像。

屬性 型別 必要 描述
來源 string 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 根據預設,群組/子群組內的影像周圍會有 8px 的邊界。 您可以藉由將此屬性設定為 true 來移除此邊界。
HintAlign AdaptiveImageAlign false 影像的水平對齊方式。
AlternateText string false 描述影像的替代文字,用於輔助功能。
AddImageQuery bool? false 設定為「true」,表示允許 Windows 將查詢字串附加至磚通知中提供的影像 URL。 如果您的伺服器裝載影像並且可以處理查詢字串,您可以根據查詢字串擷取影像變體,或忽略查詢字串並傳回指定的影像,但不包含查詢字串,透過這兩種方式之一使用此屬性。 此查詢字串會指定縮放比例、對比設定和語言;例如,通知中指定的「www.website.com/images/hello.png」值會變成「www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us」

AdaptiveImageCrop

指定所需的影像裁剪。

意義
Default 預設值。 轉譯器決定的裁剪行為。
None 影像未裁剪。
圓圈 影像會裁剪成圓形。

AdaptiveImageAlign

指定影像的水準對齊方式。

意義
Default 預設值。 由轉譯器決定的對齊行為。
延展 影像會延伸以填滿可用寬度 (可能也會填滿可用高度,視影像放置的位置而定)。
Left 將影像靠左對齊,以原生解析度顯示影像。
Center 水平置中對齊影像,以原生解析度顯示影像。
Right 將影像靠右對齊,以原生解析度顯示影像。

AdaptiveGroup

群組會以語意方式識別群組中的內容必須整體顯示,或是無法容納的話,則不顯示。 群組也允許建立多個欄。

屬性 型別 必要 描述
子系 IList<AdaptiveSubgroup> false 子群組會顯示為垂直欄。 您必須使用子群組來提供 AdaptiveGroup 內的任何內容。

AdaptiveSubgroup

子群組是垂直欄,可包含文字和影像。

屬性 型別 必要 描述
子系 IList<IAdaptiveSubgroupChild> false AdaptiveTextAdaptiveImage 是子群組的有效子系。
HintWeight int? false 藉由指定相對於其他子群組的權數,控制這個子群組欄的寬度。
HintTextStacking AdaptiveSubgroupTextStacking false 控制這個子群組內容的垂直對齊方式。

IAdaptiveSubgroupChild

子群組子系的標記介面。

實作
AdaptiveText
AdaptiveImage

AdaptiveSubgroupTextStacking

TextStacking 會指定內容的垂直對齊方式。

意義
Default 預設值。 轉譯器會自動選取預設的垂直對齊方式。
前幾個 垂直靠上對齊。
Center 垂直置中對齊。
下方 垂直靠下對齊。

TileBackgroundImage

在磚上完全跨頁顯示的背景影像。

屬性 型別 必要 描述
來源 string true 影像的 URL。 可支援 ms-appx、ms-appdata 和 http(s)。 Http 影像的大小不得超過 200 KB。
HintOverlay int? false 背景影像上的黑色重疊。 此值會控制黑色重疊的不透明度,0 代表不重疊,100 代表全黑。 預設為 20。
HintCrop TileBackgroundImageCrop false 1511 的新功能:指定要裁剪影像的方式。 1511 以前的版本會忽略此項,背景影像將會顯示且不進行任何裁剪。
AlternateText string false 描述影像的替代文字,用於輔助功能。
AddImageQuery bool? false 設定為「true」,表示允許 Windows 將查詢字串附加至磚通知中提供的影像 URL。 如果您的伺服器裝載影像並且可以處理查詢字串,您可以根據查詢字串擷取影像變體,或忽略查詢字串並傳回指定的影像,但不包含查詢字串,透過這兩種方式之一使用此屬性。 此查詢字串會指定縮放比例、對比設定和語言;例如,通知中指定的「www.website.com/images/hello.png」值會變成「www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us」

TileBackgroundImageCrop

控制背景影像的裁剪。

意義
Default 裁剪會使用轉譯器的預設行為。
None 影像未裁剪,以正方形顯示。
圓圈 影像會裁剪成圓形。

TilePeekImage

預覽影像會從磚頂端以動畫方式進場顯示。

屬性 型別 必要 描述
來源 string 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 string false 描述影像的替代文字,用於輔助功能。
AddImageQuery bool? false 設定為「true」,表示允許 Windows 將查詢字串附加至磚通知中提供的影像 URL。 如果您的伺服器裝載影像並且可以處理查詢字串,您可以根據查詢字串擷取影像變體,或忽略查詢字串並傳回指定的影像,但不包含查詢字串,透過這兩種方式之一使用此屬性。 此查詢字串會指定縮放比例、對比設定和語言;例如,通知中指定的「www.website.com/images/hello.png」值會變成「www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us」

TilePeekImageCrop

控制預覽影像的裁剪。

意義
Default 裁剪會使用轉譯器的預設行為。
None 影像未裁剪,以正方形顯示。
圓圈 影像會裁剪成圓形。

TileTextStacking

文字堆疊會指定內容的垂直對齊方式。

意義
Default 預設值。 轉譯器會自動選取預設的垂直對齊方式。
前幾個 垂直靠上對齊。
Center 垂直置中對齊。
下方 垂直靠下對齊。

TileBindingContentIconic

小型和中型均支援。 啟用圖示磚範本,您可以採用真正的傳統 Windows Phone 樣式在磚上讓圖示和徽章並列顯示。 圖示旁的數字是透過個別徽章通知來達成。

屬性 型別 必要 描述
圖示 TileBasicImage true 若要同時支援 Desktop 和 Mobile、小型和中型磚,至少要提供解析度為 200x200 的 PNG 格式正方形外觀比例影像,具有透明度且只有白色。 如需詳細資訊,請參閱:特殊磚範本

TileBindingContentContact

僅限 Mobile。 小型、中型和寬版均支援。

屬性 型別 必要 描述
映像 TileBasicImage true 要顯示的影像。
Text TileBasicText false 顯示的文字行。 未在小型磚上顯示。

TileBindingContentPeople

1511 的新功能:中、寬和大均支援 (Desktop 和 Mobile)。 先前此功能僅限 Mobile,且只有中和寬。

屬性 型別 必要 描述
影像 IList<TileBasicImage> true 以圓形四處滾動的影像。

TileBindingContentPhotos

透過相片的投影片放映製作動畫效果。 所有大小都支援。

屬性 型別 必要 描述
影像 IList<TileBasicImage> true 最多可提供 12 個影像 (Mobile 最多顯示 9 個),將用於投影片放映。 若新增超過 12 個影像,則會擲回例外狀況。

TileBasicImage

各種特殊範本使用的影像。

屬性 型別 必要 描述
來源 string true 影像的 URL。 可支援 ms-appx、ms-appdata 和 http(s)。 Http 影像的大小不得超過 200 KB。
AlternateText string false 描述影像的替代文字,用於輔助功能。
AddImageQuery bool? false 設定為「true」,表示允許 Windows 將查詢字串附加至磚通知中提供的影像 URL。 如果您的伺服器裝載影像並且可以處理查詢字串,您可以根據查詢字串擷取影像變體,或忽略查詢字串並傳回指定的影像,但不包含查詢字串,透過這兩種方式之一使用此屬性。 此查詢字串會指定縮放比例、對比設定和語言;例如,通知中指定的「www.website.com/images/hello.png」值會變成「www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us」

TileBasicText

各種特殊範本使用的基本文字元素。

屬性 型別 必要 描述
文字 string false 要顯示的文字。
語言 string false XML 承載的目標地區設定,會指定為 BCP-47 語言標記,例如 “en-US” 或 “fr-FR”。 此處指定的地區設定會覆寫任何其他指定的地區設定,例如繫結或視覺效果中的地區設定。 如果此值是常值字串,則此屬性會預設為使用者的 UI 語言。 如果此值是字串參考,則此屬性會預設為 Windows 執行階段解析字串時選擇的地區設定。