VsShellUtilities Class

Provides static helper methods to use with the Visual Studio shell.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.VsShellUtilities

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public NotInheritable Class VsShellUtilities
[CLSCompliantAttribute(false)]
public static class VsShellUtilities
[CLSCompliantAttribute(false)]
public ref class VsShellUtilities abstract sealed
[<AbstractClass>]
[<Sealed>]
[<CLSCompliantAttribute(false)>]
type VsShellUtilities =  class end
public final class VsShellUtilities

The VsShellUtilities type exposes the following members.

Methods

  Name Description
Public methodStatic member ApplyListViewThemeStyles Modifies a Windows Forms ListView control to use the new Explorer style theme.
Public methodStatic member ApplyTreeViewThemeStyles(TreeView) Modifies a Windows Forms TreeView control to use the new Explorer style theme. Hot tracking is enabled by default.
Public methodStatic member ApplyTreeViewThemeStyles(TreeView, Boolean) Modifies a Windows Forms TreeView control to use the new Explorer style theme.
Public methodStatic member EmptyTaskList Empties the task list.
Public methodStatic member GetDebugMode Gets the current debug mode of the shell, for example, design mode, running mode, or break mode.
Public methodStatic member GetEnvironmentFont Retrieve the host's environment font as a Font.
Public methodStatic member GetHierarchy Gets the hierarchy node that is specified by the project GUID.
Public methodStatic member GetMiscellaneousProject(IServiceProvider) Gets the miscellaneous project from the current solution.
Public methodStatic member GetMiscellaneousProject(IServiceProvider, Boolean) Returns the miscellaneous project in a solution.
Public methodStatic member GetOutputWindowPane Gets the output window pane that is specified by the GUID.
Public methodStatic member GetProject Returns a project for the specified document.
Public methodStatic member GetRDTDocumentInfo Gets an IVsPersistDocData interface and a document cookie from the running document table for the specified document.
Public methodStatic member GetRunningDocumentContents Gets the text of the specified file, if it exists in the running document table.
Public methodStatic member GetTaskItems Obsolete. Gets a list of tasks.
Public methodStatic member GetTaskItems2 Gets a list of all task items.
Public methodStatic member GetTextView Gets the text view in the specified window frame.
Public methodStatic member GetUIHierarchyWindow Gets a window for the given GUID.
Public methodStatic member GetWindowObject Gets the window that exists in the specified window frame.
Public methodStatic member IsDocumentOpen Determines whether the specified document is open.
Public methodStatic member IsInAutomationFunction Determines whether the extensibility object is currently executing an automation operation.
Public methodStatic member IsSolutionBuilding Determines whether the build manager is busy.
Public methodStatic member IsVisualStudioInDesignMode Determines whether Visual Studio is in design mode (as opposed to run mode or debug mode).
Public methodStatic member LaunchDebugger Starts the debugger.
Public methodStatic member OpenAsMiscellaneousFile Opens the specified miscellaneous file in the specified editor.
Public methodStatic member OpenDocument(IServiceProvider, String) Opens the specified document.
Public methodStatic member OpenDocument(IServiceProvider, String, Guid, IVsUIHierarchy%, UInt32%, IVsWindowFrame%) Opens the specified document in the specified view.
Public methodStatic member OpenDocument(IServiceProvider, String, Guid, IVsUIHierarchy%, UInt32%, IVsWindowFrame%, IVsTextView%) Opens the specified document in the specified logical view.
Public methodStatic member OpenDocumentWithSpecificEditor(IServiceProvider, String, Guid, Guid) Opens the specified document by using the specified editor.
Public methodStatic member OpenDocumentWithSpecificEditor(IServiceProvider, String, Guid, Guid, IVsUIHierarchy%, UInt32%, IVsWindowFrame%) Opens the specified document by using the specified editor.
Public methodStatic member PromptYesNo Displays a message box that contains the specified title and prompts the user to respond (yes or no) to the specified message.
Public methodStatic member RenameDocument Renames the specified document.
Public methodStatic member SaveFileIfDirty(IVsTextView) If the file is dirty, saves it in the specified text view.
Public methodStatic member SaveFileIfDirty(IServiceProvider, String) Saves the specified file if it is dirty.
Public methodStatic member ShowMessageBox Displays a message box with the specified message.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Shell Namespace