IVsRunningDocTableEvents.OnBeforeDocumentWindowShow Method

Article
02/04/2013

Called before displaying a document window.

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

Syntax

'Declaration
Function OnBeforeDocumentWindowShow ( _
    docCookie As UInteger, _
    fFirstShow As Integer, _
    pFrame As IVsWindowFrame _
) As Integer

int OnBeforeDocumentWindowShow(
    uint docCookie,
    int fFirstShow,
    IVsWindowFrame pFrame
)

int OnBeforeDocumentWindowShow(
    [InAttribute] unsigned int docCookie, 
    [InAttribute] int fFirstShow, 
    [InAttribute] IVsWindowFrame^ pFrame
)

abstract OnBeforeDocumentWindowShow : 
        docCookie:uint32 * 
        fFirstShow:int * 
        pFrame:IVsWindowFrame -> int

function OnBeforeDocumentWindowShow(
    docCookie : uint, 
    fFirstShow : int, 
    pFrame : IVsWindowFrame
) : int

Parameters

docCookie
Type: System.UInt32
[in] Abstract value representing the document whose window is about to be shown.

fFirstShow
Type: System.Int32
[in] Non-zero (TRUE) if the document window is being displayed for the first time.

pFrame
Type: Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame
[in] The IVsWindowFrame object representing the frame containing the document's window.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

This method is called just before the document's window is shown.

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocTableEvents::OnBeforeDocumentWindowShow(
   [in] VSCOOKIE docCookie,
   [in] BOOL fFirstShow,
   [in] IVsWindowFrame *pFrame
);

.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.