IVsWindowFrame.IsOnScreen(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns true if the window frame is on the screen.

public:
 int IsOnScreen([Runtime::InteropServices::Out] int % pfOnScreen);

int IsOnScreen([Runtime::InteropServices::Out] int & pfOnScreen);

public int IsOnScreen (out int pfOnScreen);

abstract member IsOnScreen : int -> int

Public Function IsOnScreen (ByRef pfOnScreen As Integer) As Integer

Parameters

pfOnScreen: Int32

[out] true if the window frame is visible on the screen.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

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.

Applies to

Compartilhar via