WidgetUpdateRequestOptions クラス

  • リファレンス

定義

名前空間:
Microsoft.Windows.Widgets.Providers
編集

への呼び出しのデータを提供します WidgetManager.UpdateWidget(WidgetUpdateRequestOptions)。

public ref class WidgetUpdateRequestOptions sealed
/// [Windows.Foundation.Metadata.Activatable(Microsoft.Windows.Widgets.Providers.IWidgetUpdateRequestOptionsFactory, 65536, "Microsoft.Windows.Widgets.WidgetContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Windows.Widgets.WidgetContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class WidgetUpdateRequestOptions final
[Windows.Foundation.Metadata.Activatable(typeof(Microsoft.Windows.Widgets.Providers.IWidgetUpdateRequestOptionsFactory), 65536, "Microsoft.Windows.Widgets.WidgetContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Windows.Widgets.WidgetContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class WidgetUpdateRequestOptions
function WidgetUpdateRequestOptions(widgetId)
Public NotInheritable Class WidgetUpdateRequestOptions
継承
Object Platform::Object IInspectable WidgetUpdateRequestOptions
属性
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

注釈

WidgetUpdateRequestOptions クラスに設定されていない変数は更新されません。 たとえば、ウィジェットのデータの更新にのみ関心があり、既存のビジュアル テンプレートとカスタム状態を維持する場合は、 プロパティのみを WidgetUpdateRequestOptions.Data 設定することで、ウィジェットのデータは更新されますが、テンプレートとカスタム状態は変更されません。

UpdateWidget を使用して、値をクリアする空の文字列を設定することで、格納されている値をクリアすることもできます。 たとえば、ウィジェットの格納されているカスタム状態をクリアする場合は、 プロパティを空の文字列に設定 WidgetUpdateRequestOptions.CustomState できます。これにより、UpdateWidget が呼び出されると、格納されているカスタム状態が消去されます。

コンストラクター

WidgetUpdateRequestOptions(String)

WidgetRequestOptions クラスの新しいインスタンスを初期化します。

プロパティ

CustomState

関連付けられたウィジェットのカスタム状態を表す文字列を取得または設定します。
Data

関連付けられたウィジェットのアダプティブ カード データ テンプレートを取得または設定します。
Template

関連付けられたウィジェットのアダプティブ カード ビジュアル テンプレートを取得または設定します。
UnsetValue

関連付けられたプロパティが未設定であることを示す Sentinel 値を取得します。
WidgetId

更新するウィジェットのウィジェット ID を取得します。

適用対象