IVsUIShell Interface
Collapse the table of content
Expand the table of content

IVsUIShell Interface

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)

public interface IVsUIShell

The IVsUIShell type exposes the following members.

Public methodAddNewBFNavigationItemAdds a new backward and forward navigation item.
Public methodCenterDialogOnWindowCenters the provided dialog box HWND on the parent HWND (if provided), or on the main IDE window.
Public methodCreateDocumentWindowThis method creates a document window containing the embedding indicated by the punkDocView parameter.
Public methodCreateToolWindowThis method creates a tool window containing the embedding indicated by punkDocView, or the clsidDocView parameter, if the punkDocView parameter is null.
Public methodEnableModelessEnables or disables a frame's modeless dialog box.
Public methodFindToolWindowReturns the IVsWindowFrame pointer for the requested single-instance tool window.
Public methodFindToolWindowExReturns the IVsWindowFrame pointer for the requested single- or multi-instance tool window.
Public methodGetAppNameReturns the name of the application.
Public methodGetCurrentBFNavigationItemReturns the current backward and forward navigation item.
Public methodGetDialogOwnerHwndReturns the HWND that can be used to parent modal dialogs.
Public methodGetDirectoryViaBrowseDlgBrings up the Browse dialog box to find a directory location.
Public methodGetDocumentWindowEnumReturns an enumerator that iterates through all existing document windows in the environment.
Public methodGetErrorInfoGets the text of error messages.
Public methodGetNextBFNavigationItemReturns the next backward and forward navigation item.
Public methodGetOpenFileNameViaDlgBrings up the Open dialog box to obtain an open file name.
Public methodGetPreviousBFNavigationItemReturns the previous backward and forward navigation item.
Public methodGetSaveFileNameViaDlgBrings up the Save As dialog box to save a file.
Public methodGetToolWindowEnumReturns an enumerator that iterates through all of the existing tool windows in the environment.
Public methodGetURLViaDlgBrings up Open Project From Web dialog box to obtain a URL from a user.
Public methodGetVSSysColorThis method is deprecated. Use GetVSSysColorEx instead.
Public methodOnModeChangeInternal method. Do not use.
Public methodPostExecCommandAllows asynchronous execution of commands.
Public methodPostSetFocusMenuCommandSets focus in a combo box.
Public methodRefreshPropertyBrowserMakes 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.
Public methodRemoveAdjacentBFNavigationItemRemoves an adjacent navigation item in the specified direction.
Public methodRemoveCurrentNavigationDupesRemoves navigation duplicates in backward and forward navigation.
Public methodReportErrorInfoHelper method that displays an error message to the user.
Public methodSaveDocDataToFileHelper method used by editors that implement the IVsPersistDocData interface.
Public methodSetErrorInfoHelper method that records rich information about an error.
Public methodSetForegroundWindowActivates the environment application window by calling the SetForegroundWindow Win32 API.
Public methodSetMRUComboTextAdds information to a combo box list.
Public methodSetMRUComboTextWAdds information to a combo box list.
Public methodSetToolbarVisibleInFullScreenSets the toolbar to visible when the window is in full-screen mode.
Public methodSetupToolbarCalled by VSPackage that creates a tool window in order to attach a toolbar to the tool window.
Public methodSetWaitCursorChanges the cursor to the hourglass cursor.
Public methodShowContextMenuShows the context menu for the active menu object.
Public methodShowMessageBoxManages implementation of a message box event.
Public methodTranslateAcceleratorAsACmdCauses 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.
Public methodUpdateCommandUIInforms the environment to update the state of the command bars (menus and toolbars).
Public methodUpdateDocDataIsDirtyFeedbackMakes it possible for a document data object to synchronously inform the environment when their document must be changed.

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.

Community Additions

© 2016 Microsoft