WidgetUpdateRequestOptions クラス

定義

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

Microsoft.Windows の呼び出しのデータを提供します。Widgets.Providers.WidgetManager.UpdateWidget。

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

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

コンストラクター

名前 説明
WidgetUpdateRequestOptions(String)

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

プロパティ

名前 説明
CustomState

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

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

更新プログラムの内容がプレースホルダー コンテンツかどうかを示す値を取得または設定します。
Rank

同じパッケージ ID の他のウィジェットを基準にして、ウィジェットのランクを指定する値を取得または設定します。
Template

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

関連付けられているプロパティが未設定であることを示すセンチネル値を取得します。
WidgetId

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

適用対象