IWorkspaceSettingsFileProvider Interface
Definition
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.
Dynamic settings providers These providers contribute properties to the hierarchical settings collection that comes from a different sources than on disk json files. Example can be "intrinsic in memory providers" or "converters" (components that parse other tools formats into a Workspace settings schema).
public interface class IWorkspaceSettingsFileProvider : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsProviderpublic interface class IWorkspaceSettingsFileProvider : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsProvider__interface IWorkspaceSettingsFileProvider : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsProviderpublic interface IWorkspaceSettingsFileProvider : Microsoft.VisualStudio.Workspace.Settings.IWorkspaceSettingsProvidertype IWorkspaceSettingsFileProvider = interface
interface IWorkspaceSettingsProviderPublic Interface IWorkspaceSettingsFileProvider
Implements IWorkspaceSettingsProvider- Implements
Properties
| OnWorkspaceSettingsChanged |
Event fire when a settings source managed by the particular provider changes. The Settings manager will monitor this events and will propagate them to consumers as required. (Inherited from IWorkspaceSettingsProvider) |
Methods
| DisposeAsync() |
called when workspace is disposed. The provider should disconnect listeners to other IWorkspace related components here, release resource and such. The potentially cached IWorkspace is available to be used, but some functionality may not work (for example it is likely attempting to use SymbolsService will fail) (Inherited from IWorkspaceSettingsProvider) |
| GetSettingsFiles(String, String) |
Provide zero or more workspace schema settings collections to be merged with the rest of the Workpace's sources. |
| GetSingleSettings(String, String) |
Provide a workspace schema settings collection to be merged with the rest of the Workspace's sources. Note provider should only provide a single source that applies only to the "scopePath". (Inherited from IWorkspaceSettingsProvider) |