Compartilhar via

IWorkspaceSettingsSourceWriter Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Workspace.Settings
Assembly:
Microsoft.VisualStudio.Workspace.dll
Package:
Microsoft.VisualStudio.Workspace v17.12.18

Workspace Settings source writer interface. Used for "automated" settings persistence driven by features.

public interface class IWorkspaceSettingsSourceWriter : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsSource
public interface class IWorkspaceSettingsSourceWriter : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsSource
__interface IWorkspaceSettingsSourceWriter : Microsoft::VisualStudio::Workspace::Settings::IWorkspaceSettingsSource
public interface IWorkspaceSettingsSourceWriter : Microsoft.VisualStudio.Workspace.Settings.IWorkspaceSettingsSource
type IWorkspaceSettingsSourceWriter = interface
    interface IWorkspaceSettingsSource
Public Interface IWorkspaceSettingsSourceWriter
Implements IWorkspaceSettingsSource
Implements
IWorkspaceSettingsSource

Methods

CreateNew()

Create a new inner scope workspace (to be used later for SetProperty[Array](key, IWorkspaceSettingsSource...);
Delete(String)

delete a particular setting (regardless of type - can be property, property collection or array )
GetKeys()

Enumerate all available property names.

(Inherited from IWorkspaceSettingsSource)
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)
SetProperty<T>(String, T)

Persist a value in workspace settings.

Extension Methods

EnsurePropertyGroup(IWorkspaceSettingsSourceWriter, String)

A variant of "Scope", used during "Save" it will create and add a collection property with "key" name if it does not already exists. Used when caller is not interested by the current state, but just want to get the current value to use.
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.

Applies to