IVsWindowFrame.IsOnScreen Method

Article
05/06/2010

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

'Déclaration
Function IsOnScreen ( _
    <OutAttribute> ByRef pfOnScreen As Integer _
) As Integer
'Utilisation
Dim instance As IVsWindowFrame
Dim pfOnScreen As Integer
Dim returnValue As Integer

returnValue = instance.IsOnScreen(pfOnScreen)

int IsOnScreen(
    out int pfOnScreen
)

int IsOnScreen(
    [OutAttribute] int% pfOnScreen
)

abstract IsOnScreen : 
        pfOnScreen:int byref -> int

function IsOnScreen(
    pfOnScreen : int
) : int

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:

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via