IWorkspaceSettings Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Workspace.Settings

Assembly:: Microsoft.VisualStudio.Workspace.dll

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.

Workspace Settings interface.

public interface class IWorkspaceSettings : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsSource

public interface class IWorkspaceSettings : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsSource

__interface IWorkspaceSettings : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsSource

public interface IWorkspaceSettings : Microsoft.VisualStudio.Workspace.Settings.IWorkspaceSettingsSource

type IWorkspaceSettings = interface
    interface IWorkspaceSettingsSource

Public Interface IWorkspaceSettings
Implements IWorkspaceSettingsSource

Implements: IWorkspaceSettingsSource

Properties

Parent	Parent (lower priority) Settings wrapper.
ScopePath	Get the absolute path for the property scope where definition originate.

Methods

GetKeys()	Enumerate all available property names. (Inherited from IWorkspaceSettingsSource)
GetProperty<T>(String, T, IWorkspaceSettings, T)	get a [base] settings value (property), the type and meaning of the value is defined by the caller. This override also specifies the particular settings source that provided the value. Used in cases where implied root is needed, or when doing "unification" for arrays.
GetProperty<T>(String, T, T)	get a [base] settings value (property), the type and meaning of the value is defined by the caller. (Inherited from IWorkspaceSettingsSource)

Extension Methods

AbsolutePath(IWorkspaceSettings, String, String)	Get a string value representing potentially relative path as full path, using implied root as a base
Property<T>(IWorkspaceSettingsSource, String, T)	Wrapper around WorkspaceSettingsResult GetProperty. Used when caller is not interested by the current state, but just want to get the current value to use.
PropertyArray<T>(IWorkspaceSettingsSource, String)	Wrapper around WorkspaceSettingsResult GetPropertyArray. Used when caller is not interested by the current state, but just want to get the current value to use.
PropertyGroup(IWorkspaceSettings, String)	A special provider of inner named settings collection (T=IWorkspaceSettings) Used when caller is not interested by the current state, but just want to get the current value to use.
PropertyGroupArray(IWorkspaceSettings, String)	A special accessors for inner named settings collection array (T=IWorkspaceSettings) Used when caller is not interested by the current state, but just want to get the current value to use.
TryGetRootedValue(IWorkspaceSettings, String, String, String)	Get a string value with implied root
UnionPropertyArray<T>(IWorkspaceSettings, String)	This method will return union of all values in hierarchical chain, not just the top array.

Applies to