IRawElementProviderSimple

単純な UI 要素を公開するメソッドとプロパティを定義します。

このインターフェイスは、次のものに実装できます。

• ボタンなどの単純な UI 要素向けの UI Automation プロバイダー。
• 既にプロバイダーを持つ UI 要素に対して、プロパティやコントロールパターンを追加またはオーバーライドするプロバイダー。

Microsoft UI Automation プロバイダーの種類を指定します。たとえば、クライアント側 (プロキシ) プロバイダーであるか、サーバー側プロバイダーであるかを示します。

このメソッドは、ProviderOptions_ServerSideProvider または ProviderOptions_ClientSideProvider のいずれかを返す必要があります。

UI Automation は、さまざまな種類のプロバイダーを異なる方法で処理します。 たとえば、サーバー側プロバイダーからのイベントは、リッスンしているすべてのクライアントにブロードキャストされますが、 クライアント側 (プロキシ) プロバイダーからのイベントはクライアント内にとどまります。

例

次の例では、サーバー側 UI Automation プロバイダー向けにこのメソッドを実装します。

HRESULT STDMETHODCALLTYPE Provider::get_ProviderOptions( ProviderOptions* pRetVal )
{
    *pRetVal = ProviderOptions_ServerSideProvider;
    return S_OK;
}    

Microsoft UI Automation 要素上のコントロールパターンをサポートするオブジェクトへのポインターを取得します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

Microsoft UI Automation プロバイダーがサポートするプロパティの値を取得します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

プロバイダーが propertyId プロパティをサポートしていない場合、プロバイダーは pRetVal->vt を VT_EMPTY に設定し、S_OK を返す必要があります。

プロバイダーがプロパティ値を明示的に隠している場合 (つまり、プロバイダーがそのプロパティを提供せず、要求を他のプロバイダーに引き渡さない場合)、 UiaGetReservedNotSupportedValue 関数を使用して取得したポインターを返す必要があります。例:

pRetVal->vt = VT_UNKNOWN;
UiaGetReservedNotSupportedValue(&pRetVal->punkVal);

double 型の UI Automation プロパティは、非数 (NaN) 値をサポートします。NaN 値を返す場合、浮動小数点例外が有効になっているときに例外が発生しないよう、プロバイダーはクワイエット (非シグナル) NaN を返す必要があります。次の例は、クワイエット NaN の作成方法を示します。

ULONGLONG ulNaN = 0xFFFFFFFFFFFFFFFF;
    *pRetVal = *reinterpret_cast<double*>(&ulNaN);

または、標準 C++ ライブラリの次の関数を使用することもできます。

numeric_limits<double>::quiet_NaN( )

例

次の例では、さまざまなプロパティ値を返します。UiaIds 構造体には プロパティ識別子が含まれます。その初期化方法については、UiaLookupId を参照してください。

HRESULT STDMETHODCALLTYPE Provider::GetPropertyValue(PROPERTYID propertyId, 
        VARIANT* pRetVal)
{
    if (propertyId == UiaIds.ControlTypeProperty)
    {
        pRetVal->vt = VT_I4;
        pRetVal->lVal = UiaIds.ButtonControlType;
    }

    // The Name property normally comes from the Caption property of the 
    // control window, if it has one. The Name is overridden here for the 
    // sake of illustration. 
    else if (propertyId == UiaIds.NameProperty)
    {
        pRetVal->vt = VT_BSTR;
        pRetVal->bstrVal = SysAllocString(L"ColorButton");
    }
    else
    {
        pRetVal->vt = VT_EMPTY;
        // UI Automation will attempt to get the property from the host 
        //window provider.
    }
    return S_OK;
}
            

この要素のホストプロバイダーを指定します。

このプロパティは、通常、カスタムコントロールのウィンドウに対応する Microsoft UI Automation プロバイダーです。 UI Automation は、このプロバイダーをカスタムプロバイダーと組み合わせて使用します。たとえば、要素のランタイム識別子は 通常、ホストプロバイダーから取得されます。

ホストプロバイダーは、次の場合に返す必要があります。要素がフラグメントルートである場合、 要素が単純な要素 (プッシュボタンなど) である場合、およびプロバイダーが再配置プレースホルダーである場合 (詳細については、Provider Repositioning を参照してください)。 それ以外の場合、このプロパティは NULL にする必要があります。

例

次の例では、このプロバイダーが提供するコントロールをホストするウィンドウのホストプロバイダーを返します。

HRESULT STDMETHODCALLTYPE Provider::get_HostRawElementProvider(IRawElementProviderSimple** pRetVal)
{
    return UiaHostProviderFromHwnd(controlHWnd, pRetVal); 
}