WidgetManager.DeleteWidget(String) Metode

Definisi

Meminta penghapusan widget dari host 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)

Parameter

widgetId
String

Platform::String

winrt::hstring

Pengidentifikasi unik widget yang akan dihapus. Nilai ID widget dihasilkan secara dinamis oleh WidgetManager. ID widget tetap sama untuk widget dari saat pembuatannya sampai saat Widget dihapus. ID widget adalah nilai unik di semua widget dan semua penyedia widget.

Penerapan

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)

Contoh

Contoh berikut menghapus semua widget dengan yang ditentukan .

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

Keterangan

Setelah metode ini dipanggil, penyedia Anda akan menerima pemberitahuan bahwa widget telah dihapus melalui DeleteWidget(String, String) metode .

Memanggil metode ini dengan ID widget yang telah dihapus tidak akan berpengaruh.

Berlaku untuk