AutomationElement.GetCurrentPropertyValue Método

Definição

Recupera o valor atual da propriedade especificada de um AutomationElement.Retrieves the current value of the specified property from an AutomationElement.

Sobrecargas

GetCurrentPropertyValue(AutomationProperty)

Recupera o valor da propriedade especificada neste AutomationElement.Retrieves the value of the specified property on this AutomationElement. Um valor padrão apropriado para o tipo de propriedade é retornado para propriedades que não têm suporte explícito pelo elemento UI (interface do usuário)user interface (UI) de destino.An appropriate default value for the property type is returned for properties not explicitly supported by the target UI (interface do usuário)user interface (UI) element.

GetCurrentPropertyValue(AutomationProperty, Boolean)

Recupera o valor da propriedade especificada neste AutomationElement, opcionalmente, ignorando a propriedade padrão.Retrieves the value of the specified property on this AutomationElement, optionally ignoring any default property.

Comentários

O valor retornado pelo GetCurrentPropertyValue método é atual no momento em que é chamado.The value returned by the GetCurrentPropertyValue method is current at the time it is called. O valor pode posteriormente ser alterado por outros aplicativos que interagem UI (interface do usuário)user interface (UI)com o.The value can subsequently change by other applications interacting with the UI (interface do usuário)user interface (UI).

Para algumas formas do Interface de UsuárioUI, esse método incorrerá em sobrecarga de desempenho entre processos.For some forms of Interface de UsuárioUI, this method will incur cross-process performance overhead. Os aplicativos podem concentrar a sobrecarga armazenando as propriedades em cache e, GetCachedPropertyValueem seguida, recuperando-as usando.Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty)

Recupera o valor da propriedade especificada neste AutomationElement.Retrieves the value of the specified property on this AutomationElement. Um valor padrão apropriado para o tipo de propriedade é retornado para propriedades que não têm suporte explícito pelo elemento UI (interface do usuário)user interface (UI) de destino.An appropriate default value for the property type is returned for properties not explicitly supported by the target UI (interface do usuário)user interface (UI) element.

public:
 System::Object ^ GetCurrentPropertyValue(System::Windows::Automation::AutomationProperty ^ property);
public object GetCurrentPropertyValue (System.Windows.Automation.AutomationProperty property);
member this.GetCurrentPropertyValue : System.Windows.Automation.AutomationProperty -> obj
Public Function GetCurrentPropertyValue (property As AutomationProperty) As Object

Parâmetros

property
AutomationProperty

O identificador da propriedade Automação da interface do usuárioUI Automation que especifica qual propriedade será recuperada.The Automação da interface do usuárioUI Automation property identifier specifying which property to retrieve.

Retornos

Um objeto que contém o valor da propriedade especificada.An object containing the value of the specified property.

Exceções

A interface do usuário do AutomationElement não existe mais.The UI for the AutomationElement no longer exists.

Exemplos

O exemplo a seguir recupera o valor atual da HelpText propriedade.The following example retrieves the current value of the HelpText property. O valor padrão será retornado se o elemento não fornecer um.The default value is returned if the element does not provide one.

// elementList is an AutomationElement.
string helpString =
    elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty) as string;
' elementList is an AutomationElement.
Dim helpString As String = _
    CStr(elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty))

Comentários

O valor retornado pelo GetCurrentPropertyValue método é atual no momento em que é chamado.The value returned by the GetCurrentPropertyValue method is current at the time it is called. O valor pode posteriormente ser alterado por outros aplicativos que interagem Interface de UsuárioUIcom o.The value can subsequently change by other applications interacting with the Interface de UsuárioUI.

Se o provedor de automação da interface do usuário para o elemento em si der suporte à propriedade, o valor da propriedade será retornado.If the UI Automation provider for the element itself supports the property, the value of the property is returned. Caso contrário, uma propriedade padrão especificada Automação da interface do usuárioUI Automation por será retornada.Otherwise, a default property specified by Automação da interface do usuárioUI Automation is returned. Para obter informações sobre as propriedades padrão, consulte os campos de AutomationElementidentificador de propriedade AcceleratorKeyPropertydo, como.For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

Para algumas formas do Interface de UsuárioUI, esse método incorrerá em sobrecarga de desempenho entre processos.For some forms of Interface de UsuárioUI, this method will incur cross-process performance overhead. Concentre a sobrecarga armazenando as propriedades em cache e, em GetCachedPropertyValueseguida, recuperando-as usando.Concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty, Boolean)

Recupera o valor da propriedade especificada neste AutomationElement, opcionalmente, ignorando a propriedade padrão.Retrieves the value of the specified property on this AutomationElement, optionally ignoring any default property.

public:
 System::Object ^ GetCurrentPropertyValue(System::Windows::Automation::AutomationProperty ^ property, bool ignoreDefaultValue);
public object GetCurrentPropertyValue (System.Windows.Automation.AutomationProperty property, bool ignoreDefaultValue);
member this.GetCurrentPropertyValue : System.Windows.Automation.AutomationProperty * bool -> obj
Public Function GetCurrentPropertyValue (property As AutomationProperty, ignoreDefaultValue As Boolean) As Object

Parâmetros

property
AutomationProperty

O identificador da propriedade Automação da interface do usuárioUI Automation que especifica qual propriedade será recuperada.The Automação da interface do usuárioUI Automation property identifier specifying which property to retrieve.

ignoreDefaultValue
Boolean

Um valor que especifica se um valor padrão deverá ser ignorado se houver suporte para a propriedade especificada.A value that specifies whether a default value should be ignored if the specified property is supported.

Retornos

Um objeto que contém o valor da propriedade especificada ou NotSupported, se o elemento não fornecer um valor e ignoreDefaultValue for true.An object containing the value of the specified property, or NotSupported if the element does not supply a value and ignoreDefaultValue is true.

Exceções

A interface do usuário do AutomationElement não existe mais.The UI for the AutomationElement no longer exists.

Exemplos

O exemplo a seguir recupera o valor atual da HelpText Propriedade, mas Especifica que se o elemento não fornecer um valor para a propriedade, NotSupported será retornado em vez de um valor padrão.The following example retrieves the current value of the HelpText property, but specifies that if the element itself does not provide a value for the property, NotSupported is to be returned instead of a default value.

// elementList is an AutomationElement.
object help = elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty, true);
if (help == AutomationElement.NotSupported)
{
    help = "No help available";
}
string helpText = (string)help;
' elementList is an AutomationElement.
Dim help As Object = elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty, True)
If help Is AutomationElement.NotSupported Then
    help = "No help available"
End If
Dim helpText As String = CStr(help)

Comentários

A passagem falseéequivalente à chamada AutomationElement.GetCurrentPropertyValue(AutomationProperty). ignoreDefaultValuePassing false in ignoreDefaultValue is equivalent to calling AutomationElement.GetCurrentPropertyValue(AutomationProperty).

Se o provedor de automação da interface do usuário para o elemento em si der suporte à propriedade, o valor da propriedade será retornado.If the UI Automation provider for the element itself supports the property, the value of the property is returned. Caso contrário, ignoreDefaultValue se falsefor, uma propriedade padrão especificada Automação da interface do usuárioUI Automation por será retornada.Otherwise, if ignoreDefaultValue is false, a default property specified by Automação da interface do usuárioUI Automation is returned. Para obter informações sobre as propriedades padrão, consulte os campos de AutomationElementidentificador de propriedade AcceleratorKeyPropertydo, como.For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

O valor retornado pelo GetCurrentPropertyValue método é atual no momento em que é chamado.The value returned by the GetCurrentPropertyValue method is current at the time it is called. O valor pode posteriormente ser alterado por outros aplicativos que interagem UI (interface do usuário)user interface (UI)com o.The value can subsequently change by other applications interacting with the UI (interface do usuário)user interface (UI).

Para algumas formas do Interface de UsuárioUI, esse método incorrerá em sobrecarga de desempenho entre processos.For some forms of Interface de UsuárioUI, this method will incur cross-process performance overhead. Os aplicativos podem concentrar a sobrecarga armazenando as propriedades em cache e, GetCachedPropertyValueem seguida, recuperando-as usando.Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

Aplica-se a