IVsWindowFrame::IsOnScreen Method (Int32)

Visual Studio 2015

Returns true if the window frame is on the screen.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int IsOnScreen(
	[OutAttribute] int% pfOnScreen
)

Parameters

pfOnScreen: Type: System::Int32
[out] true if the window frame is visible on the screen.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsWindowFrame::IsOnScreen(
   [out, retval] BOOL *pfOnScreen
);

IVsWindowFrame.IsOnScreen checks to see if a window hosted by the Visual Studio IDE has been autohidden, or if the window is part of a tabbed display and currently obscured by another tab. IsOnScreen also checks to see whether the instance of the Visual Studio IDE is minimized or obscured.

IsOnScreen differs from the behavior of IsWindowVisible a method that may return true even if the window is completely obscured or minimized. IsOnScreen also differs from IsVisible which does not check to see if the Visual Studio IDE has autohidden the window, or if the window is tabbed and currently obscured by another window.