IVsRunningDocTableEvents.OnBeforeDocumentWindowShow Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Called before displaying a document window.

public:
 int OnBeforeDocumentWindowShow(System::UInt32 docCookie, int fFirstShow, Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame ^ pFrame);

public:
 int OnBeforeDocumentWindowShow(unsigned int docCookie, int fFirstShow, Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame ^ pFrame);

int OnBeforeDocumentWindowShow(unsigned int docCookie, int fFirstShow, Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame const & pFrame);

public int OnBeforeDocumentWindowShow (uint docCookie, int fFirstShow, Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame pFrame);

abstract member OnBeforeDocumentWindowShow : uint32 * int * Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame -> int

Public Function OnBeforeDocumentWindowShow (docCookie As UInteger, fFirstShow As Integer, pFrame As IVsWindowFrame) As Integer

Parameters

docCookie: UInt32

[in] Abstract value representing the document whose window is about to be shown.

fFirstShow: Int32

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

pFrame: IVsWindowFrame

[in] The IVsWindowFrame object representing the frame containing the document's window.

Returns

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  
);

Applies to