getProperties()
returns an object with the available configuration attributes of the control
getProperties(): ITimePickerProps;
Returns:
An object with the available attributes of the control and their values.
Example
const form = new dhx.Form("form_container", {
rows: [
{
type: "timepicker",
name: "timepicker",
label: "time",
labelWidth: "50px",
timeFormat: 12,
valueFormat: "timeObject",
value: [6,20,"AM"]
}
]
});
form.getItem("timepicker").getProperties();
// the returned object
{
controls: false,
editable: false,
errorMessage: "",
height: "content",
helpMessage: "",
hiddenLabel: false,
icon: "",
label: "time",
labelPosition: "top",
labelWidth: "50px",
padding: 0,
placeholder: "",
preMessage: "",
required: false,
successMessage: "",
timeFormat: 12,
validation: undefined,
valueFormat: "timeObject",
width: "content"
}
The returned object of the TimePicker control can contain the following configuration attributes:
valueFormat | (string) defines the format of the value to be applied when working with the events of the timepicker control: "string", "timeObject" |
validation | (function) the validation function |
icon | (string) the name of an icon from the used icon font |
placeholder | (string) a tip for the input |
editable | (boolean) allows a user to enter the value of the control manually |
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 TimePicker control |
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" |
required | (boolean) defines whether a control is required |
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 |
timeFormat | (number) defines what clock format is activated: the 12-hour or 24-hour one |
controls | (boolean) defines whether a timepicker is equipped with the Close and Save buttons |
Change log:
added in v7.0