IWidgetProvider.DeleteWidget(String, String) 方法

定义

通知小组件提供程序它支持的小组件之一已被删除,例如,当用户从小组件主机中删除小组件时。

public:
 void DeleteWidget(Platform::String ^ widgetId, Platform::String ^ customState);
void DeleteWidget(winrt::hstring const& widgetId, winrt::hstring const& customState);
public void DeleteWidget(string widgetId, string customState);
function deleteWidget(widgetId, customState)
Public Sub DeleteWidget (widgetId As String, customState As String)

参数

widgetId
String

Platform::String

winrt::hstring

要取消固定的小组件的唯一标识符。 小组件 ID 值由 WidgetManager动态生成。 从创建小组件到删除小组件的那一刻,小组件 ID 保持不变。 小组件 ID 是跨所有小组件和所有小组件提供程序的唯一值。

customState
String

Platform::String

winrt::hstring

包含已取消固定的小组件的自定义状态的字符串。

注解

为特定小组件 ID 调用此方法后,提供程序将不会收到该小组件的任何其他请求。 调用此方法时,使用已删除小组件的 ID 对 的方法 WidgetManager 进行进一步调用将不起作用。

适用于