WidgetManager.GetWidgetInfo(String) Metodo

Definizione

Ottiene un oggetto WidgetInfo contenente informazioni sul widget con l'ID widget fornito, inclusi il modello di oggetto visivo, il modello di dati, lo stato personalizzato, l'ora dell'ultimo aggiornamento e le informazioni di contesto dall'host del widget.

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

Parametri

widgetId
String

Platform::String

winrt::hstring

Identificatore univoco del widget per cui vengono recuperate le informazioni.

Valori restituiti

Oggetto WidgetInfo , se l'ID specificato è associato a un widget associato all'app chiamante che non è stata eliminata; in caso contrario, null.

Implementazioni

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)

Esempio

L'esempio seguente illustra il recupero di informazioni sul widget per uno dei widget di proprietà dell'app chiamante.

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

Commenti

Questo metodo può essere usato dai provider di widget quando si gestisce una richiesta associata a un widget non riconosciuto per recuperare l'ultimo stato noto. Ad esempio, se si archiviano gli stati dei widget nel Microsoft.Windows. Widgets.Providers.WidgetUpdateRequestOptions.CustomState proprietà, è possibile usare questo metodo durante l'inizializzazione del provider di widget per rigenerare lo stato dei widget.

Si applica a