IVsUIShell Interface

  • Article

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

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("B61FC35B-EEBF-4DEC-BFF1-28A2DD43C38F")> _
Public Interface IVsUIShell

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

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

[<InterfaceTypeAttribute()>]
[<GuidAttribute("B61FC35B-EEBF-4DEC-BFF1-28A2DD43C38F")>]
type IVsUIShell =  interface end

public interface IVsUIShell

The IVsUIShell type exposes the following members.

Methods

  Name Description
Public method AddNewBFNavigationItem Adds a new backward and forward navigation item.
Public method CenterDialogOnWindow Centers the provided dialog box HWND on the parent HWND (if provided), or on the main IDE window.
Public method CreateDocumentWindow This method creates a document window containing the embedding indicated by the punkDocView parameter.
Public method CreateToolWindow This method creates a tool window containing the embedding indicated by punkDocView, or the clsidDocView parameter, if the punkDocView parameter is nulla null reference (Nothing in Visual Basic).
Public method EnableModeless Enables or disables a frame's modeless dialog box.
Public method FindToolWindow Returns the IVsWindowFrame pointer for the requested single-instance tool window.
Public method FindToolWindowEx Returns the IVsWindowFrame pointer for the requested single- or multi-instance tool window.
Public method GetAppName Returns the name of the application.
Public method GetCurrentBFNavigationItem Returns the current backward and forward navigation item.
Public method GetDialogOwnerHwnd Returns the HWND that can be used to parent modal dialogs.
Public method GetDirectoryViaBrowseDlg Brings up the Browse dialog box to find a directory location.
Public method GetDocumentWindowEnum Returns an enumerator that iterates through all existing document windows in the environment.
Public method GetErrorInfo Gets the text of error messages.
Public method GetNextBFNavigationItem Returns the next backward and forward navigation item.
Public method GetOpenFileNameViaDlg Brings up the Open dialog box to obtain an open file name.
Public method GetPreviousBFNavigationItem Returns the previous backward and forward navigation item.
Public method GetSaveFileNameViaDlg Brings up the Save As dialog box to save a file.
Public method GetToolWindowEnum Returns an enumerator that iterates through all of the existing tool windows in the environment.
Public method GetURLViaDlg Brings up Open Project From Web dialog box to obtain a URL from a user.
Public method GetVSSysColor This method is deprecated. Use GetVSSysColorEx instead.
Public method OnModeChange Internal method. Do not use.
Public method PostExecCommand Allows asynchronous execution of commands.
Public method PostSetFocusMenuCommand Sets focus in a combo box.
Public method 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.
Public method RemoveAdjacentBFNavigationItem Removes an adjacent navigation item in the specified direction.
Public method RemoveCurrentNavigationDupes Removes navigation duplicates in backward and forward navigation.
Public method ReportErrorInfo Helper method that displays an error message to the user.
Public method SaveDocDataToFile Helper method used by editors that implement the IVsPersistDocData interface.
Public method SetErrorInfo Helper method that records rich information about an error.
Public method SetForegroundWindow Activates the environment application window by calling the SetForegroundWindow Win32 API.
Public method SetMRUComboText Adds information to a combo box list.
Public method SetMRUComboTextW Adds information to a combo box list.
Public method SetToolbarVisibleInFullScreen Sets the toolbar to visible when the window is in full-screen mode.
Public method SetupToolbar Called by VSPackage that creates a tool window in order to attach a toolbar to the tool window.
Public method SetWaitCursor Changes the cursor to the hourglass cursor.
Public method ShowContextMenu Shows the context menu for the active menu object.
Public method ShowMessageBox Manages implementation of a message box event.
Public method 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.
Public method UpdateCommandUI Informs the environment to update the state of the command bars (menus and toolbars).
Public method 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.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace