WidgetManager.DeleteWidget(String) Método

Definición

Espacio de nombres:

Microsoft.Windows.Widgets.Providers

Solicita la eliminación de un widget del 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)

Parámetros

widgetId

String

Platform::String

winrt::hstring

Identificador único del widget que se va a quitar. El valor del identificador del widget se genera dinámicamente mediante WidgetManager. El identificador del widget sigue siendo el mismo para un widget desde el momento de su creación hasta el momento en que se elimina el widget. El identificador del widget es un valor único en todos los widgets y en todos los proveedores de widgets.

Implementaciones

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)

Ejemplos

En el ejemplo siguiente se eliminan todos los widgets con un 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;
            }
        }
    }
}

Comentarios

Después de llamar a este método, el proveedor recibirá una notificación de que el widget se ha eliminado a través del DeleteWidget(String, String) método .

Llamar a este método con el identificador de un widget que ya se ha eliminado no tendrá ningún efecto.