WidgetManager.GetWidgetInfo(String) Methode

Referenz

Definition

Namespace:: Microsoft.Windows.Widgets.Providers

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Bearbeiten

Ruft ein WidgetInfo Objekt ab, das Informationen über das Widget mit der bereitgestellten Widget-ID enthält, einschließlich der visuellen Vorlage, der Datenvorlage, des benutzerdefinierten Zustands, der letzten Aktualisierungszeit und Kontextinformationen vom Widgethost.

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

Parameter

widgetId: String
Platform::String

winrt::hstring

Der eindeutige Bezeichner des Widgets, für das Informationen abgerufen werden.

Gibt zurück

WidgetInfo

Ein WidgetInfo--Objekt, wenn die angegebene ID einem Widget zugeordnet ist, das der aufrufenden App zugeordnet ist, die nicht gelöscht wurde; andernfalls null.

Implementiert

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)

Beispiele

Das folgende Beispiel veranschaulicht das Abrufen von Widgetinformationen für eines der Widgets, die der aufrufenden App gehören.

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

Hinweise

Diese Methode kann von Widgetanbietern beim Behandeln einer Anforderung verwendet werden, die einem unbekannten Widget zugeordnet ist, um den letzten bekannten Zustand wiederherzustellen. Wenn Sie beispielsweise die Zustände Ihrer Widgets im Microsoft.Windows.Widgets.Providers.WidgetUpdateRequestOptions.CustomState-Eigenschaft speichern, können Sie diese Methode während der Initialisierung Ihres Widgetanbieters verwenden, um den Zustand Ihrer Widgets neu zu generieren.

Gilt für:

Freigeben über