Skip to main content

setProperties()

allows changing available configuration attributes of the control dynamically

setProperties(properties: object): void;

Parameters:

  • properties: object - an object with the available attributes of the control and their new values

Example

form.getItem("colorpicker").setProperties({
editable: true,
labelWidth: "300px",
label: "New label"
});

info

The method invokes the afterChangeProperties and beforeChangeProperties events.

It is possible to change values of the following configuration attributes of the ColorPicker control:

{
css: string,
customColors: array,
editable: boolean,
errorMessage: string,
grayShades: boolean,
height: string|number|"content",
helpMessage: string,
hiddenLabel: boolean,
icon: string,
label: string,
labelPosition: string,
labelWidth: string|number,
mode: string,
padding: string|number,
palette: array,
placeholder: string,
preMessage: string,
required: boolean,
successMessage: string,
validation: function,
width: string|number|"content"
}

You will find the description of these properties here.

Change log:

added in v7.0