AppNotificationComboBox.SetSelectedItem(String) Method

Definition

Namespace:

Microsoft.Windows.AppNotifications.Builder

Sets the selected item for an app notification combo box.

public:
 virtual AppNotificationComboBox ^ SetSelectedItem(Platform::String ^ id) = SetSelectedItem;

AppNotificationComboBox SetSelectedItem(winrt::hstring const& id);

public AppNotificationComboBox SetSelectedItem(string id);

function setSelectedItem(id)

Public Function SetSelectedItem (id As String) As AppNotificationComboBox

Parameters

id

String

Platform::String

winrt::hstring

A string containing the ID of the selected item.

Returns

AppNotificationComboBox

Returns the AppNotificationComboBox instance so that additional method calls can be chained.

Examples

The following example demonstrates the use of this method to set the selected item for the app notification combo box.

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .AddComboBox(new AppNotificationComboBox("combobox_id")
        .SetTitle("Select an item:")
        .AddItem("id_one", "Item one")
        .AddItem("id_two", "Item two")
        .SetSelectedItem("id_one"))
    .BuildNotification();


AppNotificationManager.Default.Show(notification);

The resulting XML payload if the urgent scenario is supported:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
    <actions>
        <input id='combobox_id' type='selection' title='Select an item:' defaultInput='id_one'>
            <selection id='id_one' content='Item one'/>
            <selection id='id_two' content='Item two'/>
        </input>
    </actions>
</toast>

Remarks

You can also set the selected item with the AppNotificationComboBox.SelectedItem property.

Add items to a combo box by calling AppNotificationComboBox.AddItem) or with the AppNotificationComboBox.Items property.

For guidance on using the AppNotificationBuilder APIs to create the UI for app notifications, see App notification content.

For reference information about the XML schema for app notifications, see App notification content schema.