WidgetManager.DeleteWidget(String) Methode

Referenz

Definition

Namespace:: Microsoft.Windows.Widgets.Providers

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Bearbeiten

Fordert das Entfernen eines Widgets vom Widgethost an.

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)

Parameter

widgetId: String
Platform::String

winrt::hstring

Der eindeutige Bezeichner des zu entfernenden Widgets. Der Widget-ID-Wert wird dynamisch vom WidgetManagergeneriert. Die Widget-ID bleibt für ein Widget ab dem Zeitpunkt der Erstellung gleich, bis das Widget gelöscht wird. Die Widget-ID ist ein eindeutiger Wert für alle Widgets und alle Widgetanbieter.

Implementiert

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)

Beispiele

Im folgenden Beispiel werden alle Widgets mit einer angegebenen gelöscht.

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

Hinweise

Nachdem diese Methode aufgerufen wurde, erhält Ihr Anbieter eine Benachrichtigung, dass das Widget über die DeleteWidget(String, String)-Methode gelöscht wurde.

Das Aufrufen dieser Methode mit der ID eines bereits gelöschten Widgets hat keine Auswirkung.

Gilt für:

Freigeben über