Skip to main content

setProperties()

allows changing available configuration attributes of the control dynamically

setProperties(arg?: string | ICheckboxGroupProps, props?: ICheckboxGroupItemProps): void;

Parameters:

  • arg: string | object - optional, either the id of a checkbox, or an object with the available attributes of the CheckboxGroup control and their new values
  • props: object - optional, an object with the available attributes of the checkbox and their new values

Example

// 1. Changes values in the configuration of the CheckboxGroup controlform.getItem("checkboxGroup").setProperties({    label: "New label",    labelPosition: "left",    options: {        rows: [            {                id: "first",                type: "checkbox",                text: "New Select 1",            },            {                id: "second",                type: "checkbox",                text: "New Select 2",            },            {                id: "third",                type: "checkbox",                text: "New Select 3",            },        ]    }});
// 2. Changes values in the configuration of the specified checkbox of CheckboxGroupform.getItem("checkboxGroup").setProperties("first", {    text: "New Text",    padding: 20});

The method invokes the afterChangeProperties and beforeChangeProperties events.

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

options(object) an object with options of a CheckboxGroup
width(string|number|"content") the width of a control
height(string|number|"content") the height of a control
css(string) adds style classes to a control
required(boolean) defines whether a control is required
padding(string|number) sets padding between a cell and a border of a CheckboxGroup control
label(string) specifies a label for a control
hiddenLabel(boolean) invisible label that will be used to identify the input on the server side
labelPosition(string) defines the position of a label: "left"|"top"
labelWidth(string|number) sets the width of the label of a control
helpMessage(string) adds a help message to a control
preMessage(string) a message that contains instructions for interacting with the control
successMessage(string) a message that appears in case of successful validation of the control value
errorMessage(string) a message that appears in case of error during validation of the control value

It is possible to change values of the following configuration attributes of a checkbox of the CheckboxGroup control:

text(string) the text label of a checkbox
width(string|number|"content") the width of a checkbox
height(string|number|"content") the height of a checkbox
padding(string|number) sets padding between a cell and a border of a checkbox
css(string) adds style classes to a a checkbox

We recommend that you apply the second way of using the method if you want to change the configuration of a separate checkbox in the CheckboxGroup control:

form.getItem("checkboxGroup").setProperties("first", {    text: "New Text",    padding: 20});

Change log:

added in v7.0