AutomationElement.GetCurrentPropertyValue メソッド

定義

名前空間:

System.Windows.Automation

アセンブリ:

UIAutomationClient.dll

指定したプロパティの現在の値を AutomationElement から取得します。

オーバーロード

GetCurrentPropertyValue(AutomationProperty)	この AutomationElement の指定したプロパティの値を取得します。 ターゲット ユーザー インターフェイス (UI) 要素で明示的にサポートされていないプロパティに対して、プロパティ型の適切な既定値が返されます。
GetCurrentPropertyValue(AutomationProperty, Boolean)	この AutomationElement の指定したプロパティの値を取得します。既定のプロパティを無視するように指定することもできます。

注釈

メソッドによって GetCurrentPropertyValue 返される値は、呼び出された時点で現在の値です。 値は、その後、ユーザー インターフェイス (UI) と対話する他のアプリケーションによって変更される可能性があります。

一部の形式の UI では、このメソッドではプロセス間のパフォーマンスオーバーヘッドが発生します。 アプリケーションでは、プロパティをキャッシュし、 を使用 GetCachedPropertyValueして取得することで、オーバーヘッドを集中させることができます。

GetCurrentPropertyValue(AutomationProperty)

この AutomationElement の指定したプロパティの値を取得します。 ターゲット ユーザー インターフェイス (UI) 要素で明示的にサポートされていないプロパティに対して、プロパティ型の適切な既定値が返されます。

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 オートメーション プロパティ識別子。

戻り値

Object

指定したプロパティの値が格納されているオブジェクト。

例外

ElementNotAvailableException

AutomationElement の UI はなくなりました。

例

次の例では、 プロパティの現在の値を HelpText 取得します。 要素に指定されていない場合は、既定値が返されます。

// 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 返される値は、呼び出された時点で現在の値です。 その後、UI を操作する他のアプリケーションによって値が変更される可能性があります。

要素自体の UI オートメーション プロバイダーが プロパティをサポートしている場合は、 プロパティの値が返されます。 それ以外の場合は、UI オートメーションで指定された既定のプロパティが返されます。 既定のプロパティの詳細については、 などの AcceleratorKeyPropertyのプロパティ識別子フィールドAutomationElementを参照してください。

一部の形式の UI では、このメソッドではプロセス間のパフォーマンスオーバーヘッドが発生します。 プロパティをキャッシュし、 を使用 GetCachedPropertyValueして取得することでオーバーヘッドを集中します。

GetCurrentPropertyValue(AutomationProperty, Boolean)

この AutomationElement の指定したプロパティの値を取得します。既定のプロパティを無視するように指定することもできます。

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 オートメーション プロパティ識別子。

ignoreDefaultValue

Boolean

指定したプロパティがサポートされている場合に、既定値を無視するかどうかを指定する値。

戻り値

Object

指定したプロパティの値を格納するオブジェクト。または、要素が値を提供せず、NotSupported が ignoreDefaultValue である場合は true。

例外

ElementNotAvailableException

AutomationElement の UI はなくなりました。

例

次の例では、 プロパティの現在の値を HelpText 取得しますが、要素自体がプロパティの値を提供しない場合は、 NotSupported 既定値ではなく を返すように指定します。

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

注釈

をignoreDefaultValue渡すことはfalse、 を呼び出すことAutomationElement.GetCurrentPropertyValue(AutomationProperty)と同じです。

要素自体の UI オートメーション プロバイダーが プロパティをサポートしている場合は、 プロパティの値が返されます。 それ以外の場合、 が の場合 ignoreDefaultValue は false、UI オートメーションで指定された既定のプロパティが返されます。 既定のプロパティの詳細については、 などの AcceleratorKeyPropertyのプロパティ識別子フィールドAutomationElementを参照してください。

メソッドによって GetCurrentPropertyValue 返される値は、呼び出された時点で現在の値です。 値は、その後、ユーザー インターフェイス (UI) と対話する他のアプリケーションによって変更される可能性があります。

一部の形式の UI では、このメソッドではプロセス間のパフォーマンスオーバーヘッドが発生します。 アプリケーションでは、プロパティをキャッシュし、 を使用 GetCachedPropertyValueして取得することで、オーバーヘッドを集中させることができます。