WidgetUpdateRequestOptions.CustomState Property

Definition

Namespace:: Microsoft.Windows.Widgets.Providers

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Gets or sets a string representing the custom state for the associated widget.

public:
 property Platform::String ^ CustomState { Platform::String ^ get(); void set(Platform::String ^ value); };

winrt::hstring CustomState();

void CustomState(winrt::hstring value);

public string CustomState { get; set; }

var string = widgetUpdateRequestOptions.customState;
widgetUpdateRequestOptions.customState = string;

Public Property CustomState As String

Property Value

String

Platform::String

winrt::hstring

A string representing the custom state for the associated widget.

Remarks

The custom state string is app-defined and is not validated by the widget host.

For a walkthrough of creating a widget that maintains a custom state property, see Implement a widget provider in a win32 app.

Applies to

Feedback

Was this page helpful?