Skip to main content

setProperties()

allows changing available configuration attributes of the control dynamically

setProperties(propertyConfig: IColorpickerProps): void;

Parameters:

  • propertyConfig: 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"
});

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) adds style classes to a control
customColors(array) shows a section with custom colors in the bottom part of the ColorPicker
editable(boolean) allows a user to enter the value of the control manually
errorMessage(string) a message that appears in case of error during validation of the control value
grayShades(boolean) defines whether the section with gray shades is displayed in the palette
height(string|number|"content") the height of a control
helpMessage(string) adds a help message to a control
hiddenLabel(boolean) invisible label that will be used to identify the input on the server side
icon(string) the name of an icon from the used icon font
label(string) specifies a label for a control
labelPosition(string) defines the position of a label: "left"|"top"
labelWidth(string|number) sets the width of the label of a control
mode(string) the mode of a control: "palette" (default), "picker"
padding(string|number) sets padding between a cell and a border of the ColorPicker control
palette(array) contains arrays of colors you want to be shown in a colorpicker
placeholder(string) a tip for the input
preMessage(string) a message that contains instructions for interacting with the control
required(boolean) defines whether a control is required
successMessage(string) a message that appears in case of successful validation of the control value
validation(function) the validation function, takes as a parameter the value to validate and returns true/false to indicate the result of validation
width(string|number|"content") the width of a control

Change log:

added in v7.0