Microsoft.VisualStudio.Workspace Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| AsyncEvent<TEventArgs> |
Async Event class to support firing async EventHandlers |
| BatchFileSystemEventArgs |
Class BatchFileSystemEventArgs Allow a notification of multiple FileSystemEventArgs entities |
| BuildConfigurationChangedEventArgs |
Build configuration changed event arguments |
| CreatedUINode |
CreatedUINode |
| DeletedUINode |
DeletedUINode |
| ExportDeployProviderAttribute |
Exports an IDeployProvider to the MEF catalog with metadata as described by IDeployProviderMetadata. |
| ExportFileContextActionProviderAttribute |
Exports an IWorkspaceProviderFactory<T> with a type argument of IFileContextActionProvider to the MEF catalog with metadata as described by IFileContextActionProviderMetadata. |
| ExportFileContextProviderAttribute |
Exports an IWorkspaceProviderFactory<T> with a type argument of IFileContextProvider to the MEF catalog with metadata as described by IFileContextProviderMetadata. |
| ExportFileExtensionsAttributeBase |
Export File Extension provide base |
| ExportProjectActionSettingsProviderAttribute |
Exports an IProjectActionSettingsProvider to the MEF catalog with metadata as described by IProjectActionSettingsProviderMetadata. |
| ExportProviderAttributeBase |
Base Implementation for the IProviderMetadataBase interface |
| ExportWorkspaceServiceFactoryAttribute |
Class ExportWorkspaceServiceFactoryAttribute |
| FileContext |
Describes the context a file may belong to, such as a compilation unit for a source file, a consuming HTML page for a .js file, etc. |
| FileContextActionBase |
Implement IFileContextActionBase using a function callback |
| FileContextActionCallback |
FileContextActionCallback class |
| FileContextActionDelegate |
FileContextActionDelegate class |
| FileContextActionEndedEventArgs |
Represents the end event of a IFileContextActionBase. |
| FileContextActionResult |
Default implementation for a IFileContextActionResult interface |
| FileContextActionStartingEventArgs |
Represents the start event of a IFileContextActionBase. |
| FileSystemContextChanged |
Class FileSystemContextChanged. Use the workspace file system watcher notification to propagate a FileContext notification |
| FileSystemEventArgsHelper |
Helper utility for FileSystemEventArgs class |
| Grouping<TKey,TElement> |
A trivial implementation of IGrouping<TKey,TElement>. |
| MovedUINode |
MovedUINode |
| PauseTokenSource |
A source token to allow pausing a task |
| ProjectConfiguration |
Class ProjectConfiguration |
| ProjectConfiguration.ProjectConfigurationComparer |
Comparers for ProjectConfiguration instances. |
| ProjectTargetFileContext |
Project target file context |
| PropertyChangedEventArgs<T> |
PropertyChangedEventArgs class |
| PropertySettings |
Default IPropertySettings implementation. |
| PropertySettingsHelper |
Helper class for the type IPropertySettings |
| ResultEventArgs<T> |
Result Event arguments class |
| SpecialCaseFileExtensions |
A class containing constants representing special case file extensions, which can be used with attributes deriving from ExportFileExtensionsAttributeBase. |
| UINodesCreatedEventArgs |
UINodesCreated EventArgs |
| UINodesDeletedEventArgs |
UINodesDeleted EventArgs |
| UINodesMovedEventArgs |
UINodesMoved EventArgs |
| WorkspaceHelper |
IWorkspace extensions |
| WorkspaceServiceHelper |
IWorkspace service helpers Contains method to access IWorkspace based services |
Structs
| ExternalItemsRequest |
Data structure to request external items |
| PauseToken |
A pause token |
Interfaces
| IActionBlockService |
Service to allow posting actions into the workspace |
| IAsyncComponent |
A component that participates in VS async service model. |
| IAsyncServiceProvider |
Interface to access a service using async pattern |
| IAsyncWorkspaceProviderFactory<T> |
Provider workspace async factory |
| IAsyncWorkspaceServiceFactory |
Create a workspace service using async pattern |
| IFileContextAction |
Describes an action supported by a IFileContextActionProvider. |
| IFileContextActionBase |
Describes an action supported by a IFileContextActionProvider. |
| IFileContextActionEventsService |
A mechanism for subscribing to notifications about the execution of IFileContextActionBase objects, such as build, rebuild, and clean. |
| IFileContextActionProgressUpdate |
Provides an update on the progress of an ongoing ExecuteAsync(IProgress<IFileContextActionProgressUpdate>, CancellationToken) operation. |
| IFileContextActionProvider |
Offers arbitrary action execution for files. |
| IFileContextActionProviderMetadata |
Describes an IFileContextActionProvider extension's applicability and capabilities. |
| IFileContextActionResult |
Describes the result of some IFileContextAction. |
| IFileContextConsumerMetadata |
An interface describing metadata found on exports that consume specific types of file contexts. |
| IFileContextHierarchy<T> |
Define a file context hierarchy |
| IFileContextProvider |
Offers services to discover contexts defined in source files. |
| IFileContextProvider<T> |
IFileContextProvider with context type |
| IFileContextProviderMetadata |
Describes an IFileContextProvider extension's applicability and capabilities. |
| IFileSelectorMetadata |
Describes an IFileSelectorMetadata |
| IFilesService |
Interface IFilesService to allow a provider to customize the behavior when a folder is being opened and the hierarchy of files an directories has to be retrieved |
| IFileSystemConverter |
Allows converting file references between file path and file system Uri. When implemented, file operations will switch to operate on IFileSystem service. |
| IFileWatcherService |
Interface IFileWatcherService Sink events to receive file system notification changes using an async pattern |
| IFindFilesService |
Workspace service to find files |
| IFindFilesService2 |
Interface to extend existing IFindFilesService |
| IFindFilesService3 |
Interface to extend existing IFindFilesService2. |
| IHostService |
Host-specific information use for workspace construction and operation. |
| IHostService2 |
Additional host-specific information provided by an implementer of IHostService. |
| INotifyFileContextChanged |
Interface to provide an action when a file context has been modified |
| IProjectActionSettingsProvider |
Interface for a provider that customizes project actions (e.g. Deploy or Launch) settings. |
| IProjectActionSettingsProviderMetadata |
Describes an IProjectActionSettingsProvider extension's applicability and capabilities. |
| IPropertySettings |
IPropertySettings interface |
| IProviderMetadataBase |
Provider Metadata Base |
| ISupportedTypesMetadata |
Supported types metadata |
| ITelemetryMetadata |
Defines additional properties that should be added to a telemetry event. |
| IUINodeOperationEventService |
Interface IUINodeOperationEventService Sink events to receive file system notification made through VS UI |
| IWorkspace |
IWorkspace interface definition |
| IWorkspace2 |
Interface to extend IWorkspace. |
| IWorkspace3 |
Interface to extend IWorkspace2. |
| IWorkspace4 |
Interface to extend IWorkspace3. |
| IWorkspace5 |
Interface to extend IWorkspace4. |
| IWorkspaceIDEConfigurationsService |
Interface to expose a service to retrieve workspace IDE configurations. |
| IWorkspaceProviderFactory<T> |
Provider workspace factory |
| IWorkspaceServiceFactory |
Workspace service factory |
| IWorkspaceServiceFactoryMetadata |
IWorkspaceServiceFactoryMetadata interface |
Enums
| FileContextActionProviderOptions |
Options for IFileContextProvider |
| FileContextProviderOptions |
Options for IFileContextProvider |
| ProjectConfigurationManagerProperties |
Change type enumeration. |
| ProviderPriority |
Priority enumeration for Providers |
| UINodeType |
Types of UI Node |
| WorkspaceServiceFactoryOptions |
Options for workspace service factories. |