Condividi tramite


WidgetManager.DeleteWidget(String) Metodo

Definizione

Richiede la rimozione di un widget dall'host del 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)

Parametri

widgetId
String

Platform::String

winrt::hstring

Identificatore univoco del widget da rimuovere. Il valore id widget viene generato dinamicamente da WidgetManager. L'ID del widget rimane invariato per un widget dal momento della sua creazione fino al momento in cui il Widget viene eliminato. L'ID widget è un valore univoco per tutti i widget e tutti i provider di widget.

Implementazioni

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)

Esempio

Nell'esempio seguente vengono eliminati tutti i widget con un oggetto specificato .

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

Commenti

Dopo aver chiamato questo metodo, il provider riceverà una notifica che il widget è stato eliminato tramite il DeleteWidget(String, String) metodo .

La chiamata a questo metodo con l'ID di un widget già eliminato non avrà alcun effetto.

Si applica a