AutomationElement.IsOffscreenProperty Field

  • Reference

Definition

Namespace:
System.Windows.Automation
Assembly:
UIAutomationClient.dll

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

public: static initonly System::Windows::Automation::AutomationProperty ^ IsOffscreenProperty;
public static readonly System.Windows.Automation.AutomationProperty IsOffscreenProperty;
 staticval mutable IsOffscreenProperty : System.Windows.Automation.AutomationProperty
Public Shared ReadOnly IsOffscreenProperty As AutomationProperty

Field Value

AutomationProperty

Examples

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)
   autoElement.GetCurrentPropertyValue(AutomationElement.IsOffscreenProperty);

Dim isControlOffscreen As Boolean = _
    CBool(autoElement.GetCurrentPropertyValue(AutomationElement.IsOffscreenProperty))

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.
}
else
{
    isControlOffscreen1 = (bool)isOffscreenNoDefault;
}

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.
Else
    isControlOffscreen1 = CBool(isOffscreenNoDefault)
End If

Remarks

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.

Applies to

See also