This documentation is archived and is not being maintained.

AutomationElement.IsOffscreenProperty Field

Identifies the IsOffscreen property, which indicates whether the user interface (UI) item is visible on the screen. 

Namespace:  System.Windows.Automation
Assembly:  UIAutomationClient (in UIAutomationClient.dll)

Public Shared ReadOnly IsOffscreenProperty As AutomationProperty
Dim value As AutomationProperty 

value = AutomationElement.IsOffscreenProperty

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in AutomationElementIdentifiers.

This property can also be retrieved from the Current or Cached properties.

The return value is of type Boolean, and the default value is false.

For more information about when this property is true, see IsOffscreen.

The following example retrieves the current value of the property. The default value is returned if the element does not provide one.

Dim isControlOffscreen As Boolean = _

The following example retrieves the current value of the 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.

Dim isControlOffscreen1 As Boolean 
Dim isOffscreenNoDefault As Object = autoElement.GetCurrentPropertyValue(AutomationElement.IsOffscreenProperty, True)
If isOffscreenNoDefault Is AutomationElement.NotSupported Then 
    ' TODO Handle the case where you do not wish to proceed using the default value. 
    isControlOffscreen1 = CBool(isOffscreenNoDefault)
End If

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0