語言

WidgetManager.GetWidgetInfo(String) 方法

定義

命名空間:
Microsoft.Windows.Widgets.Providers
編輯

取得一個 WidgetInfo 物件，包含有關該小工具及所提供 ID 的資訊，包括視覺範本、資料範本、自訂狀態、最後更新時間，以及來自小工具主機的上下文資訊。

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 物件;否則為零。

實作

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 屬性，你可以在 widget 提供者初始化時使用此方法來重新生成 widget 的狀態。

適用於