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 static readonly AutomationProperty IsOffscreenProperty
public static final AutomationProperty IsOffscreenProperty
public static final var IsOffscreenProperty : AutomationProperty
Not applicable.

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.

bool isControlOffscreen = (bool)

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.

bool isControlOffscreen1;
object isOffscreenNoDefault =
    autoElement.GetCurrentPropertyValue(AutomationElement.IsOffscreenProperty, true);
if (isOffscreenNoDefault == AutomationElement.NotSupported)
    // TODO Handle the case where you do not wish to proceed using the default value.
    isControlOffscreen1 = (bool)isOffscreenNoDefault;

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0