從用戶端使用 IAccessibleEx

發行項
06/13/2023

本主題說明用戶端如何存取伺服器的IAccessibleEx實作，並用它來取得 UI 元素的消費者介面自動化屬性和控制模式。

本節中的程式和範例假設 IAccessible 用戶端已在進程中，以及現有的 Microsoft Active Accessibility 伺服器。他們也會假設用戶端已使用AccessibleObjectFromEvent、AccessibleObjectFromPoint或AccessibleObjectFromWindow等其中一個協助工具架構函式取得IAccessible物件。

從 IAccessible 介面取得 IAccessibleEx 介面

具有可存取物件的 IAccessible 介面的用戶端，可以依照下列步驟來取得對應的 IAccessibleEx 介面：

使用 IServiceProvider __uuidof () 的 IID，在原始IAccessible物件上呼叫QueryInterface。
呼叫 IServiceProvider：：QueryService 以取得 IAccessibleEx。

處理子識別碼

用戶端必須備妥給具有子識別碼的伺服器，而不是CHILDID_SELF。從IAccessible 取得 IAccessibleEx介面之後，如果子識別碼未CHILDID_SELF (表示父物件) ，用戶端必須呼叫IAccessibleEx：：GetObjectForChild。

下列範例示範如何取得特定 IAccessible 物件和子識別碼的 IAccessibleEx 。

   
HRESULT GetIAccessibleExFromIAccessible(IAccessible * pAcc, long idChild, 
                                           IAccessibleEx ** ppaex)
{
    *ppaex = NULL;

    // First, get IServiceProvider from the IAccessible.
    IServiceProvider * pSp = NULL;
    HRESULT hr = pAcc->QueryInterface(IID_IServiceProvider, (void **) & pSp);
    if(FAILED(hr))
        return hr;
    if(pSp == NULL)
        return E_NOINTERFACE;

    // Next, get the IAccessibleEx for the parent object.
    IAccessibleEx * paex = NULL;
    hr = pSp->QueryService(__uuidof(IAccessibleEx), __uuidof(IAccessibleEx),
                                                                 (void **)&paex);
    pSp->Release();
    if(FAILED(hr))
        return hr;
    if(paex == NULL)
        return E_NOINTERFACE;

    // If this is for CHILDID_SELF, we're done. Otherwise, we have a child ID and 
    // can request the object for child.
    if(idChild == CHILDID_SELF)
    {
        *ppaex = paex;
        return S_OK;
    }
    else
    {
        // Get the IAccessibleEx for the specified child.
        IAccessibleEx * paexChild = NULL;
        hr = paex->GetObjectForChild(idChild, &paexChild);
        paex->Release();
        if(FAILED(hr))
            return hr;
        if(paexChild == NULL)
            return E_NOINTERFACE;
        *ppaex = paexChild;
        return S_OK;
    }
}

取得 IRawElementProviderSimple 介面

如果用戶端有 IAccessibleEx 介面，可以使用 QueryInterface 來取得 IRawElementProviderSimple 介面，如下列範例所示。

HRESULT GetIRawElementProviderFromIAccessible(IAccessible * pAcc, long idChild,
                                                 IRawElementProviderSimple ** ppEl)
{
    * ppEl = NULL;

    // First, get the IAccessibleEx for the IAccessible and child ID pair.
    IAccessibleEx * paex;
    HRESULT hr = GetIAccessibleExFromIAccessible( pAcc, idChild, &paex );
    if(FAILED(hr))
        return hr;

    // Next, use QueryInterface.
    hr = paex->QueryInterface(__uuidof(IRawElementProviderSimple), (void **)ppEl);
    paex->Release();
    return hr;
}

擷取控制項模式

如果用戶端可以存取 IRawElementProviderSimple 介面，它可以擷取提供者已實作的控制項模式介面，然後在這些介面上呼叫方法。下列範例示範如何執行。

// Helper function to get a pattern interface from an IAccessible and child ID 
// pair. Gets the IAccessibleEx, then calls GetPatternObject and QueryInterface.
HRESULT GetPatternFromIAccessible(IAccessible * pAcc, long idChild,
                                     PATTERNID patternId, REFIID iid, void ** ppv)
{
    // First, get the IAccesibleEx for this IAccessible and child ID pair.
    IRawElementProviderSimple * pel;
    HRESULT hr = GetIRawElementProviderSimpleFromIAccessible(pAcc, idChild, &pel);
    if(FAILED(hr))
        return hr;
    if(pel == NULL)
        return E_NOINTERFACE;

    // Now get the pattern object.
    IUnknown * pPatternObject = NULL;
    hr = pel->GetPatternProvider(patternId, &pPatternObject);
    pel->Release();
    if(FAILED(hr))
        return hr;
    if(pPatternObject == NULL)
        return E_NOINTERFACE;

    // Finally, use QueryInterface to get the correct interface type.
    hr = pPatternObject->QueryInterface(iid, ppv);
    pPatternObject->Release();
    if(*ppv == NULL)
        return E_NOINTERFACE;
    return hr;
}

HRESULT CallInvokePatternMethod(IAccessible * pAcc, long idChild)
{
    IInvokeProvider * pPattern;
    HRESULT hr = GetPatternFromIAccessible(pAcc, varChild,
                                  UIA_InvokePatternId, __uuidof(IInvokeProvider),
                                  (void **)&pPattern);
    if(FAILED(hr))
        return hr;

    hr = pPattern->Invoke();
    pPattern->Release();
    return hr;
}

擷取屬性值

如果用戶端可以存取 IRawElementProviderSimple，它可以擷取屬性值。下列範例示範如何取得 AutomationId 和 LabeledBy Microsoft 消費者介面自動化屬性的值。

#include <initguid.h>
#include <uiautomationcoreapi.h> // Includes the UI Automation property GUID definitions.
#include <uiautomationcoreids.h> // Includes definitions of pattern/property IDs.

// Assume we already have a IRawElementProviderSimple * pEl.

VARIANT varValue;

// Get AutomationId property:
varValue.vt = VT_EMPTY;
HRESULT hr = pEl->GetPropertyValue(UIA_AutomationIdPropertyId, &varValue);
if(SUCCEEDED(hr))
{
    if(varValue.vt == VT_BSTR)
    {
        // AutomationId is varValue.bstrVal.
    }
    VariantClear(&varValue);
}


// Get LabeledBy property:
varValue.vt = VT_EMPTY;
hr = pEl->GetPropertyValue(UIA_LabeledByPropertyId, &varValue);
if(SUCCEEDED(hr))
{
    if(varValue.vt == VT_UNKNOWN || varValue.punkVal != NULL)
    {
        // Use QueryInterface to get IRawElementProviderSimple.
        IRawElementProviderSimple * pElLabel = NULL;
        hr = varValue.punkVal->QueryInterface(__uuidof(IRawElementProviderSimple),
                                              (void**)& pElLabel);
        if (SUCCEEDED(hr))
        {
            if(pElLabel != NULL)
            {
            // Use the pElLabel pointer here.
            pElLabel ->Release();
            }
        }
    }
    VariantClear(&varValue);
}

上述範例適用于未與控制項模式相關聯的屬性。若要存取控制模式屬性，用戶端必須取得並使用控制項模式介面。

從 IRawElementProviderSimple 介面擷取 IAccessible 介面

如果用戶端取得 UI 元素的 IRawElementProviderSimple 介面，用戶端可以使用該介面來取得元素的對應 IAccessible 介面。如果用戶端需要存取專案的 Microsoft Active Accessibility 屬性，這非常有用。

例如，用戶端可以藉由呼叫IRawElementProviderSimple：：GetPropertyValue與 UIA_LabeledByPropertyId) ，或是呼叫所選取 (元素的ISelectionProviderSimple 介面陣列，或呼叫所選取元素的 ISelectionProvider：：GetSelection來擷取所選取元素的IRawElementProviderSimple介面陣列，例如，取得IRawElementProviderSimple 介面，例如，藉此取得 IRawElementProviderSimple (介面，例如，藉此取得 IRawElementProviderSimple介面) 。取得 IRawElementProviderSimple 介面之後，用戶端就可以依照下列步驟來取得對應的 IAccessible ：

嘗試使用 QueryInterface 取得 IAccessibleEx 介面。
如果 QueryInterface 失敗，請在原本取得屬性的IAccessibleEx實例上呼叫IAccessibleEx：：ConvertReturnedElement。
在新的IAccessibleEx實例上呼叫GetIAccessiblePair方法，以取得IAccessible Interfae 和子識別碼。

下列程式碼片段示範如何從先前取得的IRawElementProviderSimple介面取得IAccessible介面。

// IRawElementProviderSimple * pVal - an element returned by a property or method
// from another IRawElementProviderSimple.

IAccessible * pAcc = NULL;
long idChild;

// First, try to use QueryInterface to get the IAccessibleEx interface.
IAccessibleEx * pAccEx;
HRESULT hr = pVal->QueryInterface(__uuidof(IAccessibleEx), (void**)&pAccEx);
if (SUCCEEDED(hr)
{
    if (!pAccEx)
    {
        // If QueryInterface fails, and the IRawElementProviderSimple was 
              // obtained as a property or return value from another 
              // IRawElementProviderSimple, pass it to the 
              // IAccessibleEx::ConvertReturnedValue method of the
        // originating element.

        pAccExOrig->ConvertReturnedElement(pVal, &pAccEx);
    }

    if (pAccEx)
    {
        // Call GetIAccessiblePair to get an IAccessible interface and 
              // child ID.
        pAccEx->GetIAccessiblePair(&pAcc, &idChild);
    }

    // Finally, use the IAccessible interface and child ID.
    if (pAcc)
    {
        // Use IAccessible methods to get further information about this UI
              // element, or pass it to existing code that works in terms of 
              // IAccessible.
        ...
    }
}