Skip to content

PluginSettingsTabBase.setControlValue method

PluginSettingsTabBase › setControlValue

Persists the value of a native control setting definition.

The counterpart of getControlValue: it routes the write to the settings component instead of the inherited plugin.saveData path, so validation, transformers and the debounced save all apply as they do for a bind-ed component.

Signature:

setControlValue(key: string, value: unknown): Promise<void>

Parameters:

ParameterTypeDescription
keystringThe settings property name.
valueunknownThe value to persist.

Returns: Promise<void>A Promise that resolves when the value is set.