WidgetManager.DeleteWidget(String) Méthode

Référence

Définition

Espace de noms:: Microsoft.Windows.Widgets.Providers

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Modifier

Demande la suppression d’un widget de l’hôte du 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)

Paramètres

widgetId: String
Platform::String

winrt::hstring

Identificateur unique du widget à supprimer. La valeur de l’ID du widget est générée dynamiquement par leWidgetManager . L’ID de widget reste le même pour un widget à partir du moment de sa création jusqu’au moment où le widget est supprimé. L’ID de widget est une valeur unique pour tous les widgets et tous les fournisseurs de widgets.

Implémente

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)

Exemples

L’exemple suivant supprime tous les widgets avec une spécifiée.

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

Remarques

Une fois cette méthode appelée, votre fournisseur reçoit une notification indiquant que le widget a été supprimé via la méthode DeleteWidget(String, String).

L’appel de cette méthode avec l’ID d’un widget qui a déjà été supprimé n’aura aucun effet.

S’applique à

Partager via