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("checkbox").setProperties({
    label: "I agree",
    width: "100px",
    padding: 20
});
info

The method invokes the afterChangeProperties and beforeChangeProperties events.

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

{
    css: string,
    errorMessage: string,
    height: string|number|"content",
    helpMessage: string,
    hiddenLabel: boolean,
    label: string,
    labelPosition: string,
    labelWidth: string|number,
    padding: string|number,
    preMessage: string,
    required: boolean,
    successMessage: string,
    text: string,
    width: string|number|"content",
}

You will find the description of these properties here.

Change log:

added in v7.0