Class Date

Gets the control's required state.

Example

var ctrl = ix.api.dom.getControl("<ELEMENT-GUID>");
console.log(ctrl.required);
Copy

Sets the control's required state

Example

var ctrl = ix.api.dom.getControl("<ELEMENT-GUID>");
ctrl.required = false;
Copy

Checks if the value matches the format and is in range of values.

Example

const validityResult = await ix.api.dom.getControl("<GUID>").checkValidity();

// example of `validityResult` - the entered value has wrong format
ValidationInfo {
  valStatus: false,
  valMessage: 'Entry does not correspond to required format. Format: dd.MM.yyyy',
  valType: 'pattern'
}
Copy

Closes the picker.

Get the current value of the control or given value as JavaScript date object.

Example

ix.api.dom.getControl("<GUID>").getDateObject("22.02.2022");

// Returns a date object:
`Tue Feb 22 2022 00:00:00 GMT+0100 (Central European Standard Time)`
Copy

Retrieves the current value of the control.

This method returns the current value of the control as a string. If the control does not have a value, it returns an empty string.

Example

// Get the control by its element GUID and retrieve the value
const value = ix.api.dom.getControl("<ELEMENT-GUID>").getValue();
console.log(value); // Outputs the value to the console
Copy

Opens the picker.

Set value of the control.

Deprecated

Please use setValue instead!

Sets a value for the control.

Converts a JavaScript date object to a string like 22.02.2022.

Note

The output depends on the field's format settings.

Example

// convert a given date object
ix.api.dom.getControl("<GUID>").toLocalFormat(new Date(2022, 01, 22));

// returns
'22.02.2022'
Copy