WidgetManager.GetWidgetInfo(String) メソッド

定義

名前空間:
Microsoft.Windows.Widgets.Providers
編集

表示テンプレート、データ テンプレート、カスタム状態、最終更新時刻、ウィジェット ホストからのコンテキスト情報など、指定されたウィジェット ID を持つウィジェットに関する情報を含む WidgetInfo オブジェクトを取得します。

public:
 virtual WidgetInfo ^ GetWidgetInfo(Platform::String ^ widgetId) = GetWidgetInfo;
WidgetInfo GetWidgetInfo(winrt::hstring const& widgetId);
public WidgetInfo GetWidgetInfo(string widgetId);
function getWidgetInfo(widgetId)
Public Function GetWidgetInfo (widgetId As String) As WidgetInfo

パラメーター

widgetId
String

Platform::String

winrt::hstring

情報を取得するウィジェットの一意識別子。

返品

WidgetInfo

指定した ID が、削除されていない呼び出し元アプリに関連付けられているウィジェットに関連付けられている場合は、 WidgetInfo オブジェクト。それ以外の場合は null。

実装

M:Microsoft.Windows.Widgets.Providers.IWidgetManager.GetWidgetInfo(System.String) M:Microsoft.Windows.Widgets.Providers.IWidgetManager.GetWidgetInfo(Platform::String) M:Microsoft.Windows.Widgets.Providers.IWidgetManager.GetWidgetInfo(winrt::hstring)

例

次の例では、呼び出し元アプリが所有するいずれかのウィジェットのウィジェット情報を取得する方法を示します。

/*
* Sample output:
* Id: {5E3D9EDF-13A6-4185-902B-5997AE0411A5}
* Template: {
    "type": "AdaptiveCard",
    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
    "version": "1.5"
    "body": [
        {
            "type": "TextBlock",
            "text": "${greeting}!"
        }
    ]
}
* Data: {"count": "3"}
* CustomState: 3
* DefinitionName: clickCounter
*/
using namespace std;
using namespace winrt;
using namespace Microsoft::Windows::Widgets::Providers;

class WidgetManagerOperations
{
    void PrintInfoOfWidget(hstring myWidgetId)
    {
        WidgetManager widgetManager = WidgetManager::GetDefault();

        WidgetInfo widgetInfo = widgetManager.GetWidgetInfo(myWidgetId);
        wcout << L"Id - " << L": " << widgetInfo.WidgetContext().Id().c_str() << endl;
        wcout << L"Template: " << widgetInfo.Template().c_str() << endl;
        wcout << L"Data: " << widgetInfo.Data().c_str() << endl;
        wcout << L"CustomState: " << widgetInfo.CustomState().c_str() << endl;
        wcout << L"DefinitionName: " << widgetInfo.WidgetContext().DefinitionName().c_str() << endl;
    }
}

注釈

このメソッドは、認識されないウィジェットに関連付けられている要求を処理するときに、ウィジェット プロバイダーが最後の既知の状態を回復するために使用できます。 たとえば、ウィジェットの状態を Microsoft.Windows に格納する場合です。Widgets.Providers.WidgetUpdateRequestOptions.CustomState プロパティは、ウィジェット プロバイダーの初期化中にこのメソッドを使用して、ウィジェットの状態を再生成できます。

適用対象