IVsRunningDocTableEvents.OnBeforeDocumentWindowShow Method

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
'Usage
Dim instance As IVsRunningDocTableEvents 
Dim docCookie As UInteger 
Dim fFirstShow As Integer 
Dim pFrame As IVsWindowFrame 
Dim returnValue As Integer 

returnValue = instance.OnBeforeDocumentWindowShow(docCookie, _
    fFirstShow, pFrame)
int OnBeforeDocumentWindowShow(
    uint docCookie,
    int fFirstShow,
    IVsWindowFrame pFrame
)
int OnBeforeDocumentWindowShow(
    [InAttribute] unsigned int docCookie, 
    [InAttribute] int fFirstShow, 
    [InAttribute] IVsWindowFrame^ pFrame
)
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.

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

See Also

Reference

IVsRunningDocTableEvents Interface

IVsRunningDocTableEvents Members

Microsoft.VisualStudio.Shell.Interop Namespace