WidgetManager.DeleteWidget(String) 方法

定義

命名空間:

Microsoft.Windows.Widgets.Providers

要求從小工具主機移除小工具。

public:
 virtual void DeleteWidget(Platform::String ^ widgetId) = DeleteWidget;

void DeleteWidget(winrt::hstring const& widgetId);

public void DeleteWidget(string widgetId);

function deleteWidget(widgetId)

Public Sub DeleteWidget (widgetId As String)

參數

widgetId

String

Platform::String

winrt::hstring

要移除之小工具的唯一標識符。 小工具標識碼值是由 WidgetManager動態產生。 從小工具建立的那一刻起，小工具標識符會維持不變，直到小工具刪除的那一刻為止。 小工具標識碼是所有 Widget 和所有小工具提供者的唯一值。

實作

M:Microsoft.Windows.Widgets.Providers.IWidgetManager.DeleteWidget(System.String) M:Microsoft.Windows.Widgets.Providers.IWidgetManager.DeleteWidget(Platform::String) M:Microsoft.Windows.Widgets.Providers.IWidgetManager.DeleteWidget(winrt::hstring)

範例

下列範例會刪除具有指定 的所有小工具。

/*
* Sample output:
* Deleted Widget with Id: {D8FEC89F-9A89-44B1-A52D-F04C515B0141}
*/
using namespace std;
using namespace winrt;

class WidgetManagerOperations
{
    void DeleteAllClockWidgets()
    {
        WidgetManager widgetManager = WidgetManager::GetDefault();
        com_array<WidgetInfo> widgetInfos = widgetManager.GetWidgetInfos();

        for (const auto& widgetInfo : widgetInfos)
        {
            if (widgetInfo.WidgetContext().DefinitionName() == L"clockWidget")
            {
                hstring widgetId = widgetInfo.WidgetContext().Id();
                widgetManager.DeleteWidget(widgetId);

                wcout << L"Deleted Widget with Id: " << widgetId << endl;
            }
        }
    }
}

備註

呼叫此方法之後，您的提供者會收到通知，指出小工具已透過 DeleteWidget(String, String) 方法刪除。

使用已經刪除之小工具標識元呼叫這個方法將沒有任何作用。