AutomationElement.GetCachedPropertyValue Metoda

Definicja

Przestrzeń nazw:

System.Windows.Automation

Zestaw:

UIAutomationClient.dll

Pobiera buforowana wartość określonej właściwości z obiektu AutomationElement.

Przeciążenia

GetCachedPropertyValue(AutomationProperty)	Pobiera wartość określonej właściwości z pamięci podręcznej tego AutomationElementobiektu . Odpowiednia wartość domyślna typu właściwości jest zwracana dla właściwości, które nie są jawnie obsługiwane przez docelowy element interfejsu użytkownika.
GetCachedPropertyValue(AutomationProperty, Boolean)	Pobiera wartość określonej właściwości z pamięci podręcznej tego AutomationElementobiektu , opcjonalnie ignorując dowolną właściwość domyślną.

Uwagi

GetCachedPropertyValue pobiera określoną właściwość z pamięci podręcznej obiektu AutomationElement. Aby pobrać bieżącą właściwość, wywołaj metodę GetCurrentPropertyValue.

GetCachedPropertyValue(AutomationProperty)

Pobiera wartość określonej właściwości z pamięci podręcznej tego AutomationElementobiektu . Odpowiednia wartość domyślna typu właściwości jest zwracana dla właściwości, które nie są jawnie obsługiwane przez docelowy element interfejsu użytkownika.

public:
 System::Object ^ GetCachedPropertyValue(System::Windows::Automation::AutomationProperty ^ property);

public object GetCachedPropertyValue (System.Windows.Automation.AutomationProperty property);

member this.GetCachedPropertyValue : System.Windows.Automation.AutomationProperty -> obj

Public Function GetCachedPropertyValue (property As AutomationProperty) As Object

Parametry

property

AutomationProperty

Identyfikator właściwości do pobrania.

Zwraca

Object

Obiekt zawierający wartość określonej właściwości.

Wyjątki

InvalidOperationException

Żądana właściwość nie znajduje się w pamięci podręcznej.

ElementNotAvailableException

Interfejs użytkownika dla interfejsu AutomationElement użytkownika już nie istnieje.

Przykłady

Poniżej przedstawiono sposób użycia tej metody do pobierania właściwości buforowanej.

/// <summary>
/// Caches and retrieves properties for a list item by using CacheRequest.Push.
/// </summary>
/// <param name="autoElement">Element from which to retrieve a child element.</param>
/// <remarks>
/// This code demonstrates various aspects of caching. It is not intended to be 
/// an example of a useful method.
/// </remarks>
private void CachePropertiesByPush(AutomationElement elementList)
{
    // Set up the request.
    CacheRequest cacheRequest = new CacheRequest();

    // Do not get a full reference to the cached objects, only to their cached properties and patterns.
    cacheRequest.AutomationElementMode = AutomationElementMode.None;

    // Cache all elements, regardless of whether they are control or content elements.
    cacheRequest.TreeFilter = Automation.RawViewCondition;

    // Property and pattern to cache.
    cacheRequest.Add(AutomationElement.NameProperty);
    cacheRequest.Add(SelectionItemPattern.Pattern);

    // Activate the request.
    cacheRequest.Push();

    // Obtain an element and cache the requested items.
    Condition cond = new PropertyCondition(AutomationElement.IsSelectionItemPatternAvailableProperty, true);
    AutomationElement elementListItem = elementList.FindFirst(TreeScope.Children, cond);

    // At this point, you could call another method that creates a CacheRequest and calls Push/Pop.
    // While that method was retrieving automation elements, the CacheRequest set in this method 
    // would not be active. 

    // Deactivate the request.
    cacheRequest.Pop();

    // Retrieve the cached property and pattern.
    String itemName = elementListItem.Cached.Name;
    SelectionItemPattern pattern = elementListItem.GetCachedPattern(SelectionItemPattern.Pattern) as SelectionItemPattern;

    // The following is an alternative way of retrieving the Name property.
    itemName = elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty) as String;

    // This is yet another way, which returns AutomationElement.NotSupported if the element does
    // not supply a value. If the second parameter is false, a default name is returned.
    object objName = elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty, true);
    if (objName == AutomationElement.NotSupported)
    {
        itemName = "Unknown";
    }
    else
    {
        itemName = objName as String;
    }

    // The following call raises an exception, because only the cached properties are available, 
    //  as specified by cacheRequest.AutomationElementMode. If AutomationElementMode had its
    //  default value (Full), this call would be valid.
    /*** bool enabled = elementListItem.Current.IsEnabled; ***/
}

''' <summary>
''' Caches and retrieves properties for a list item by using CacheRequest.Push.
''' </summary>
''' <param name="elementList">Element from which to retrieve a child element.</param>
''' <remarks>
''' This code demonstrates various aspects of caching. It is not intended to be 
''' an example of a useful method.
''' </remarks>
Private Sub CachePropertiesByPush(ByVal elementList As AutomationElement)
    ' Set up the request.
    Dim cacheRequest As New CacheRequest()

    ' Do not get a full reference to the cached objects, only to their cached properties and patterns.
    cacheRequest.AutomationElementMode = AutomationElementMode.None

    ' Cache all elements, regardless of whether they are control or content elements.
    cacheRequest.TreeFilter = Automation.RawViewCondition

    ' Property and pattern to cache.
    cacheRequest.Add(AutomationElement.NameProperty)
    cacheRequest.Add(SelectionItemPattern.Pattern)

    ' Activate the request.
    cacheRequest.Push()

    ' Obtain an element and cache the requested items.
    Dim myCondition As New PropertyCondition(AutomationElement.IsSelectionItemPatternAvailableProperty, _
        True)
    Dim elementListItem As AutomationElement = elementList.FindFirst(TreeScope.Children, myCondition)

    ' At this point, you could call another method that creates a CacheRequest and calls Push/Pop.
    ' While that method was retrieving automation elements, the CacheRequest set in this method 
    ' would not be active. 
    ' Deactivate the request.
    cacheRequest.Pop()

    ' Retrieve the cached property and pattern.
    Dim itemName As String = elementListItem.Cached.Name
    Dim pattern As SelectionItemPattern = _
        DirectCast(elementListItem.GetCachedPattern(SelectionItemPattern.Pattern), SelectionItemPattern)

    ' The following is an alternative way of retrieving the Name property.
    itemName = CStr(elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty))

    ' This is yet another way, which returns AutomationElement.NotSupported if the element does
    ' not supply a value. If the second parameter is false, a default name is returned.
    Dim objName As Object = elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty, True)
    If objName Is AutomationElement.NotSupported Then
        itemName = "Unknown"
    Else
        itemName = CStr(objName)
    End If
    ' The following call raises an exception, because only the cached properties are available, 
    '  as specified by cacheRequest.AutomationElementMode. If AutomationElementMode had its
    '  default value (Full), this call would be valid.
    '** bool enabled = elementListItem.Current.IsEnabled; **

End Sub

Uwagi

Jeśli dostawca automatyzacja interfejsu użytkownika dla samego elementu obsługuje właściwość, zwracana jest wartość właściwości. W przeciwnym razie zwracana jest właściwość domyślna określona przez automatyzacja interfejsu użytkownika. Aby uzyskać informacje na temat właściwości domyślnych, zobacz pola identyfikatora właściwości , AutomationElementtakie jak AcceleratorKeyProperty.

GetCachedPropertyValue pobiera określoną właściwość z pamięci podręcznej AutomationElement. Aby pobrać bieżący obiekt dla określonego wywołania GetCurrentPropertyValuewłaściwości .

Ta metoda zgłasza wyjątek, jeśli żądana właściwość nie została wcześniej buforowana.

GetCachedPropertyValue(AutomationProperty, Boolean)

Pobiera wartość określonej właściwości z pamięci podręcznej tego AutomationElementobiektu , opcjonalnie ignorując dowolną właściwość domyślną.

public:
 System::Object ^ GetCachedPropertyValue(System::Windows::Automation::AutomationProperty ^ property, bool ignoreDefaultValue);

public object GetCachedPropertyValue (System.Windows.Automation.AutomationProperty property, bool ignoreDefaultValue);

member this.GetCachedPropertyValue : System.Windows.Automation.AutomationProperty * bool -> obj

Public Function GetCachedPropertyValue (property As AutomationProperty, ignoreDefaultValue As Boolean) As Object

Parametry

property

AutomationProperty

Identyfikator właściwości do pobrania.

ignoreDefaultValue

Boolean

Wartość określająca, czy wartość domyślna powinna być ignorowana, jeśli określona właściwość nie jest obsługiwana.

Zwraca

Object

Obiekt zawierający wartość określonej właściwości lub NotSupported jeśli element nie dostarcza wartości i ignoreDefaultValue jest true.

Wyjątki

InvalidOperationException

Żądana właściwość nie znajduje się w pamięci podręcznej.

ElementNotAvailableException

Interfejs użytkownika dla AutomationElement obiektu już nie istnieje.

Przykłady

W poniższym przykładzie pokazano, jak można użyć tej metody do pobrania właściwości buforowanej.

/// <summary>
/// Caches and retrieves properties for a list item by using CacheRequest.Push.
/// </summary>
/// <param name="autoElement">Element from which to retrieve a child element.</param>
/// <remarks>
/// This code demonstrates various aspects of caching. It is not intended to be 
/// an example of a useful method.
/// </remarks>
private void CachePropertiesByPush(AutomationElement elementList)
{
    // Set up the request.
    CacheRequest cacheRequest = new CacheRequest();

    // Do not get a full reference to the cached objects, only to their cached properties and patterns.
    cacheRequest.AutomationElementMode = AutomationElementMode.None;

    // Cache all elements, regardless of whether they are control or content elements.
    cacheRequest.TreeFilter = Automation.RawViewCondition;

    // Property and pattern to cache.
    cacheRequest.Add(AutomationElement.NameProperty);
    cacheRequest.Add(SelectionItemPattern.Pattern);

    // Activate the request.
    cacheRequest.Push();

    // Obtain an element and cache the requested items.
    Condition cond = new PropertyCondition(AutomationElement.IsSelectionItemPatternAvailableProperty, true);
    AutomationElement elementListItem = elementList.FindFirst(TreeScope.Children, cond);

    // At this point, you could call another method that creates a CacheRequest and calls Push/Pop.
    // While that method was retrieving automation elements, the CacheRequest set in this method 
    // would not be active. 

    // Deactivate the request.
    cacheRequest.Pop();

    // Retrieve the cached property and pattern.
    String itemName = elementListItem.Cached.Name;
    SelectionItemPattern pattern = elementListItem.GetCachedPattern(SelectionItemPattern.Pattern) as SelectionItemPattern;

    // The following is an alternative way of retrieving the Name property.
    itemName = elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty) as String;

    // This is yet another way, which returns AutomationElement.NotSupported if the element does
    // not supply a value. If the second parameter is false, a default name is returned.
    object objName = elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty, true);
    if (objName == AutomationElement.NotSupported)
    {
        itemName = "Unknown";
    }
    else
    {
        itemName = objName as String;
    }

    // The following call raises an exception, because only the cached properties are available, 
    //  as specified by cacheRequest.AutomationElementMode. If AutomationElementMode had its
    //  default value (Full), this call would be valid.
    /*** bool enabled = elementListItem.Current.IsEnabled; ***/
}

''' <summary>
''' Caches and retrieves properties for a list item by using CacheRequest.Push.
''' </summary>
''' <param name="elementList">Element from which to retrieve a child element.</param>
''' <remarks>
''' This code demonstrates various aspects of caching. It is not intended to be 
''' an example of a useful method.
''' </remarks>
Private Sub CachePropertiesByPush(ByVal elementList As AutomationElement)
    ' Set up the request.
    Dim cacheRequest As New CacheRequest()

    ' Do not get a full reference to the cached objects, only to their cached properties and patterns.
    cacheRequest.AutomationElementMode = AutomationElementMode.None

    ' Cache all elements, regardless of whether they are control or content elements.
    cacheRequest.TreeFilter = Automation.RawViewCondition

    ' Property and pattern to cache.
    cacheRequest.Add(AutomationElement.NameProperty)
    cacheRequest.Add(SelectionItemPattern.Pattern)

    ' Activate the request.
    cacheRequest.Push()

    ' Obtain an element and cache the requested items.
    Dim myCondition As New PropertyCondition(AutomationElement.IsSelectionItemPatternAvailableProperty, _
        True)
    Dim elementListItem As AutomationElement = elementList.FindFirst(TreeScope.Children, myCondition)

    ' At this point, you could call another method that creates a CacheRequest and calls Push/Pop.
    ' While that method was retrieving automation elements, the CacheRequest set in this method 
    ' would not be active. 
    ' Deactivate the request.
    cacheRequest.Pop()

    ' Retrieve the cached property and pattern.
    Dim itemName As String = elementListItem.Cached.Name
    Dim pattern As SelectionItemPattern = _
        DirectCast(elementListItem.GetCachedPattern(SelectionItemPattern.Pattern), SelectionItemPattern)

    ' The following is an alternative way of retrieving the Name property.
    itemName = CStr(elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty))

    ' This is yet another way, which returns AutomationElement.NotSupported if the element does
    ' not supply a value. If the second parameter is false, a default name is returned.
    Dim objName As Object = elementListItem.GetCachedPropertyValue(AutomationElement.NameProperty, True)
    If objName Is AutomationElement.NotSupported Then
        itemName = "Unknown"
    Else
        itemName = CStr(objName)
    End If
    ' The following call raises an exception, because only the cached properties are available, 
    '  as specified by cacheRequest.AutomationElementMode. If AutomationElementMode had its
    '  default value (Full), this call would be valid.
    '** bool enabled = elementListItem.Current.IsEnabled; **

End Sub

Uwagi

GetCachedPropertyValue pobiera określoną właściwość z pamięci podręcznej dla elementu AutomationElement. Aby pobrać bieżącą właściwość, wywołaj metodę GetCurrentPropertyValue.

Przekazywanie falseignoreDefaultValue jest równoważne wywołaniu metody AutomationElement.GetCachedPropertyValue(AutomationProperty).

Jeśli dostawca automatyzacja interfejsu użytkownika dla samego elementu obsługuje właściwość, zwracana jest wartość właściwości. W przeciwnym razie zwracana ignoreDefaultValue jest falsewłaściwość domyślna określona przez automatyzacja interfejsu użytkownika. Aby uzyskać informacje na temat właściwości domyślnych, zobacz pola identyfikatora właściwości , AutomationElementtakie jak AcceleratorKeyProperty.

Ta metoda zgłasza wyjątek, jeśli żądana właściwość nie została wcześniej buforowana.