This topic has not yet been rated - Rate this topic

IVsUIShell Interface

Visual Studio 2010

This interface provides access to basic windowing functionality, including access to and creation of tool windows and document windows.

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

Syntax

C++

JScript

[InterfaceTypeAttribute()]
[GuidAttribute("B61FC35B-EEBF-4DEC-BFF1-28A2DD43C38F")]
public interface IVsUIShell

The IVsUIShell type exposes the following members.

Methods

	Name	Description
	AddNewBFNavigationItem	Adds a new backward and forward navigation item.
	CenterDialogOnWindow	Centers the provided dialog box HWND on the parent HWND (if provided), or on the main IDE window.
	CreateDocumentWindow	This method creates a document window containing the embedding indicated by the punkDocView parameter.
	CreateToolWindow	This method creates a tool window containing the embedding indicated by punkDocView, or the clsidDocView parameter, if the punkDocView parameter is null.
	EnableModeless	Enables or disables a frame's modeless dialog box.
	FindToolWindow	Returns the IVsWindowFrame pointer for the requested single-instance tool window.
	FindToolWindowEx	Returns the IVsWindowFrame pointer for the requested single- or multi-instance tool window.
	GetAppName	Returns the name of the application.
	GetCurrentBFNavigationItem	Returns the current backward and forward navigation item.
	GetDialogOwnerHwnd	Returns the HWND that can be used to parent modal dialogs.
	GetDirectoryViaBrowseDlg	Brings up the Browse dialog box to find a directory location.
	GetDocumentWindowEnum	Returns an enumerator that iterates through all existing document windows in the environment.
	GetErrorInfo	Gets the text of error messages.
	GetNextBFNavigationItem	Returns the next backward and forward navigation item.
	GetOpenFileNameViaDlg	Brings up the Open dialog box to obtain an open file name.
	GetPreviousBFNavigationItem	Returns the previous backward and forward navigation item.
	GetSaveFileNameViaDlg	Brings up the Save As dialog box to save a file.
	GetToolWindowEnum	Returns an enumerator that iterates through all of the existing tool windows in the environment.
	GetURLViaDlg	Brings up Open Project From Web dialog box to obtain a URL from a user.
	GetVSSysColor	This method is deprecated. Use GetVSSysColorEx instead.
	OnModeChange	Internal method. Do not use.
	PostExecCommand	Allows asynchronous execution of commands.
	PostSetFocusMenuCommand	Sets focus in a combo box.
	RefreshPropertyBrowser	Makes it possible for a project (or any other selected object being browsed by the Properties window) to keep the Properties window in sync with property changes without implementing IConnectionPointContainer and firing OnChanged events.
	RemoveAdjacentBFNavigationItem	Removes an adjacent navigation item in the specified direction.
	RemoveCurrentNavigationDupes	Removes navigation duplicates in backward and forward navigation.
	ReportErrorInfo	Helper method that displays an error message to the user.
	SaveDocDataToFile	Helper method used by editors that implement the IVsPersistDocData interface.
	SetErrorInfo	Helper method that records rich information about an error.
	SetForegroundWindow	Activates the environment application window by calling the SetForegroundWindow Win32 API.
	SetMRUComboText	Adds information to a combo box list.
	SetMRUComboTextW	Adds information to a combo box list.
	SetToolbarVisibleInFullScreen	Sets the toolbar to visible when the window is in full-screen mode.
	SetupToolbar	Called by VSPackage that creates a tool window in order to attach a toolbar to the tool window.
	SetWaitCursor	Changes the cursor to the hourglass cursor.
	ShowContextMenu	Shows the context menu for the active menu object.
	ShowMessageBox	Manages implementation of a message box event.
	TranslateAcceleratorAsACmd	Causes the environment to use the active key binding table to convert, if possible, a keyboard message into the appropriate command, then route the command using the usual command routing mechanism.
	UpdateCommandUI	Informs the environment to update the state of the command bars (menus and toolbars).
	UpdateDocDataIsDirtyFeedback	Makes it possible for a document data object to synchronously inform the environment when their document must be changed.

Top

Remarks

Use the service SVsUIShell to get this interface when VSPackages, projects or editors need to create or enumerate tool or document windows

Notes to Implementers

Implemented by the environment.

Reference

Microsoft.VisualStudio.Shell.Interop Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD