AutomationElement.GetCurrentPropertyValue メソッド

定義

指定したプロパティの現在の値を AutomationElement から取得します。Retrieves the current value of the specified property from an AutomationElement.

オーバーロード

GetCurrentPropertyValue(AutomationProperty)

この AutomationElement の指定したプロパティの値を取得します。Retrieves the value of the specified property on this AutomationElement. ターゲットユーザー インターフェイス (UI)user interface (UI) 要素で明示的にサポートされていないプロパティに対しては、そのプロパティ型の適切な既定値が返されます。An appropriate default value for the property type is returned for properties not explicitly supported by the target ユーザー インターフェイス (UI)user interface (UI) element.

GetCurrentPropertyValue(AutomationProperty, Boolean)

この AutomationElement の指定したプロパティの値を取得します。既定のプロパティを無視するように指定することもできます。Retrieves the value of the specified property on this AutomationElement, optionally ignoring any default property.

注釈

GetCurrentPropertyValueメソッドによって返される値は、呼び出された時点で最新です。The value returned by the GetCurrentPropertyValue method is current at the time it is called. この値は、その後、 ユーザー インターフェイス (UI)user interface (UI)と対話する他のアプリケーションによって変更される可能性があります。The value can subsequently change by other applications interacting with the ユーザー インターフェイス (UI)user interface (UI).

UIUI形式によっては、この方法でプロセス間のパフォーマンスのオーバーヘッドが発生します。For some forms of UIUI, this method will incur cross-process performance overhead. アプリケーションでは、プロパティをキャッシュし、を使用GetCachedPropertyValueしてプロパティを取得することによって、オーバーヘッドに専念できます。Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty)

この AutomationElement の指定したプロパティの値を取得します。Retrieves the value of the specified property on this AutomationElement. ターゲットユーザー インターフェイス (UI)user interface (UI) 要素で明示的にサポートされていないプロパティに対しては、そのプロパティ型の適切な既定値が返されます。An appropriate default value for the property type is returned for properties not explicitly supported by the target ユーザー インターフェイス (UI)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

パラメーター

property
AutomationProperty

取得するプロパティを指定する UI オートメーションUI Automation プロパティ識別子。The UI オートメーションUI Automation property identifier specifying which property to retrieve.

戻り値

指定したプロパティの値が格納されているオブジェクト。An object containing the value of the specified property.

例外

AutomationElement の UI はなくなりました。The UI for the AutomationElement no longer exists.

次の例では、 HelpTextプロパティの現在の値を取得します。The following example retrieves the current value of the HelpText property. 既定値は、要素がを提供していない場合に返されます。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))

注釈

GetCurrentPropertyValueメソッドによって返される値は、呼び出された時点で最新です。The value returned by the GetCurrentPropertyValue method is current at the time it is called. この値は、その後、 UIUIと対話する他のアプリケーションによって変更される可能性があります。The value can subsequently change by other applications interacting with the UIUI.

要素の UI オートメーションプロバイダーがプロパティをサポートしている場合は、プロパティの値が返されます。If the UI Automation provider for the element itself supports the property, the value of the property is returned. それ以外の場合は、にUI オートメーションUI Automationよって指定された既定のプロパティが返されます。Otherwise, a default property specified by UI オートメーションUI Automation is returned. 既定のプロパティの詳細については、「」 AutomationElementなど、 AcceleratorKeyPropertyのプロパティ識別子のフィールドを参照してください。For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

UIUI形式によっては、この方法でプロセス間のパフォーマンスのオーバーヘッドが発生します。For some forms of UIUI, this method will incur cross-process performance overhead. プロパティをキャッシュし、を使用してプロパティをGetCachedPropertyValue取得することによって、オーバーヘッドを集中します。Concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty, Boolean)

この AutomationElement の指定したプロパティの値を取得します。既定のプロパティを無視するように指定することもできます。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

パラメーター

property
AutomationProperty

取得するプロパティを指定する UI オートメーションUI Automation プロパティ識別子。The UI オートメーションUI Automation property identifier specifying which property to retrieve.

ignoreDefaultValue
Boolean

指定したプロパティがサポートされている場合に、既定値を無視するかどうかを指定する値。A value that specifies whether a default value should be ignored if the specified property is supported.

戻り値

指定したプロパティの値を格納するオブジェクト。または、要素が値を提供せず、ignoreDefaultValuetrue である場合は NotSupportedAn object containing the value of the specified property, or NotSupported if the element does not supply a value and ignoreDefaultValue is true.

例外

AutomationElement の UI はなくなりました。The UI for the AutomationElement no longer exists.

次の例では、 HelpTextプロパティの現在の値を取得しますが、要素自体がプロパティの値を提供しない場合は、 NotSupported既定値の代わりにが返されることを指定します。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)

注釈

を渡すfalseことAutomationElement.GetCurrentPropertyValue(AutomationProperty)は、を呼び出すことと同じです。 ignoreDefaultValuePassing false in ignoreDefaultValue is equivalent to calling AutomationElement.GetCurrentPropertyValue(AutomationProperty).

要素の UI オートメーションプロバイダーがプロパティをサポートしている場合は、プロパティの値が返されます。If the UI Automation provider for the element itself supports the property, the value of the property is returned. それ以外のignoreDefaultValue場合false、がの場合は、 UI オートメーションUI Automationによって指定された既定のプロパティが返されます。Otherwise, if ignoreDefaultValue is false, a default property specified by UI オートメーションUI Automation is returned. 既定のプロパティの詳細については、「」 AutomationElementなど、 AcceleratorKeyPropertyのプロパティ識別子のフィールドを参照してください。For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

GetCurrentPropertyValueメソッドによって返される値は、呼び出された時点で最新です。The value returned by the GetCurrentPropertyValue method is current at the time it is called. この値は、その後、 ユーザー インターフェイス (UI)user interface (UI)と対話する他のアプリケーションによって変更される可能性があります。The value can subsequently change by other applications interacting with the ユーザー インターフェイス (UI)user interface (UI).

UIUI形式によっては、この方法でプロセス間のパフォーマンスのオーバーヘッドが発生します。For some forms of UIUI, this method will incur cross-process performance overhead. アプリケーションでは、プロパティをキャッシュし、を使用GetCachedPropertyValueしてプロパティを取得することによって、オーバーヘッドに専念できます。Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

適用対象