WidgetManager.DeleteWidget(String) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ウィジェット ホストからのウィジェットの削除を要求します。
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)パラメーター
- widgetId
-
String
Platform::String
winrt::hstring
削除するウィジェットの一意識別子。 ウィジェット ID の値は、 によって WidgetManager動的に生成されます。 ウィジェット ID は、ウィジェットが作成された時点からウィジェットが削除されるまで同じままです。 ウィジェット ID は、すべてのウィジェットとすべてのウィジェット プロバイダーで一意の値です。
実装
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)
例
次の例では、 を指定してすべてのウィジェットを削除します 。
/*
* 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;
}
}
}
}
注釈
このメソッドが呼び出されると、プロバイダーは メソッドを通じてウィジェットが削除されたことを示す通知を DeleteWidget(String, String) 受け取ります。
既に削除されているウィジェットの ID を使用してこのメソッドを呼び出しても、効果はありません。