AppNotificationProgressBar.SetValueStringOverride(String) メソッド

定義

名前空間:

Microsoft.Windows.AppNotifications.Builder

アプリ通知の進行状況バーの値文字列のオーバーライドを設定します。

public:
 virtual AppNotificationProgressBar ^ SetValueStringOverride(Platform::String ^ value) = SetValueStringOverride;

AppNotificationProgressBar SetValueStringOverride(winrt::hstring const& value);

public AppNotificationProgressBar SetValueStringOverride(string value);

function setValueStringOverride(value)

Public Function SetValueStringOverride (value As String) As AppNotificationProgressBar

パラメーター

value

String

Platform::String

winrt::hstring

値文字列を含む文字列は、テキストをオーバーライドします。

戻り値

AppNotificationProgressBar

追加のメソッド呼び出しをチェーンできるように、AppNotificationProgressBar インスタンスを返します。

例

次の例は、アプリ通知の進行状況バーの ValueStringOverride プロパティを設定する方法を示しています。

 var notification = new AppNotificationBuilder()
    .AddText("Downloading your weekly playlist...")
    .AddProgressBar(new AppNotificationProgressBar()
        .SetTitle("Progress bar title")
        .SetValue(.5)
        .SetStatus("Downloading...")
        .SetValueStringOverride("1/2 files downloaded"))
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

結果の XML ペイロード:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Downloading your weekly playlist...</text>
            <progress title='Progress bar title' status='Downloading...' value='0.5' valueStringOverride='1/2 files downloaded'/>
        </binding>
    </visual>
</toast>

注釈

AppNotificationProgressBar.ValueStringOverride プロパティを使用して、値文字列オーバーライド テキストを設定することもできます。

AppNotificationProgressBar.BindValueStringOverride呼び出すことによって、データ バインディングを使用してタイトル テキストを設定できます。 AppNotificationProgressData オブジェクトを AppNotification.Progressプロパティに割り当てることで、バインドされた状態の値を更新します。

AppNotificationBuilder API を使用してアプリ通知用の UI を作成する方法については、「アプリ通知コンテンツ参照してください。

アプリ通知の XML スキーマのリファレンス情報については、「アプリ通知コンテンツ スキーマ」を参照してください。