Microsoft.VisualStudio.Shell Namespace

  • Article

Classes

  Class Description
Public class ActivityLog Provides methods for logging messages to the IVsActivityLog.
Public class CommonMessagePump Allows callers to block the current thread until a handle or handles have been signaled.
Public class DefaultRegistryRootAttribute Defines the default registry root used to register VSPackage information. This class cannot be inherited.
Public class DesignPropertyDescriptor A specialization of PropertyDescriptor that allows customization of the display name of the property in the property grid.
Public class DialogContainerWithToolbar Use this class to implement modal forms in Visual Studio. The implementation enables the form to host a Visual Studio command bar so that it participates in standard command routing.
Public class DialogPage Provides a standard dialog box functionality for implementing Toolbox property sheets, ToolsOptions pages, or custom UI dialog boxes, with support for the Visual Studio automation model, Windows Forms, and state persistence by using the Visual Studio settings mechanism.
Protected class DialogPage.PageApplyEventArgs Event arguments that allow the OnApply method to indicate how to handle the apply event.
Public class EnumerableComCollection<TComEnumerator, TEnumerated> Provides a generic base class for types that provide an IEnumerable wrapper around COM-style IEnumXXX interfaces.
Public class ErrorListProvider This task provider is used to provide tasks for the Visual Studio Error List window.
Public class ErrorTask Represents an error task on the Task List. This class implements IVsErrorItem.
Public class EventSinkCollection Maps objects to and from event "cookies" that represent a client's registration with an event provider.
Public class InstalledProductRegistrationAttribute Provides information for the Visual Studio splash screen and the Help About dialog box when applied to a Package-derived class or a class that implements IVsPackage. This class cannot be inherited.
Public class LocalizableProperties LocalizableProperties provides a class that supplies custom type information on localizable properties for an object.
Public class LocDisplayNameAttribute Specifies the localizable display name for a property, event, or public void method which takes no arguments.
Public class MsiComponentIdAttribute Defines the Windows Installer component ID. The component ID is used by the Windows Installer to indicate the installation path to the VSPackage.
Public class MsiTokenAttribute Defines a token string for the MSI installer.
Public class OleDataObject Provides a managed class that implements the IOleDataObject interface.
Public class OleMenuCmdEventArgs The set of arguments passed to an OleMenuCommand object when the Invoke function is called.
Public class OleMenuCommand Represents a menu command in Visual Studio.
Public class OleMenuCommandService This class derives from the MenuCommandService class and implements IOleCommandTarget. MenuCommandService is the managed class used to add handlers for menu commands and to define verbs.
Public class Package Provides a managed implementation of the interfaces required to create a fully functional VSPackage.
Public class PackageRegistrationAttribute Modify your class that implements IVsPackage by using this attribute so that the registration tool, RegPkg.exe, will look for additional attributes. For more information, see Registering VSPackages.
Public class PackageUtilities A set of static utilities for filenames, paths, enumeration/string conversions, images, and other functions.
Public class PropertyPageTypeConverterAttribute The class representing the attribute describing how to convert property values on property pages in a package. Use this attribute rather than TypeConverterAttribute.
Public class ProvideAssemblyFilterAttribute Describes the assemblies that the IConfigureToolboxItem class supports.
Public class ProvideAutoLoadAttribute Apply this attribute to your VSPackage class to cause it to be automatically loaded when a specified UI context is active. This class cannot be inherited.
Public class ProvideAutomationObjectAttribute Modifying your Package-derived class with this attribute declares that it provides a particular automation object.
Public class ProvideEditorExtensionAttribute Associates a file extension to a given editor factory when applied to a class that inherits from Package or implements the interface IVsPackage.
Public class ProvideEditorFactoryAttribute This attribute declares that the VSPackage provides an editor factory.
Public class ProvideEditorLogicalViewAttribute Adds a logical view to the editor created by an editor factory.
Public class ProvideExtenderAttribute Provides an extender for Visual Studio. This class cannot be inherited.
Public class ProvideKeyBindingTableAttribute Provides a key binding table GUID.
Public class ProvideLanguageCodeExpansionAttribute Registers language service support for code snippets.
Public class ProvideLanguageEditorOptionPageAttribute Provide a general method for setting a language service's editor tool option page.
Public class ProvideLanguageEditorToolsOptionCategoryAttribute This attribute is used to declare a Tools Option category for a language.
Public class ProvideLanguageExtensionAttribute Associates a file extension with a particular language service.
Public class ProvideLanguageServiceAttribute Informs Visual Studio that a VSPackage provides a language service. Used with the managed package framework (MPF).
Public class ProvideLoadKeyAttribute This attribute provides a package load key for your package. Not needed in Visual Studio 2010.
Public class ProvideMenuResourceAttribute Provides registration information about menu resources used in a VSPackage. This class cannot be inherited.
Public class ProvideObjectAttribute Informs Visual Studio that the VSPackage provides an object that can be created from the ILocalRegistryinterface. This class cannot be inherited.
Public class ProvideOptionDialogPageAttribute The base class for all the attributes that are used to register an option page.
Public class ProvideOptionPageAttribute Apply this attribute to independent objects to allow users to configure VSPackages through a custom Tools Options page.
Public class ProvideProfileAttribute Apply this attribute to independent objects used to implement a VSPackage's Visual Studio settings support.
Public class ProvideProjectFactoryAttribute ProvideProjectFactoryAttribute declares that a package provides a project factory.
Public class ProvideProjectItemAttribute This attribute registers items to be included in the Add New Item dialog for the specified project type. It is placed on a VSPackage.
Public class ProvideServiceAttribute This attribute indicates that the package proffers a service when applied to a subclass of Package or a class that implements IVsPackage.
Public class ProvideStaticToolboxGroupAttribute This attribute declares a toolbox group which will be created on toolbox initialization.
Public class ProvideStaticToolboxItemAttribute This attribute declares a toolbox item which the toolbox will read from the registry. See the comments on IVsToolboxItemProvider for more details.
Public class ProvideToolboxFormatAttribute Apply this attribute to classes implementing VSPackages to declare that the VSPackage provides Toolbox items with the specified clipboard format and to enable drag-and-drop support in the Visual Studio Toolbox.
Public class ProvideToolboxItemConfigurationAttribute Registers a VSPackage as supplying a particular implementation of IConfigureToolboxItem. Used in conjunction with ProvideAssemblyFilterAttribute.
Public class ProvideToolboxItemsAttribute Apply this attribute to classes implementing VSPackages to declare if they offer a set of items to the Visual Studio Toolbox.
Public class ProvideToolboxPageAttribute Registers a VSPackage as providing one or more dialog pages in the Customize Toolbox dialog page of the Visual Studio IDE.
Public class ProvideToolWindowAttribute Notifies Visual Studio that a VSPackage owns a tool window.
Public class ProvideToolWindowVisibilityAttribute Maps a tool window to one or more UI contexts, so that the window is displayed when the user switches to one of those contexts and is hidden when the user switches away from one of the contexts.
Public class ProvideViewAttribute This attribute declares that an editor factory class offers a particular logical view.
Public class RegisterAutoLoadAttribute Obsolete. Registers the VSPackage as an extender that is automatically loaded in response to a particular context GUID. This class cannot be inherited.
Public class RegisterEditorExtensionAttribute Obsolete. See ProvideEditorExtensionAttribute. Registers a file extension with a given editor factory. This class cannot be inherited.
Public class RegisterEditorLogicalViewAttribute Obsolete. Adds a logical view to the editor created by an editor factory. This attribute has been deprecated. Please use ProvideEditorLogicalViewAttribute instead.
Public class RegisterExtenderAttribute Obsolete. Registers an extender with Visual Studio. This class cannot be inherited. This class is obsolete. Please use ProvideExtenderAttribute instead.
Public class RegisterLanguageExtensionAttribute Obsolete. Registers a file extension with a given language service by applying the attribute to a VSPackage when registered using a registration tool like regpkg.exe. For more information, see Registering VSPackages.
Public class RegisterLoadKeyAttribute Obsolete. This attribute registers a package load key for your package. This attribute has been deprecated.
Public class RegisterProjectItemAttribute Obsolete. RegisterProjectItemAttribute has been deprecated. Please use ProvideProjectItemAttribute instead
Public class RegistrationAttribute An abstract class for VSPackage registration. The RegistrationAttribute class allows new registration information to be added without changing the registration tools.
Public class RegistrationAttribute.Key Provides an abstract class that represents a registration key.
Public class RegistrationAttribute.RegistrationContext An abstract base class that provides context information from an external source to a registration attribute.
Public class RunningDocumentTable Provides access to the running document table (RDT) that tracks all currently opened documents in Visual Studio.
Public class SelectionContainer Provides a unified interface for accessing a set of selected objects.
Public class ServiceCollection<T> Represents a collection of services.
Public class ServiceProvider Provides a unified service provider for managed VSPackages.
Public class ServiceProviderHierarchy Acts as a hierarchical service provider.
Public class ServiceProviderHierarchyOrder Provides a recommended service resolution order for common service providers. When multiple service providers are combined in a service provider hierarchy, they are given a numeric ordering.
Public class SettableOleDataObject Represents an OLE-compatible data object.
Public class Task An implementation of IVsTaskItem, used to modify the appearance and functionality of a task in the task list.
Public class TaskProvider This class implements IVsTaskProvider. It provides a framework-friendly way to define a task provider and its associated services.
Public class TaskProvider.TaskCollection A container for Task objects.
Public class ThreadHelper Provides a generic dispatcher helper to ensure that a method is invoked on the application's main thread.
Public class ToolWindowPane A default implementation for a tool window. It can be subclassed to implement a customized tool window.
Public class Url Wraps the Uri class. Provides an unescaped version of LocalPath for file URL types and AbsoluteUri for HTTP URL types. Also returns an unescaped result from MakeRelativeUri so that it can be presented to the user.
Public class VsBrushes Class used to map between __VSSYSCOLOREX identifiers (used by GetVSSysColorEx) and keys used by WPF ResourceDictionary objects. The keys provided by this class can be used to reference Brush instances that Visual Studio places in Resources.
Public class VsColors Maps between __VSSYSCOLOREX identifiers (as used by GetVSSysColorEx and keys used by Windows Presentation Foundation ResourceDictionary objects.
Public class VsMenus Includes the GUIDs for Visual Studio menu commands.
Public class VSRegistry Provides utility functions for discovering the registry hive under which Visual Studio is currently running.
Public class VsServiceProviderWrapper Wraps a service provider instance. The class can be used to expose a SVsServiceProvider value to a Managed Extensibility Framework composition container.
Public class VsShellUtilities Provides static helper methods to use with the Visual Studio shell.
Public class WindowPane Represents a Visual Studio window pane.

Structures

  Structure Description
Public structure RunningDocumentInfo Represents information about a document in the RunningDocumentTable. It includes all the information returned by GetDocumentInfo.

Interfaces

  Interface Description
Public interface IComEnumeratorRelay<TComEnumerator, TEnumerated> Provides typed enumeration methods.
Public interface IConfigureToolboxItem Provides the ability to configure ToolboxItem objects dynamically by adding additional data to the toolbox item's Properties dictionary. This data is then serialized as a permanent part of the toolbox item.
Public interface IMenuCommandInvokeEx Helps to invoke menu commands.
Public interface IOleMenuCommand Represents an OLE menu command.
Public interface IProfileManager Interface implemented by classes supporting VSPackages by persisting their state information through the Visual Studio settings mechanism.
Public interface IProfileMigrator Supports the migration of user settings from one version of Visual Studio to another.
Public interface IResXResourceService An abstraction layer that lets clients control the resx readers and writers used within Visual Studio.
Public interface SVsServiceProvider Represents a Visual Studio service provider

Enumerations

  Enumeration Description
Public enumeration CommonMessagePumpExitCode Represents exit codes that are possible for CommonMessagePump.
Public enumeration DialogPage.ApplyKind An enumeration that describes dialog page apply behavior.
Public enumeration LogicalView This enumeration lists the supported logical views.
Public enumeration ProfileMigrationType Specifies the migration action in MigrationType and ProfileMigrationType.
Public enumeration RegistrationMethod Specifies how the assembly should be registered or located.
Public enumeration TaskCategory Provides a set of task categories that specify the kind of task that is to be performed.
Public enumeration TaskErrorCategory Represents a collection of values that identify types or severity of error messages that can appear in the Error List Options task window.
Public enumeration TaskPriority Provides values for task priorities.
Public enumeration ToolWindowOrientation This enumeration provides a number of possible tool window orientations with respect to a docking window.
Public enumeration VsDockStyle Defines constants for tool window orientation.
Protected enumeration WindowPane.PaneInitializationMode Represents the possible initialization states for a WindowPane object.