AutomationElement.GetRuntimeId Method

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationClient.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves the unique identifier assigned to the user interface (UI) item.

public:
 cli::array <int> ^ GetRuntimeId();

public int[] GetRuntimeId ();

member this.GetRuntimeId : unit -> int[]

Public Function GetRuntimeId () As Integer()

Returns

Int32[]

An array of integers representing the run-time identifier.

Exceptions

ElementNotAvailableException

The UI for the AutomationElement no longer exists.

Examples

The following example shows how to retrieve the run-time identifier of an AutomationElement.

// element is an AutomationElement.
int[] id = element.GetRuntimeId();

' element is an AutomationElement.
Dim id As Integer() = element.GetRuntimeId()

Remarks

The identifier is only guaranteed to be unique to the UI of the desktop on which it was generated. Identifiers can be reused over time.

The format of run-time identifiers might change in future releases. The returned identifier should be treated as an opaque value and used only for comparison; for example, to determine whether an AutomationElement is in the cache.

Applies to