WidgetManager.GetWidgetInfo(String) 方法

定義

命名空間:

Microsoft.Windows.Widgets.Providers

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

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

備註

處理與無法辨識小工具相關聯的要求，以便復原最後一個已知狀態時，小工具提供者可以使用這個方法。 例如，如果您要將小工具的狀態儲存在 屬性中 WidgetUpdateRequestOptions.CustomState ，您可以在小工具提供者的初始化期間使用此方法來重新產生小工具的狀態。