AutomationElement.GetCurrentPropertyValue Método

Definição

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Recupera o valor atual da propriedade especificada de um AutomationElement.

Sobrecargas

Nome	Description
GetCurrentPropertyValue(AutomationProperty)	Recupera o valor da propriedade especificada neste AutomationElement. Um valor padrão apropriado para o tipo de propriedade é retornado para propriedades que não são explicitamente compatíveis com o elemento de interface do usuário de destino.
GetCurrentPropertyValue(AutomationProperty, Boolean)	Recupera o valor da propriedade especificada nessa AutomationElementpropriedade, opcionalmente ignorando qualquer propriedade padrão.

Comentários

O valor retornado pelo GetCurrentPropertyValue método é atual no momento em que é chamado. O valor pode ser alterado posteriormente por outros aplicativos que interagem com a interface do usuário (interface do usuário).

Para algumas formas de interface do usuário, esse método incorrerá em sobrecarga de desempenho entre processos. Os aplicativos podem concentrar a sobrecarga armazenando em cache as propriedades e, em seguida, recuperando-as usando GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty)

Recupera o valor da propriedade especificada neste AutomationElement. Um valor padrão apropriado para o tipo de propriedade é retornado para propriedades que não são explicitamente compatíveis com o elemento de interface do usuário de destino.

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 de propriedade de Automação da Interface do Usuário que especifica qual propriedade deve ser recuperada.

Retornos

Object

Um objeto que contém o valor da propriedade especificada.

Exceções

ElementNotAvailableException

A interface do usuário para o AutomationElement não existe mais.

Exemplos

O exemplo a seguir recupera o valor atual da HelpText propriedade. O valor padrão será retornado se o elemento não fornecer um.

// 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. O valor pode ser alterado posteriormente por outros aplicativos interagindo com a interface do usuário.

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. Caso contrário, uma propriedade padrão especificada pela Automação da Interface do Usuário será retornada. Para obter informações sobre propriedades padrão, consulte os campos do identificador de propriedade de AutomationElement, como AcceleratorKeyProperty.

Para algumas formas de interface do usuário, esse método incorrerá em sobrecarga de desempenho entre processos. Concentre a sobrecarga armazenando em cache as propriedades e, em seguida, recuperando-as usando GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty, Boolean)

Recupera o valor da propriedade especificada nessa AutomationElementpropriedade, opcionalmente ignorando qualquer propriedade padrão.

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 de propriedade de Automação da Interface do Usuário que especifica qual propriedade deve ser recuperada.

ignoreDefaultValue

Boolean

Um valor que especifica se um valor padrão deve ser ignorado se a propriedade especificada tiver suporte.

Retornos

Object

Um objeto que contém o valor da propriedade especificada ou NotSupported se o elemento não fornece um valor e ignoreDefaultValue é true.

Exceções

ElementNotAvailableException

A interface do usuário para o AutomationElement não existe mais.

Exemplos

O exemplo a seguir recupera o valor atual da HelpText propriedade, mas especifica que, se o elemento em si não fornecer um valor para a propriedade, NotSupported será retornado em vez de um valor padrão.

// 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

ignoreDefaultValue Passar false é equivalente a chamar 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. Caso contrário, se ignoreDefaultValue for false, uma propriedade padrão especificada pela Automação da Interface do Usuário será retornada. Para obter informações sobre propriedades padrão, consulte os campos do identificador de propriedade de AutomationElement, como AcceleratorKeyProperty.

O valor retornado pelo GetCurrentPropertyValue método é atual no momento em que é chamado. O valor pode ser alterado posteriormente por outros aplicativos que interagem com a interface do usuário (interface do usuário).

Para algumas formas de interface do usuário, esse método incorrerá em sobrecarga de desempenho entre processos. Os aplicativos podem concentrar a sobrecarga armazenando em cache as propriedades e, em seguida, recuperando-as usando GetCachedPropertyValue.