setProperties()
allows changing available configuration attributes of the control dynamically
setProperties(propertyConfig: IComboProps): void;
Parameters:
properties: object
- an object with the available attributes of the control and their new values
Example
form.getItem("combo").setProperties({
label: "New label",
labelPosition: "top"
});
The method invokes the afterChangeProperties and beforeChangeProperties events.
It is possible to change values of the following configuration attributes of the Combo control:
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 |
height | (string|number|"content") the height of a control |
padding | (string|number) sets padding between a cell and a border of the Combo control |
css | (string) adds style classes to a control |
placeholder | (string) sets a placeholder in the input of Combo |
required | (boolean) defines whether the field with Combo is required (for a form) |
readonly | (boolean) makes Combo readonly (it is only possible to select options from the list, without entering words in the input) |
label | (string) specifies a label for a control |
labelWidth | (string|number) sets the width of the label of 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" |
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 |
itemHeight | (number) sets the height of a cell in the list of options |
listHeight | (number) sets the height of the list of options |
template | (function) sets a template of displaying options in the popup list |
filter | (function) sets a custom function for filtering Combo options. Check the details. |
multiselection | (boolean) enables selection of multiple options in Combo |
selectAllButton | (boolean) defines whether the Select All button should be shown |
itemsCount | (boolean, function) shows the total number of selected options |
virtual | (boolean) enables dynamic loading of data on scrolling the list of options |
Change log:
added in v7.0