Class Shell

A collection of services related to the command system.

Inheritance
System.Object
Shell
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Community.VisualStudio.Toolkit
Assembly: Community.VisualStudio.Toolkit.dll
Syntax
public class Shell

Methods

| Improve this Doc View Source

GetAppCommandLineAsync()

This interface is used by a package to read command-line switches entered by the user.

Declaration
public Task<IVsAppCommandLine> GetAppCommandLineAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.Interop.IVsAppCommandLine>
| Improve this Doc View Source

GetComponentModelAsync()

Used to retrieved services defined in the MEF catalog, such as the editor specific services like Microsoft.VisualStudio.Editor.IVsEditorAdaptersFactoryService.

Declaration
public Task<IComponentModel2> GetComponentModelAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.VisualStudio.ComponentModelHost.IComponentModel2>
| Improve this Doc View Source

GetFontAndColorCacheManagerAsync()

Controls the caching of font and color settings.

Declaration
public Task<IVsFontAndColorCacheManager> GetFontAndColorCacheManagerAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.Interop.IVsFontAndColorCacheManager>
| Improve this Doc View Source

GetFontAndColorStorageAsync()

Allows a VSPackage to retrieve or save font and color data to the registry.

Declaration
public Task<IVsFontAndColorStorage> GetFontAndColorStorageAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.Interop.IVsFontAndColorStorage>
| Improve this Doc View Source

GetImageServiceAsync()

Registers well-known images (such as icons) for Visual Studio.

Declaration
public Task<object> GetImageServiceAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

Cast return object to Microsoft.VisualStudio.Shell.Interop.IVsImageService2
| Improve this Doc View Source

GetMRUItemsStoreAsync()

Controls the most recently used (MRU) items collection.

Declaration
public Task<object> GetMRUItemsStoreAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

Cast return object to Microsoft.VisualStudio.Shell.Interop.IVsMRUItemsStore
| Improve this Doc View Source

GetShellAsync()

Provides access to the fundamental environment services, specifically those dealing with VSPackages and the registry.

Declaration
public Task<IVsShell> GetShellAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.Interop.IVsShell>
| Improve this Doc View Source

GetToolsOptionsAsync()

Manages a Tools Options dialog box. The environment implements this interface.

Declaration
public Task<IVsToolsOptions> GetToolsOptionsAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.Interop.IVsToolsOptions>
| Improve this Doc View Source

GetUIShellAsync()

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

Declaration
public Task<IVsUIShell> GetUIShellAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.Interop.IVsUIShell>
| Improve this Doc View Source

OpenDocumentViaProjectAsync(String)

Opens the file via the project instead of as a misc file.

Declaration
public Task OpenDocumentViaProjectAsync(string fileName)
Parameters
Type Name Description
System.String fileName
Returns
Type Description
System.Threading.Tasks.Task