ISettingsWriter 接口

定义

通过此 API 所做的更改在调用 之前 RequestCommit(String) 不会生效。 此时,他们可能会立即获得批准/拒绝,或者可能需要等待用户批准。 保留更改的范围可能由用户决定。 RequestCommit(String) 可以多次调用。

public interface ISettingsWriter : Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsReader
type ISettingsWriter = interface
    interface ISettingsReader
Public Interface ISettingsWriter
Implements ISettingsReader
实现

方法

Commit(String)
已过时.

不推荐使用此方法。 请改用 RequestCommit(String)。 提交所有排队的更改。 这可能需要用户批准才能完成。 在这种情况下,此方法将立即返回,并在用户批准后稍后完成提交。

EnqueueArrayChange<T>(String, IReadOnlyList<T>)

将数组设置的值的更改排入队列。 用户可以在审批过程中选择目标范围。 除非未注册设置,否则将执行验证。

EnqueueChange<T>(String, T)

将设置的值的更改排入队列。 用户可以在审批过程中选择目标范围。 除非未注册设置,否则将执行验证。 这等效于使用 None调用 EnqueueChange<T>(String, T, SettingWriteOptions)

EnqueueChange<T>(String, T, SettingWriteOptions)

将设置的值的更改排入队列。 用户可以在审批过程中选择目标范围。 除非未注册设置,否则将执行验证。

GetArray<T>(String, SettingReadOptions)

获取数组设置的有效值,如果未自定义,则获取默认值。

(继承自 ISettingsReader)
GetArrayOrThrow<T>(String)

获取数组设置。 如果没有持久化值,则持久化值无效,或者无法将持久化值转换为 数组 T,则返回默认值。

(继承自 ISettingsReader)
GetValue<T>(String, SettingReadOptions)

获取非数组设置的有效值,如果未自定义,则获取默认值。

(继承自 ISettingsReader)
GetValueOrThrow<T>(String)

获取非数组设置。 如果没有持久化值,则持久化值无效,或者无法将持久化值转换为 T,则返回默认值。

(继承自 ISettingsReader)
RequestCommit(String)

请求提交所有排队的更改。 这可能需要用户批准才能完成。 在这种情况下,此方法将立即返回,并在用户批准后稍后完成提交。 更改将在用户选择的范围中应用。

SubscribeToChanges(Action<SettingsUpdate>, String[])

注册在设置的有效值更改时要调用的回调。 请注意,如果在较高优先级范围内重写设置,设置可以更改,而不会影响其有效值,例如,如果将设置更改应用于“用户”范围 (较低优先级) 但相同的设置也在“工作区”范围 (更高的优先级) 进行自定义,则更改不会影响有效值。

(继承自 ISettingsReader)

适用于