GetIsOffscreen Method (MdiMergePlaceholderTool.MdiMergePlaceholderToolUiaProviderStub)

Returns a Boolean value that indicates whether the automation element is entirely scrolled out of view (for example, an item in a list box that is outside the viewport of the container object) or collapsed out of view (for example, an item in a tree view or menu, or in a minimized window). If the element has a clickable point that can cause it to receive the focus, the element is considered to be on-screen while a portion of the element is off screen.

Syntax

Visual Basic

'Declaration
 
Protected Overrides Function GetIsOffscreen( _
   ByRef isOffScreen As Boolean _
) As Boolean

C#

protected override bool GetIsOffscreen( 
   out bool isOffScreen
)

Parameters

isOffScreen

Return Value

A Boolean value that indicates whether the automation element is entirely scrolled out of view (for example, an item in a list box that is outside the viewport of the container object) or collapsed out of view (for example, an item in a tree view or menu, or in a minimized window). If the element has a clickable point that can cause it to receive the focus, the element is considered to be on-screen while a portion of the element is off screen.

Remarks

The value of the property is not affected by occlusion by other windows, or by whether the element is visible on a specific monitor.

If the IsOffscreen property is TRUE, the UI element is scrolled off-screen or collapsed. The element is temporarily hidden, yet it remains in the end-user?s perception and continues to be included in the UI model. The object can be brought back into view by scrolling, clicking a drop-down, and so on.

Objects that the end-user does not perceive at all, or that are "programmatically hidden" (for example, a dialog box that has been dismissed, but the underlining object is still cached by the application) should not be in the automation element tree in the first place (instead of setting the state of IsOffscreen to TRUE).

The IsOffscreen property has a variant type of VT_BOOL; the default value is FALSE.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2