getProperties()
returns an object with the available configuration attributes of the control
getProperties(): IComboProps;
Returns:
An object with the available attributes of the control and their values.
Example
const form = new dhx.Form("form_container", {
rows: [
{
type: "combo",
name: "combo",
label: "count",
labelPosition: "left",
multiselection: true,
selectAllButton: true,
value: [
"id_1",
"id_2"
],
data: [
{ value: "1", id: "id_1" },
{ value: "2", id: "id_2" },
{ value: "3", id: "id_3" },
{ value: "4", id: "id_4" },
{ value: "5", id: "id_5" }
]
}
]
});
form.getItem("combo").getProperties();
// -> the returned object:
{
errorMessage: "",
filter: undefined,
height: "content",
helpMessage: "",
hiddenLabel: false,
itemHeight: 32,
itemsCount: undefined,
label: "count",
labelPosition: "left",
labelWidth: "",
listHeight: 224,
multiselection: true,
padding: 0,
placeholder: "",
preMessage: "",
readonly: false,
required: false,
selectAllButton: true,
successMessage: "",
template: undefined,
validation: undefined,
virtual: false,
width: "content"
}
The returned object of the Combo control can contain the following configuration attributes:
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 |
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