WidgetManager.DeleteWidget(String) Método

Definição

Namespace:

Microsoft.Windows.Widgets.Providers

Solicita a remoção de um widget do host do widget.

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)

Parâmetros

widgetId

String

Platform::String

winrt::hstring

O identificador exclusivo do widget a ser removido. O valor da ID do widget é gerado dinamicamente pelo WidgetManager. A ID do widget permanece a mesma para um widget desde o momento de sua criação até o momento em que o Widget é excluído. A ID do widget é um valor exclusivo em todos os widgets e em todos os provedores de widget.

Implementações

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)

Exemplos

O exemplo a seguir exclui todos os widgets com um especificado .

/*
* 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;
            }
        }
    }
}

Comentários

Depois que esse método for chamado, o provedor receberá uma notificação de que o widget foi excluído por meio do DeleteWidget(String, String) método .

Chamar esse método com a ID de um widget que já foi excluído não terá efeito.