Поделиться через


WidgetManager.DeleteWidget(String) Метод

Определение

Запрашивает удаление мини-приложения из узла мини-приложения.

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. Идентификатор мини-приложения остается неизменным для мини-приложения с момента его создания до момента удаления мини-приложения. Идентификатор мини-приложения — это уникальное значение для всех мини-приложений и всех поставщиков мини-приложений.

Реализации

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) метода .

Вызов этого метода с идентификатором уже удаленного мини-приложения не будет иметь никакого эффекта.

Применяется к