Share via


IWorkspace Interface

Definition

IWorkspace interface definition

public interface class IWorkspace : IServiceProvider, Microsoft::VisualStudio::Threading::IAsyncDisposable, Microsoft::VisualStudio::Workspace::IAsyncServiceProvider
public interface IWorkspace : IServiceProvider, Microsoft.VisualStudio.Threading.IAsyncDisposable, Microsoft.VisualStudio.Workspace.IAsyncServiceProvider
type IWorkspace = interface
    interface IServiceProvider
    interface IAsyncServiceProvider
    interface IAsyncDisposable
Public Interface IWorkspace
Implements IAsyncDisposable, IAsyncServiceProvider, IServiceProvider
Derived
Implements

Properties

JTF

Instance of JoinableTaskFactory associated with JTFCollection. Use IWorkspace.JTF to start async work (instead of Task.Run).

Location

Gets the path to the root directory of the source tree.

Methods

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

(Inherited from IAsyncDisposable)
GetActionsForContextsAsync(String, IEnumerable<FileContext>, CancellationToken)

Gets actions that apply to a set of file contexts

GetDirectoriesAsync(String, Boolean, CancellationToken)

Gets a set of directories within the workspace.

GetFileContextActionsAsync(String, IEnumerable<Guid>, CancellationToken)

Gets the actions available at the specified path.

GetFileContextActionsAsync<T>(String, T, IEnumerable<Guid>, CancellationToken)

Gets the actions available on a workspace context

GetFileContextsAsync(String, IEnumerable<Guid>, CancellationToken)

Gets the file contexts associated with the specified workspace location.

GetFileContextsAsync<T>(String, T, IEnumerable<Guid>, CancellationToken)

Get file contexts for a workspace context

GetFileContextsForLanguageServicesAsync(String, CancellationToken)

Return matched ILanguageServiceProvider's for a file context path

GetFilesAsync(String, Boolean, CancellationToken)

Gets a set of files within the workspace.

GetServiceAsync(Type)

Get the service

(Inherited from IAsyncServiceProvider)
MakeRelative(String)

Converts an absolute path to a path relative to the root of this workspace.

MakeRooted(String)

Gets the absolute path for a given path, which may be relative to Workspace.Location.

Extension Methods

GetFirstFileContextActionAsync<T>(IWorkspace, String, T, IEnumerable<Guid>, CancellationToken)

Get the first available action for a workspace context

GetFirstFileContextsAsync<T>(IWorkspace, String, T, IEnumerable<Guid>, CancellationToken)

Get the first available context for a workspace context

GetGlobalSettingsFolder(IWorkspace)

Get the working folder for this workspace

GetWorkspaceWorkingFolder(IWorkspace)

Get the working folder for this workspace

MakeRootedUnderWorkingFolder(IWorkspace, String)

Get a full path under workspace working folder.

GetAssetsManager(IWorkspace)

Get the shared access control service

GetBuildMessageService(IWorkspace)

Return the build message service from a workspace

GetBuildService(IWorkspace)

Return the build service from a workspace

GetBuildService2(IWorkspace)

Return the IBuildService2 from a workspace

GetBuildService3(IWorkspace)

Return the IBuildService3 from a workspace

GetCustomContextService(IWorkspace)

Return the ICustomContextService service

GetFileWatcherService(IWorkspace)

Get the IFileSystemChanged service for a workspace

GetFindFilesService(IWorkspace)

Get the IFindFilesService service for a workspace

GetIndexWorkspaceDataService(IWorkspace)

Get the IIndexWorkspaceDataService for a workspace instance

GetIndexWorkspaceService(IWorkspace)

Get the IIndexWorkspaceService for a workspace instance

GetProjectConfigurationServiceAsync(IWorkspace)

Return the IProjectConfigurationManager service

GetPropertyEvaluatorServiceAsync(IWorkspace)

Return the IPropertyEvaluatorService service

GetService<T>(IWorkspace, Boolean)

Get a service type from a workspace

GetServiceAsync<T>(IWorkspace, Boolean)

Get a service type from a workspace using the async pattern

GetSettingsManager(IWorkspace)

Get the IWorkspaceSettingsManager service for a workspace

GetUINodeOperationEventServiceAsync(IWorkspace)

Get the IUINodeOperationEventService for a workspace instance

Applies to