setProperties()
allows changing available configuration attributes of the control dynamically
setProperties(arg?: string | ICheckboxGroupProps, props?: ICheckboxGroupItemProps): void;
Parameters:
arg: string | object
- either the id of a radio button, or an object with the available attributes of the RadioGroup control and their new valuesprops: object
- optional, an object with the available attributes of the radio button and their new values
Example
// 1. Changes values in the configuration of the RadioGroup control
form.getItem("radiogroup").setProperties({
label: "New label",
labelPosition: "top",
helpMessage: " Help information",
options: {
rows: [
{
id: "first",
type: "radioButton",
text: "Select 1",
value: "1",
},
{
id: "second",
type: "radioButton",
text: "Select 2",
value: "2"
},
{
id: "third",
type: "radioButton",
text: "Select 3",
value: "3"
}
]
}
});
// 2. Changes values in the configuration of the specified radio button of the control
form.getItem("radiogroup").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 RadioGroup control:
options | (object) an object with options of a RadioGroup |
width | (string|number|"content") the width of a control |
height | (string|number|"content") the height of a control |
padding | (string|number) sets padding between a cell and a border of a RadioGroup control |
css | (string) adds style classes to a control |
required | (boolean) defines whether a control is required |
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, applied for all radio buttons in a group |
successMessage | (string) a message that appears in case of successful validation of the control value, applied for all radio buttons in a group |
errorMessage | (string) a message that appears in case of error during validation of the control value, applied for all radio buttons in a group |
It is possible to change values of the following configuration attributes of a radio button of the RadioGroup control:
text | (string) the text label of a radio button |
width | (string|number|"content") the width of a control |
height | (string|number|"content") the height of a control |
padding | (string|number) sets padding between a cell and a border of a radio button |
css | (string) adds style classes to a control |
We recommend that you apply the second way of using the method if you want to change the configuration of a separate radio button in the RadioGroup control:
form.getItem("radiogroup").setProperties("first", {
text: "New Text",
padding: 20
});
Change log:
added in v7.0