Popupinhaltsschema
Nachstehend werden alle Eigenschaften und Elemente im Popupinhalt beschrieben.
Wenn Sie lieber unformatierte XML anstelle der Benachrichtigungs-Bibliothek verwenden möchten, beziehen Sie sich auf das XML-Schema.
ToastContent
ToastContent ist das Objekt der obersten Ebene, das den Inhalt einer Benachrichtigung einschließlich visueller Elemente, Aktionen und Audio beschreibt.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Starten | Zeichenfolge | false | Eine Zeichenkette, die an die Anwendung übergeben wird, wenn sie vom Popup aktiviert wird. Das Format und der Inhalt dieser Zeichenkette werden von der App für die eigene Verwendung definiert. Wenn der Benutzer auf das Popup tippt oder klickt, um die zugehörige App zu starten, liefert die Startzeichenkette der App den Kontext, der es ihr ermöglicht, dem Benutzer eine Ansicht zu zeigen, die für den Inhalt des Popups relevant ist, anstatt auf die standardmäßige Weise zu starten. |
Visuelles Element | ToastVisual | true | Beschreibt den visuellen Teil der Popupbenachrichtigung. |
Aktionen | IToastActions | false | Erstellen Sie auf Wunsch benutzerdefinierte Aktionen mit Schaltflächen und Eingaben. |
Audio | ToastAudio | false | Beschreibt den Audioteil der Popupbenachrichtigung. |
ActivationType | ToastActivationType | false | Gibt an, welcher Aktivierungstyp verwendet wird, wenn der Benutzer auf den Textkörper dieses Popups klickt. |
ActivationOptions | ToastActivationOptions | false | Neu in Creators Update: Zusätzliche Optionen im Zusammenhang mit der Aktivierung der Popupbenachrichtigung. |
Szenario | ToastScenario | false | Deklariert das Szenario, für das das Popup verwendet wird, z.B. einen Alarm oder eine Erinnerung. |
DisplayTimestamp | DateTimeOffset? | false | Neu im Creators Update: Überschreiben Sie den Standard-Zeitstempel mit einem benutzerdefinierten Zeitstempel, der angibt, wann der Inhalt Ihrer Benachrichtigung tatsächlich zugestellt wurde, und nicht, wann die Benachrichtigung von der Windows-Plattform empfangen wurde. |
Übergeordnet | ToastHeader | false | Neu im Creators Update: Fügen Sie Ihrer Benachrichtigung eine benutzerdefinierte Kopfzeile hinzu, um mehrere Benachrichtigungen im Info-Center zu gruppieren. |
ToastScenario
Gibt an, welches Szenario das Popup darstellt.
Wert | Bedeutung |
---|---|
Standard | Das normale Popupverhalten. |
Erinnerung | Eine Erinnerungsnachricht. Diese wird vorab vergrößert angezeigt und verbleibt auf dem Bildschirm des Benutzers, bis er sie löscht. |
Alarm | Eine Alarmbenachrichtigung. Diese wird vorab vergrößert angezeigt und verbleibt auf dem Bildschirm des Benutzers, bis er sie löscht. Audio wird standardmäßig in einer Schleife wiedergegeben und verwendet Alarmaudio. |
IncomingCall | Benachrichtigung eines eingehenden Anrufs. Diese wird vorab vergrößert in einem speziellen Anruf-Format angezeigt und verbleibt auf dem Bildschirm des Benutzers, bis er sie löscht. Audio wird standardmäßig in einer Schleife wiedergegeben und verwendet Klingelton-Audio. |
ToastVisual
Der visuelle Teil von Popups enthält die Bindungen, die Text, Bilder, adaptive Inhalte und vieles mehr enthalten.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
BindingGeneric | ToastBindingGeneric | true | Die generische Popupbindung, die auf allen Geräten gerendert werden kann. Diese Bindung ist erforderlich und darf nicht null sein. |
BaseUri | URI | false | Eine Standardbasis-URL, die mit relativen URLs in Bildquellenattributen kombiniert wird. |
AddImageQuery | bool? | false | Legen Sie diesen Wert auf „true“ fest, damit Windows eine Abfragezeichenkette an die in der Popupbenachrichtigung angegebene Bild-URL anfügen kann. Verwenden Sie dieses Attribut, wenn Ihr Server Bilder hostet und mit Abfragezeichenketten umgehen kann, indem er entweder eine Bildvariante basierend auf den Abfragezeichenketten abruft oder die Abfragezeichenkette ignoriert und das Bild wie angegeben ohne die Abfragezeichenkette zurückgibt. Diese Abfragezeichenkette gibt den Maßstab, die Kontrasteinstellung und die Sprache an. Der in der Benachrichtigung angegebene Wert „www.website.com/images/hello.png“ wird zum Beispiel zu „www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us“. |
Sprache | Zeichenfolge | false | Das lokale Ziel der visuellen Payload bei der Verwendung lokalisierter Ressourcen, wird spezifiziert als BCP-47 Sprach-Tags wie „en-US“ oder „fr-FR“. Dieses Gebietsschema wird von jedem Gebietsschema überschrieben, das in Bindung oder Text angegeben ist. Wenn keine Angabe erfolgt, wird stattdessen das Systemgebietsschema verwendet. |
ToastBindingGeneric
Die generische Bindung ist die Standardbindung für Popups, in der Sie den Text, die Bilder, den adaptiven Inhalt und mehr festlegen.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Children | IList<IToastBindingGenericChild> | false | Der Inhalt des Textkörpers des Popups, der Text, Bilder und Gruppen enthalten kann (im Anniversary Update hinzugefügt). Textelemente müssen vor allen anderen Elementen stehen, und es werden nur 3 Textelemente unterstützt. Wenn ein Textelement nach einem anderen Element platziert wird, wird es entweder an den Anfang gezogen oder weggelassen. Außerdem werden bestimmte Texteigenschaften wie HintStyle für die untergeordneten Kinder-Textelemente nicht unterstützt und funktionieren nur innerhalb einer AdaptiveSubgroup. Wenn Sie AdaptiveGroup auf Geräten ohne Anniversary Update verwenden, wird der Gruppeninhalt einfach gelöscht. |
AppLogoOverride | ToastGenericAppLogo | false | Ein optionales Logo zum Überschreiben des App-Logos. |
HeroImage | ToastGenericHeroImage | false | Ein optionales empfohlenes „Hero“-Bild, das im Popup und im Info-Center angezeigt wird. |
Attribution | ToastGenericAttributionText | false | Optionaler Attributtext, der unten in der Popupbenachrichtigung angezeigt wird. |
BaseUri | URI | false | Eine Standardbasis-URL, die mit relativen URLs in Bildquellenattributen kombiniert wird. |
AddImageQuery | bool? | false | Legen Sie diesen Wert auf „true“ fest, damit Windows eine Abfragezeichenkette an die in der Popupbenachrichtigung angegebene Bild-URL anfügen kann. Verwenden Sie dieses Attribut, wenn Ihr Server Bilder hostet und mit Abfragezeichenketten umgehen kann, indem er entweder eine Bildvariante basierend auf den Abfragezeichenketten abruft oder die Abfragezeichenkette ignoriert und das Bild wie angegeben ohne die Abfragezeichenkette zurückgibt. Diese Abfragezeichenkette gibt den Maßstab, die Kontrasteinstellung und die Sprache an. Der in der Benachrichtigung angegebene Wert „www.website.com/images/hello.png“ wird zum Beispiel zu „www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us“. |
Sprache | Zeichenfolge | false | Das lokale Ziel der visuellen Payload bei der Verwendung lokalisierter Ressourcen, wird spezifiziert als BCP-47 Sprach-Tags wie „en-US“ oder „fr-FR“. Dieses Gebietsschema wird von jedem Gebietsschema überschrieben, das in Bindung oder Text angegeben ist. Wenn keine Angabe erfolgt, wird stattdessen das Systemgebietsschema verwendet. |
IToastBindingGenericChild
Marker-Schnittstelle für Kinder-Popupelemente, die Text, Bilder, Gruppen und mehr enthalten.
Implementierungen |
---|
AdaptiveText |
AdaptiveImage |
AdaptiveGroup |
AdaptiveProgressBar |
AdaptiveText
Ein adaptives Textelement. Wenn in der obersten Ebene ToastBindingGeneric.Children platziert wird, wird nur HintMaxLines angewendet. Wenn dies jedoch als Kind-Element einer Gruppe/Untergruppe platziert wird, wird die Volltextformatierung unterstützt.
Eigenschaft | Type | Erforderlich | BESCHREIBUNG |
---|---|---|---|
Text | Zeichenkette oder BindableString | false | Der anzuzeigende Text. Unterstützung für die Datenbindung, die in Creators Update hinzugefügt wurde, jedoch nur für Textelemente der obersten Ebene funktioniert. |
HintStyle | AdaptiveTextStyle | false | Die Formatvorlage steuert den Schriftgrad, die Gewichtung und die Deckkraft des Texts. Funktioniert nur für Textelemente innerhalb einer Gruppe/Untergruppe. |
HintWrap | Bool? | false | Legen Sie diesen Wert auf true fest, um den Textumbruch zu aktivieren. Textelemente der obersten Ebene ignorieren diese Eigenschaft und werden immer umbrochen (Sie können HintMaxLines = 1 verwenden, um den Umbruch für Textelemente der obersten Ebene zu deaktivieren). Textelemente innerhalb von Gruppen/Untergruppen werden standardmäßig für den Umbruch auf false festgelegt. |
HintMaxLines | int? | false | Die maximale Anzahl von Zeilen, die das Textelement anzeigen darf. |
HintMinLines | int? | false | Die Mindestanzahl der Zeilen, die das Textelement anzeigen muss. Funktioniert nur für Textelemente innerhalb einer Gruppe/Untergruppe. |
HintAlign | AdaptiveTextAlign | false | Gibt die horizontale Ausrichtung des Texts an. Funktioniert nur für Textelemente innerhalb einer Gruppe/Untergruppe. |
Sprache | Zeichenfolge | false | Das lokale Ziel der XML-Payload, angegeben als BCP-47 Sprach-Tags wie „en-US“ oder „fr-FR“. Das hier angegebene Gebietsschema hat Vorrang vor allen anderen angegebenen Gebietsschemata, wie z.B. dem in Binding oder Visual. Wenn dieser Wert eine Literalzeichenkette ist, wird dieses Attribut standardmäßig auf die Benutzeroberflächensprache des Benutzers festgelegt. Wenn dieser Wert ein Zeichenkettenverweis ist, wird dieses Attribut standardmäßig auf das Gebietsschema festgelegt, das von Windows-Runtime beim Auflösen der Zeichenkette ausgewählt wurde. |
BindableString
Ein Bindungswert für Zeichenketten.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
BindingName | Zeichenfolge | true | Holt oder setzt den Namen, der Ihrem Bindungsdatenwert zugeordnet ist. |
AdaptiveTextStyle
Der Textstil steuert Schriftgrad, Gewichtung und Deckkraft. Subtile Deckkraft ist 60 % undurchsichtig.
Wert | Bedeutung |
---|---|
Standard | Standardwert. Der Stil wird vom Renderer bestimmt. |
Caption | Kleiner als der Schriftgrad des Absatzes. |
CaptionSubtle | Identisch mit Caption, aber mit dezenter Deckkraft. |
Text | Schriftgrad des Absatzes. |
BodySubtle | Identisch mit Body, aber mit dezenter Deckkraft. |
Bemessungsgrundlage | Schriftgrad des Absatzes, Fettdruckstärke. Im Wesentlichen die fett formatierte Version von Body. |
BaseSubtle | Identisch mit Basis, aber mit dezenter Deckkraft. |
Untertitel | H4 Schriftgrad. |
SubtitleSubtle | Identisch mit Subtitle, aber mit dezenter Deckkraft. |
Titel | H3 Schriftgrad. |
TitleSubtle | Identisch mit Title, aber mit dezenter Deckkraft. |
TitleNumeral | Identisch mit Title, aber ohne obere/untere Füllung. |
Subheader | H2 Schriftgrad. |
SubheaderSubtle | Identisch mit Subheader, aber mit dezenter Deckkraft. |
SubheaderNumeral | Identisch wie Subheader, aber ohne obere/untere Füllung. |
Übergeordnet | H1 Schriftgrad. |
HeaderSubtle | Identisch mit Header, aber mit dezenter Deckkraft. |
HeaderNumeral | Identisch mit Header, aber ohne obere/untere Füllung. |
AdaptiveTextAlign
Steuert die horizontale Ausrichtung von Text.
Wert | Bedeutung |
---|---|
Standard | Standardwert. Die Ausrichtung wird automatisch vom Renderer bestimmt. |
Automatisch | Die Ausrichtung wird durch die aktuelle Sprache und Kultur bestimmt. |
Nach links | Richten Sie den Text horizontal links aus. |
Center | Richten Sie den Text horizontal in der Mitte aus. |
Right | Richten Sie den Text horizontal rechts aus. |
AdaptiveImage
Ein eingebundenes Bild.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Quelle | Zeichenfolge | true | Geben Sie die URL des Bildes ein. ms-appx, ms-appdata und http werden unterstützt. Ab dem Fall Creators Update können Web-Bilder eine Größe von bis zu 3 MB bei normalen Verbindungen und 1 MB bei gebührenpflichtigen Verbindungen haben. Auf Geräten, auf denen das Fall Creators Update noch nicht ausgeführt wird, dürfen Webbilder nicht größer als 200 KB sein. |
HintCrop | AdaptiveImageCrop | false | Neu im Anniversary Update: Steuern Sie den gewünschten Bildausschnitt. |
HintRemoveMargin | Bool? | false | Standardmäßig weisen Bilder innerhalb von Gruppen/Untergruppen einen 8px-Rand um sie herum auf. Sie können diesen Rand entfernen, indem Sie diese Eigenschaft auf true festlegen. |
HintAlign | AdaptiveImageAlign | false | Die horizontale Ausrichtung des Bildes an. Funktioniert nur für Bilder innerhalb einer Gruppe/Untergruppe. |
AlternateText | Zeichenfolge | false | Alternativer Text zur Beschreibung des Bilds, der für Bedienungshilfezwecke verwendet wird. |
AddImageQuery | bool? | false | Legen Sie diesen Wert auf „true“ fest, damit Windows eine Abfragezeichenkette an die in der Popupbenachrichtigung angegebene Bild-URL anfügen kann. Verwenden Sie dieses Attribut, wenn Ihr Server Bilder hostet und mit Abfragezeichenketten umgehen kann, indem er entweder eine Bildvariante basierend auf den Abfragezeichenketten abruft oder die Abfragezeichenkette ignoriert und das Bild wie angegeben ohne die Abfragezeichenkette zurückgibt. Diese Abfragezeichenkette gibt den Maßstab, die Kontrasteinstellung und die Sprache an. Der in der Benachrichtigung angegebene Wert „www.website.com/images/hello.png“ wird zum Beispiel zu „www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us“. |
AdaptiveImageCrop
Legt den gewünschten Zuschnitt des Bilds fest.
Wert | Bedeutung |
---|---|
Standard | Standardwert. Das vom Renderer festgelegte Zuschnitt-Verhalten. |
None | Bild ist nicht zugeschnitten. |
Kreis | Das Bild wird auf eine Kreisform zugeschnitten. |
AdaptiveImageAlign
Gibt die horizontale Ausrichtung des Bildes an.
Wert | Bedeutung |
---|---|
Standard | Standardwert. Vom Renderer festgelegtes Ausrichtungsverhalten. |
Stretch | Das Bild wird gestreckt, um die verfügbare Breite zu füllen (und möglicherweise auch die Höhe, je nachdem, wo das Bild platziert wird). |
Nach links | Richten Sie das Bild linksbündig aus, wobei das Bild in seiner systemeigenen Auflösung angezeigt wird. |
Center | Richten Sie das Bild horizontal mittig aus, wobei das Bild in seiner systemeigenen Auflösung angezeigt wird. |
Right | Richten Sie das Bild rechtsbündig aus, wobei das Bild in seiner systemeigenen Auflösung angezeigt wird. |
AdaptiveGroup
Neu im Anniversary Update: Gruppen identifizieren semantisch, dass der Inhalt in der Gruppe entweder als Ganzes angezeigt werden muss oder nicht angezeigt werden kann, wenn er nicht passt. Gruppen ermöglichen auch das Erstellen mehrerer Spalten.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Children | IList<AdaptiveSubgroup> | false | Untergruppen werden als vertikale Spalten angezeigt. Sie müssen Untergruppen verwenden, um Inhalte in einer AdaptiveGroup bereitzustellen. |
AdaptiveSubgroup
Neu in Anniversary Update: Untergruppen sind vertikale Spalten, die Text und Bilder enthalten können.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Children | IList<IAdaptiveSubgroupChild> | false | AdaptiveText und AdaptiveImage sind gültige untergeordnete Elemente von Untergruppen. |
HintWeight | int? | false | Steuern Sie die Breite dieser Untergruppenspalte, indem Sie die Gewichtung in Bezug auf die anderen Untergruppen angeben. |
HintTextStacking | AdaptiveSubgroupTextStacking | false | Steuern der vertikalen Ausrichtung des Inhalts dieser Untergruppe. |
IAdaptiveSubgroupChild
Marker-Schnittstelle für untergeordnete Untergruppen.
Implementierungen |
---|
AdaptiveText |
AdaptiveImage |
AdaptiveSubgroupTextStacking
TextStacking gibt die vertikale Ausrichtung des Inhalts an.
Wert | Bedeutung |
---|---|
Standard | Standardwert. Renderer wählt automatisch die vertikale Standardausrichtung aus. |
Top | Vertikal am oberen Rand ausrichten. |
Center | Vertikal an der Mitte ausrichten. |
bottom | Vertikal am unteren Rand ausrichten. |
AdaptiveProgressBar
Neu in Creators Update: Eine Statusanzeige. Nur für Popups auf Desktop, Build 15063 oder höher, unterstützt.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Titel | Zeichenkette oder BindableString | false | Ruft eine optionale Titel-Zeichenkette ab oder legt sie fest. Unterstützt die Datenbindung. |
Wert | Doppelt oder AdaptiveProgressBarValue oder BindableProgressBarValue | false | Ruft den Wert der Statusanzeige ab oder legt ihn fest. Unterstützt die Datenbindung. Der Standardwert ist 0. |
ValueStringOverride | Zeichenkette oder BindableString | false | Dient zum Abrufen oder Festlegen einer optionalen Zeichenkette, die anstelle der Standard Prozent-Zeichenkette angezeigt werden soll. Wenn dies nicht angegeben wird, wird etwas wie „70%“ angezeigt. |
Status | Zeichenkette oder BindableString | true | Dient zum Abrufen oder Festlegen einer Statuszeichenkette (erforderlich), die unter der Statusleiste auf der linken Seite angezeigt wird. Diese Zeichenkette sollte den Status des Vorgangs widerspiegeln, z.B. „Herunterladen...“ oder „Installieren...“ |
AdaptiveProgressBarValue
Eine Klasse, die den Wert der Statusanzeige darstellt.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Wert | double | false | Dient zum Abrufen oder Festlegen des Werts (0,0 - 1,0), der die prozentuale Vollständigkeit angibt. |
IsIndeterminate | bool | false | Dient zum Abrufen oder Festlegen eines Wertes, der angibt, ob die Statusanzeige unbestimmt ist. Wenn dies zutrifft, wird der Wert ignoriert. |
BindableProgressBarValue
Ein bindungsfähiger Statusanzeigen-Wert.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
BindingName | Zeichenfolge | true | Holt oder setzt den Namen, der Ihrem Bindungsdatenwert zugeordnet ist. |
ToastGenericAppLogo
Ein Logo, das anstelle des App-Logos angezeigt werden soll.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Quelle | Zeichenfolge | true | Geben Sie die URL des Bildes ein. ms-appx, ms-appdata und http werden unterstützt. HTTP-Bilder dürfen maximal 200 KB groß sein. |
HintCrop | ToastGenericAppLogoCrop | false | Geben Sie an, wie das Bild zugeschnitten werden soll. |
AlternateText | Zeichenfolge | false | Alternativer Text zur Beschreibung des Bilds, der für Bedienungshilfezwecke verwendet wird. |
AddImageQuery | bool? | false | Legen Sie diesen Wert auf „true“ fest, damit Windows eine Abfragezeichenkette an die in der Popupbenachrichtigung angegebene Bild-URL anfügen kann. Verwenden Sie dieses Attribut, wenn Ihr Server Bilder hostet und mit Abfragezeichenketten umgehen kann, indem er entweder eine Bildvariante basierend auf den Abfragezeichenketten abruft oder die Abfragezeichenkette ignoriert und das Bild wie angegeben ohne die Abfragezeichenkette zurückgibt. Diese Abfragezeichenkette gibt den Maßstab, die Kontrasteinstellung und die Sprache an. Der in der Benachrichtigung angegebene Wert „www.website.com/images/hello.png“ wird zum Beispiel zu „www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us“. |
ToastGenericAppLogoCrop
Steuert das Zuschneiden des App-Logobilds.
Wert | Bedeutung |
---|---|
Standard | Beim Zuschneiden wird das Standardverhalten des Renderers verwendet. |
None | Bild ist nicht zugeschnitten, angezeigtes Quadrat. |
Kreis | Das Bild wird auf eine Kreisform zugeschnitten. |
ToastGenericHeroImage
Ein optionales „Hero“-Bild, das im Popup und im Info-Center angezeigt wird.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Quelle | Zeichenfolge | true | Geben Sie die URL des Bildes ein. ms-appx, ms-appdata und http werden unterstützt. HTTP-Bilder dürfen maximal 200 KB groß sein. |
AlternateText | Zeichenfolge | false | Alternativer Text zur Beschreibung des Bilds, der für Bedienungshilfezwecke verwendet wird. |
AddImageQuery | bool? | false | Legen Sie diesen Wert auf „true“ fest, damit Windows eine Abfragezeichenkette an die in der Popupbenachrichtigung angegebene Bild-URL anfügen kann. Verwenden Sie dieses Attribut, wenn Ihr Server Bilder hostet und mit Abfragezeichenketten umgehen kann, indem er entweder eine Bildvariante basierend auf den Abfragezeichenketten abruft oder die Abfragezeichenkette ignoriert und das Bild wie angegeben ohne die Abfragezeichenkette zurückgibt. Diese Abfragezeichenkette gibt den Maßstab, die Kontrasteinstellung und die Sprache an. Der in der Benachrichtigung angegebene Wert „www.website.com/images/hello.png“ wird zum Beispiel zu „www.website.com/images/hello.png?ms-scale=100&ms-contrast=standard&ms-lang=en-us“. |
ToastGenericAttributionText
Attributtext, der unten in der Popupbenachrichtigung angezeigt wird.
Eigenschaft | Type | Erforderlich | BESCHREIBUNG |
---|---|---|---|
Text | Zeichenfolge | true | Der anzuzeigende Text. |
Sprache | Zeichenfolge | false | Das lokale Ziel der visuellen Payload bei der Verwendung lokalisierter Ressourcen, wird spezifiziert als BCP-47 Sprach-Tags wie „en-US“ oder „fr-FR“. Wenn keine Angabe erfolgt, wird stattdessen das Systemgebietsschema verwendet. |
IToastActions
Markierungsschnittstelle für Popupaktionen/Eingaben.
Implementierungen |
---|
ToastActionsCustom |
ToastActionsSnoozeAndDismiss |
ToastActionsCustom
Implementiert IToastActions
Erstellen Sie eigene benutzerdefinierte Aktionen und Eingaben, indem Sie Steuerelemente wie Schaltflächen, Textfelder und Auswahleingaben verwenden.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Eingaben | IList<IToastInput> | false | Eingaben wie Textfelder und Auswahleingaben. Es sind bis zu 5 Eingaben zulässig. |
Schaltflächen | IList<IToastButton> | false | Schaltflächen werden nach allen Eingaben angezeigt (oder neben einer Eingabe, wenn die Schaltfläche als Schaltfläche für schnelle Antwort verwendet wird). Es sind bis zu 5 Schaltflächen zulässig (oder weniger, wenn Sie auch Über Kontextmenüelemente verfügen). |
ContextMenuItems | IList<ToastContextMenuItem> | false | Neu in Anniversary Update: Benutzerdefinierte Kontextmenüelemente, die zusätzliche Aktionen bereitstellen, wenn der Benutzer mit der rechten Maustaste auf die Benachrichtigung klickt. Es können nur bis zu 5 Schaltflächen und Kontextmenüelemente kombiniert werden. |
IToastInput
Marker-Schnittstelle für Popupaktionen/Eingaben.
Implementierungen |
---|
ToastTextBox |
ToastSelectionBox |
ToastTextBox
Implementiert IToastInput
Ein Textfeld-Steuerelement, in das der Benutzer Text eingeben kann.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Id | Zeichenfolge | true | Die ID ist erforderlich und wird verwendet, um den vom Benutzer eingegebenen Text in ein Schlüssel-Wert-Paar aus ID/Wert umzuwandeln, das später von Ihrer Anwendung verwendet wird. |
Titel | Zeichenfolge | false | Titeltext, der über dem Textfeld angezeigt werden soll. |
PlaceholderContent | Zeichenfolge | false | Platzhaltertext, der im Textfeld angezeigt werden soll, wenn der Benutzer noch keinen Text eingegeben hat. |
DefaultInput | Zeichenfolge | false | Der anfängliche Text, der im Textfeld platziert werden soll. Lassen Sie dies leer, um ein leeres Textfeld zu erhalten. |
ToastSelectionBox
Implementiert IToastInput
Ein Auswahlfeld-Steuerelement, mit dem Benutzer aus einer Dropdown-Liste mit Optionen eine Auswahl treffen können.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Id | Zeichenfolge | true | Die ID ist erforderlich. Wenn der Benutzer dieses Element ausgewählt hat, wird diese ID an den Code Ihrer Anwendung zurückgegeben und zeigt an, welche Auswahl getroffen wurde. |
Inhalt | Zeichenfolge | true | Der Inhalt ist erforderlich und ist eine Zeichenkette, die im Auswahlelement angezeigt wird. |
ToastSelectionBoxItem
Ein Auswahlfeldelement (ein Element, das der Benutzer in der Dropdownliste auswählen kann).
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Id | Zeichenfolge | true | Die ID ist erforderlich und wird verwendet, um den vom Benutzer eingegebenen Text in ein Schlüssel-Wert-Paar aus ID/Wert umzuwandeln, das später von Ihrer Anwendung verwendet wird. |
Titel | Zeichenfolge | false | Titeltext, der über dem Auswahlfeld angezeigt werden soll. |
DefaultSelectionBoxItemId | Zeichenfolge | false | Dadurch wird gesteuert, welches Element standardmäßig ausgewählt ist, und verweist auf die ID-Eigenschaft des ToastSelectionBoxItem-Objekts. Wenn Sie dies nicht angeben, ist die Standardauswahl leer (Der Benutzer sieht nichts). |
Elemente | IList<ToastSelectionBoxItem> | false | Die Auswahlelemente, die der Benutzer in diesem SelectionBox-Steuerelement auswählen kann. Es können nur 5 Elemente hinzugefügt werden. |
IToastButton
Marker-Schnittstelle für Popupschaltflächen.
Implementierungen |
---|
ToastButton |
ToastButtonSnooze |
ToastButtonDismiss |
ToastButton
Implementiert IToastButton
Eine Schaltfläche, die der Benutzer anklicken kann.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Inhalt | Zeichenfolge | true | Erforderlich. Der auf der Schaltfläche anzuzeigende Text. |
Argumente | Zeichenfolge | true | Erforderlich. App-definierte Zeichenkette von Argumenten, die die App später empfängt, wenn der Benutzer auf diese Schaltfläche klickt. |
ActivationType | ToastActivationType | false | Steuert, welche Art von Aktivierung diese Schaltfläche verwendet, wenn darauf geklickt wird. Der Standardwert ist Vordergrund. |
ActivationOptions | ToastActivationOptions | false | Neu in Creators Update: Holt oder setzt zusätzliche Optionen für die Aktivierung der Popup-Schaltfläche. |
ToastActivationType
Bestimmt den Aktivierungstyp, der verwendet wird, wenn der Benutzer mit einer bestimmten Aktion interagiert.
Wert | Bedeutung |
---|---|
Vordergrund | Standardwert. Ihre Vordergrund-App wird gestartet. |
Hintergrund | Die entsprechende Hintergrundaufgabe (vorausgesetzt, Sie haben alles eingerichtet) wird ausgelöst, und Sie können Code im Hintergrund ausführen (z.B. senden der Schnellantwort des Benutzers), ohne den Benutzer zu unterbrechen. |
Protokoll | Starten Sie eine andere App mithilfe der Protokollaktivierung. |
ToastActivationOptions
Neu in Creators Update: Zusätzliche Optionen im Zusammenhang mit der Aktivierung.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
AfterActivationBehavior | ToastAfterActivationBehavior | false | Neu in Fall Creators Update: Holt oder setzt das Verhalten, das das Popup verwenden soll, wenn der Benutzer diese Aktion aufruft. Dies funktioniert nur auf Desktop, für ToastButton und ToastContextMenuItem. |
ProtocolActivationTargetApplicationPfn | Zeichenfolge | false | Wenn Sie ToastActivationType.Protocol verwenden, können Sie optional den Ziel-PFN angeben, sodass unabhängig davon, ob mehrere Apps registriert sind, um denselben Protokoll-URI zu verarbeiten, ihre gewünschte App immer gestartet wird. |
ToastAfterActivationBehavior
Gibt das Verhalten an, das das Popup verwenden soll, wenn der Benutzer Aktionen für das Popup ausführt.
Wert | Bedeutung |
---|---|
Standard | Standardverhalten. Das Popup wird geschlossen, wenn der Benutzer Aktionen für das Popup ausführt. |
PendingUpdate | Nachdem der Benutzer auf eine Schaltfläche in Ihrem Popup angeklickt hat, bleibt die Benachrichtigung in einem visuellen Zustand „ausstehende Aktualisierung“ erhalten. Sie sollten das Popup sofort aus einer Hintergrundaufgabe aktualisieren, sodass der Benutzer diesen visuellen Zustand „Ausstehendes Update“ nicht zu lange sieht. |
ToastButtonSnooze
Implementiert IToastButton
Eine vom System verwaltete Standbymodus-Taste, die den Standbymodus der Benachrichtigung automatisch verwaltet.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
CustomContent | Zeichenfolge | false | Optionaler benutzerdefinierter Text, der auf der Schaltfläche angezeigt wird und den standardmäßig lokalisierten Text „Snooze“ überschreibt. |
ToastButtonDismiss
Implementiert IToastButton
Eine vom System verwaltete Schaltfläche zum Schließen, die die Benachrichtigung schließt, wenn auf sie geklickt wird.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
CustomContent | Zeichenfolge | false | Optionaler benutzerdefinierter Text, der auf der Schaltfläche angezeigt wird und den standardmäßig lokalisierten Text „Dismiss“ überschreibt. |
ToastActionsSnoozeAndDismiss
*Implementiert IToastActions
Erstellt automatisch ein Auswahlfeld für Standby-Intervalle und Schaltflächen für Standby/Schließen, die alle automatisch lokalisiert werden, und die Standby-Logik wird automatisch vom System verarbeitet.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
ContextMenuItems | IList<ToastContextMenuItem> | false | Neu in Anniversary Update: Benutzerdefinierte Kontextmenüelemente, die zusätzliche Aktionen bereitstellen, wenn der Benutzer mit der rechten Maustaste auf die Benachrichtigung klickt. Sie können nur bis zu 5 Elemente haben. |
ToastContextMenuItem
Ein Eintrag eines Kontextmenüelements.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Inhalt | Zeichenfolge | true | Erforderlich. Der anzuzeigende Text. |
Argumente | Zeichenfolge | true | Erforderlich. App-definierte Zeichenkette von Argumenten, die die App später abrufen kann, wenn sie aktiviert wird, sobald der Benutzer das Menüelement anklickt. |
ActivationType | ToastActivationType | false | Steuert, welche Art der Aktivierung dieses Menüelements verwendet wird, wenn es angeklickt wird. Der Standardwert ist Vordergrund. |
ActivationOptions | ToastActivationOptions | false | Neu im Creators Update: Zusätzliche Optionen für die Aktivierung des Popup-Kontextmenüeintrags. |
ToastAudio
Legen Sie fest, welcher Audioton abgespielt werden soll, wenn die Popupbenachrichtigung empfangen wird.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Src | uri | false | Die Mediendatei, die anstelle des Standardsounds wiedergegeben werden soll. Es werden nur ms-appx und ms-resource unterstützt. Alle anderen (ms-appdata, http, C:, etc.) werden nicht unterstützt. |
Loop | boolean | false | Auf true festlegen, wenn der Sound so lange wiederholt werden soll, wie das Popup angezeigt wird. False, wenn er nur einmal wiedergegeben werden soll (Standardeinstellung). |
Silent | boolean | false | True, um den Sound stummzuschalten; False, um die Wiedergabe des Popupbenachrichtigungssounds zuzulassen (Standardeinstellung). |
ToastHeader
Neu in Creators Update: Ein benutzerdefinierter Header, der mehrere Benachrichtigungen im Info-Center gruppiert.
Eigenschaft | Type | Erforderlich | Beschreibung |
---|---|---|---|
Id | Zeichenfolge | true | Ein vom Entwickler erstellter Bezeichner, der diesen Header eindeutig identifiziert. Wenn zwei Benachrichtigungen dieselbe Kopfzeilen-ID haben, werden sie unter demselben Header im Info-Center angezeigt. |
Titel | Zeichenfolge | true | Ein Titel für den Header. |
Argumente | Zeichenfolge | true | Dient zum Abrufen oder Festlegen einer entwicklerdefinierten Zeichenkette von Argumenten, die an die App zurückgegeben werden, wenn der Benutzer diesen Header anklickt. Lässt keine NULL-Werte zu. |
ActivationType | ToastActivationType | false | Holt oder setzt die Art der Aktivierung, die dieser Header verwendet, wenn er angeklickt wird. Der Standardwert ist Vordergrund. Beachten Sie, dass nur Vordergrund und Protokoll unterstützt werden. |
ActivationOptions | ToastActivationOptions | false | Holt oder setzt zusätzliche Optionen für die Aktivierung des Popup-Header. |
Zugehörige Themen
Windows developer