|
Changes to Date Time Picker widget also affect the interface of the Chip Based Data Filter widget when applying date or time filters.
|
State and Configuration | Date Selection | Date with Range Selection | Date-and Time Selection | Date-and Time with Range Selection |
---|---|---|---|---|
Closed | ||||
Open |
You can use the arrow keys to select PM or AM. |
Property | Description | Base Type | Default Value | Bindable? (Y/N | Localizable? | ||
---|---|---|---|---|---|---|---|
Label | The text that is displayed in the label of the Date Time Picker widget. | STRING | N/A | Y | Y | ||
LabelAlignment | Aligns the widget label to the Left, Right, or Center. | STRING | Left | Y | N | ||
Disabled | Use this property to disable the widget in the mashup. The widget is displayed in the mashup but you cannot click it. | BOOLEAN | False | Y | N | ||
DisableMaskedInput | Disables the input mask that displays a preview of the date pattern at run time. | BOOLEAN | False | Y | N | ||
HintText | Displays placeholder text that explains what should be entered in the field. | STRING | SELECT DATE & TIME | Y | Y | ||
DateOnly | Allows users to select dates only. To enable time selection, set this property to false. | BOOLEAN | TRUE | N | N | ||
DisplaySeconds | Enables you to display the time with seconds. Available when DateOnly is false. | BOOLEAN | FALSE | N | N | ||
DateDelimiter | Specifies the character used to separate the day, month, and year. For example, a (—) hyphen displays the date as: 05–10–2020. | STRING | N/A | N | Y | ||
MonthFormat | Enables you to control the month format within the date. Supported options: • Full—October • Short—Oct • Numeric—10 | STRING | Full | N | N | ||
PrimaryActionPosition | Enables you to set the position of the primary action button to the Left or Right The primary action is the • Done button in the button group. | STRING | Left | N | N | ||
DateOrder | Enables you to set the format of the date display. Supported options: • Auto • Day-Month-Year • Month-Day-Year • Year-Month-Day Changing this property from Auto to a specific order adds the DateDelimiter and MonthFormat properties to the widget. | STRING | Auto | N | N | ||
FormatToken | When the default Auto is selected, the system date appears in the widget. Also, the DateDelimiter and MonthFormat properties are hidden.
| STRING | N/A | N | Y | ||
MinDate | Sets the minimum date available for the date selection. | DATETIME | Default hint text | In | N | ||
MaxDate | Sets the maximum date available for the date selection. | DATETIME | Default hint text | In | N | ||
DateRange | Enables range selection for dates. | BOOLEAN | False | ||||
RangeChanged | An event that triggers when the selected date range is changed. | Event | N/A | Y | N | ||
HintText | The hint text to display as a placeholder within the widget. Hint text is displayed based on the applied pattern when input masking is enabled. | STRING | Autohint | Y | Y | ||
StartDateHintText | Sets the hint text to display for the start date when range selection is enabled. | STRING | Autohint | Y | Y | ||
EndDateHintText | Sets the hint text to display for the end date when range selection is enabled. | STRING | Autohint | Y | Y | ||
StartDateLabel | Sets the label to display for the start date on the calendar. | STRING | N/A | Y | Y | ||
EndDateLabel | Sets the label to display for the end date on the calendar. | STRING | N/A | Y | Y | ||
StartTimeLabel | Sets the label to display for the end time field on the widget. | STRING | From | Y | Y | ||
EndTimeLabel | Sets the label to display for the end time field on the widget. | STRING | To | Y | Y | ||
AMPMLabel | Sets the label to display for the AM/PM drop-down list when using a 12–hour time format. | STRING | AM/PM | Y | Y | ||
CalendarStartTimeLabel | Sets the label to display above the time start field on the calendar when range selection is enabled. | STRING | N/A | Y | Y | ||
CalendarEndTimeLabel | Sets the label to display above the time end field on the calendar when range selection is enabled. | STRING | N/A | Y | Y | ||
MinStartDate | Sets the minimum date available for the date range selection. | DATETIME | Default hint text | In | N | ||
MaxStartDate | Sets the maximum date available for the start date when selecting a date range. | DATETIME | Default hint text | In | N | ||
MinEndDate | Sets the minimum date available for the end date when selecting a date range. | DATETIME | Default hint text | In | N | ||
MaxEndDate | Sets the maximum date available for the date range selection. | DATETIME | Default hint text | In | N | ||
IntervalType | Enables you to set an interval type as Hours,Minutes,Seconds or Days. | STRING | Hours | N | N | ||
Interval | Sets the date or time interval. | NUMBER | N/A | N | N | ||
CustomClass | Enables you to define the CSS class name to apply to the top div element of the widget. You can enter multiple classes, separated by a space. | STRING | N/A | Y | N | ||
TabSequence | The sequence of the widgets in which they are highlighted when the user presses Tab key. | NUMBER | N/A | N | N | ||
WeeklyCalendarStart | Enables you to configure the weekly calendar to start on Sunday or Monday. | STRING | Monday | N | N | ||
InitializeWithCurrentDateTime | Displays the current date and time as the default selection when the widget is viewed at run time. | BOOLEAN | TRUE | N | N | ||
LabelAlignment | Enables you to align the label to the left, right or center on the widget. | STRING | Left | N | N | ||
DateTime | Enables you to set or retrieve the selected value on the widget. | DATETIME | N/A | Y | N | ||
Changed | A bindable event that is triggered when the data for this widget is modified. | N/A | N/A | Y | N | ||
ResetToDefaultValue | Resets the inputs for this widget to its default values. | N/A | N/A | Y | N | ||
Width | The width of the widget. | NUMBER | N/A | N | N | ||
Height | The height of the widget. The height is set to the maximum width of the label by default. It increases if the widget has multiline label. Enter a value in the property panel or resize the widget in the canvas to set a fixed height. | NUMBER | N/A | N | N |
Property | Description | Base Type | Default Value | Bindable (Y/N) | Localizable (Y/N) |
---|---|---|---|---|---|
CriteriaMessage | The message to display for the validation criteria and when the validation fails. | STRING | n\a | Y | Y |
CriteriaMessageDetails | The details to display for the validation criteria and failure message. | STRING | n\a | Y | Y |
MaxDate | Sets the maximum date available for the date selection. | DATETIME | ${value} is the maximum value | Y | N |
MaxRange | Set the maximum number of days to restrict the user to select Start Date and End Dates. | NUMBER | n\a | N | N |
MaxRangeFailureMessage | The message to display when the selected range between the start and end dates exceeds the MaxRange value. | TEXT FIELD | n\a | IN | Y |
MaxDateFailureMessage | The message to display when the selected date is later than the maximum date value. | DATETIME | ${value} is the maximum date | Y | Y |
MinDate | The minimum date available for the date selection. | DATETIME | ${value} is the maximum date | Y | N |
MinDateFailureMessage | The message to display when the selected date is earlier than the minimum date value. | DATETIME | ${value} is the minimum date | Y | Y |
RequiredMessage | The message to display when a required value is missing. | STRING | A value is required | Y | Y |
ShowValidationCriteria | Shows a hint message about the required input when editing the date time picker. | BOOLEAN | False | Y | N |
ShowValidationFailure | Show a failure message when the entered value fails the validation. | BOOLEAN | False | Y | N |
ShowValidationState | A bindable service that enables you to display the validation state before a user interacts with the widget at run time. By default, the validation state is only displayed after user interaction. | Service | n/a | In | N |
ShowValidationSuccess | Show a success message when the entered value is validated as successful. | BOOLEAN | False | Y | |
SuccessMessage | The message to display when the value is valid. | STRING | n\a | Y | Y |
SuccessMessageDetails | A secondary message that displays more information about the validation success message. | STRING | n\a | Y | Y |
Validate | A bindable event that is triggered when the widget value is changed. Bind this event to service or function to apply a validation pattern or expression. | Event | n\a | Y | N |
ValidationCompleted | An event that triggers when all validation for this widget is completed. | Event | n\a | Y | N |
ValidationCriteriaIcon | Sets the SVG icon to display within the hint message for the validation criteria. | IMAGELINK | info | N | N |
ValidationFailureIcon | Sets the SVG icon to display within the status message when the validation fails. | IMAGELINK | error | N | N |
ValidationOutput | Retrieves the output of the widget validation. Returned values are undefined,unvalidated ,valid , orinvalid. | STRING | n\a | Y | N |
ValidationState | A bindable property that sets the validation state. You can set this property to undefined, unvalidated, valid, invalid. | STRING | undefined | Y | N |
ValidationSuccessIcon | Select an SVG icon to display within the statues message when the validation succeeds. | IMAGELINK | success | N | N |
ValueRequired | Require a date or time selection in the widget. | BOOLEAN | False | Y | N |