DateTimePicker

Functional reference for DateTimePickerObject, including its runtime role and the supported settings available in the design environment.

Updated 6 min read
On this page (10 sections)
  1. Functional explanation
  2. Object name
  3. Variable
  4. Settings
  5. Text
  6. Position / Size
  7. Border
  8. Animate Position / Size
  9. Access Control
  10. Visibility

Functional explanation

DateTimePickerObject is an interactive picker for date, time, or combined date-time values. It reads and writes a datetime variable directly from the page.

It is used when the operator must select a structured time value instead of typing a free-form string. The control can be configured for different display and input modes so it matches the required process or schedule format.

Use it for timestamps, start and end times, and any setting that must remain a valid datetime value.

Object name

Set the object name shown in the datetime picker decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the DateTimePicker object.ShiftStartPickerText

Variable

Configure the datetime variable bound to the picker.

SettingDescriptionExampleUnits
VariableDatetime variable or expression bound to the picker.PLC1.ShiftStartExpression

Settings

Configure the date and time mode, formatting, and picker colors.

13 rows
SettingDescriptionExampleUnits
ModePicker mode such as DateTime.DateTimeMode
Display FormatText format shown in the control.yyyy-MM-dd HH:mm:ssFormat string
Is UtcTreats values as UTC when true.falseBoolean
Text ColorBase text color for the picker display.#212529Color
Background ColorBase background color for the picker display. A gradient can be used here as well as a single color; see the Gradients section of the Color Library article.#FFFFFFColor
Picker Background ColorBase picker calendar background color.#FFFFFFColor
Picker Text ColorBase picker calendar text color.#212529Color
Selected Background ColorSelected value background color.#0d6efdColor
Selected Text ColorSelected value text color.#FFFFFFColor
Today Background ColorToday marker background color.#0d6efdColor
Today Text ColorToday marker text color.#FFFFFFColor
Hover Background ColorHover state background color.#f3f3f3Color
Hover Text ColorHover state text color.#6c757dColor

Text

Configure the text appearance of the date and time shown in the DateTimePicker object.

SettingDescriptionExampleUnits
Font FamilyFont family used for the displayed date and time.ArialFont family name
Font AlignHorizontal alignment of the displayed date and time: Left, Center or Right.LeftSelection
Font WeightFont weight used for the displayed date and time.400CSS font weight
Font SizeFont size used for the displayed date and time. A number without a unit is applied in px.14px
PaddingSpace between the border and the displayed date and time. Enter one to four values in the order top, right, bottom, left, for example 4 8 for 4 px at the top and bottom and 8 px at the left and right. A number without a unit is applied in px.4 8px

Position / Size

Configure the position and size of the DateTimePicker object.

SettingDescriptionExampleUnits
TopTop position of the object.100px
LeftLeft position of the object.220px
WidthWidth of the object.220px
HeightHeight of the object.32px
Z-indexLayer order of the object. Higher values appear in front of lower values.10Number

Border

Configure the border styling for the DateTimePicker object.

SettingDescriptionExampleUnits
Border ColorBorder color used for the picker.#CED4DAColor
Border Color StatesDynamic border color state rules JSON array.[{"state":"alarm","color":"#dc3545"}]JSON array
Border WidthBorder width used for the picker.1px
Border RadiusCorner radius of the picker border.4px
Border VisibilityExpression controlling whether the border is visible.SYSTEM.UserGroups == "Operators"Expression
Border BlinkExpression or boolean controlling border blinking.PLC1.AlarmActiveBoolean or expression
Border Blink SpeedBlink speed used for the border.500ms
Border Blink OffsetBlink offset used to stagger border blinking between objects.falseBoolean

Animate Position / Size

Configure the runtime animation settings for height, width, top, and left of the DateTimePicker object.

22 rows
SettingDescriptionExampleUnits
Animate Height VariableVariable or expression that drives runtime height animation.PLC1.LevelVariable or expression
Animate Height Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Height Maximum RawEnd of the raw value span. The animated height reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Height Minimum pxStart of the pixel span. The animated height runs from 0 px up to the difference between Maximum px and Minimum px.20px
Animate Height Maximum pxEnd of the pixel span. With Minimum px at 0, this is the height at full scale.60px
Animate Height ReverseSets the edge the height grows from. Cleared grows the object upwards from the bottom edge, which suits level and fill graphics. Selected grows it downwards from the top edge.falseBoolean
Animate Width VariableVariable or expression that drives runtime width animation.PLC1.ValueVariable or expression
Animate Width Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Width Maximum RawEnd of the raw value span. The animated width reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Width Minimum pxStart of the pixel span. The animated width runs from 0 px up to the difference between Maximum px and Minimum px.80px
Animate Width Maximum pxEnd of the pixel span. With Minimum px at 0, this is the width at full scale.220px
Animate Width ReverseSets the edge the width grows from. Cleared grows the object to the right from the left edge. Selected grows it to the left from the right edge.falseBoolean
Animate Top VariableVariable or expression that drives runtime top-position animation.PLC1.PositionTopVariable or expression
Animate Top Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Top Maximum RawEnd of the raw value span. The offset reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Top Minimum pxStart of the pixel span. A rising value moves the object upwards from its resting position by up to the difference between Maximum px and Minimum px. To move the object downwards, set Minimum px above Maximum px.100px
Animate Top Maximum pxEnd of the pixel span. A rising value moves the object upwards by up to the difference between Maximum px and Minimum px.260px
Animate Left VariableVariable or expression that drives runtime left-position animation.PLC1.PositionLeftVariable or expression
Animate Left Minimum RawStart of the raw value span. The animation scales the variable value across the difference between Maximum Raw and Minimum Raw, so keep this at 0 for a direct mapping from 0 to the Maximum Raw value.0Raw value
Animate Left Maximum RawEnd of the raw value span. The offset reaches full scale when the variable value reaches the difference between Maximum Raw and Minimum Raw.100Raw value
Animate Left Minimum pxStart of the pixel span. A rising value moves the object to the right from its resting position by up to the difference between Maximum px and Minimum px. To move the object to the left, set Minimum px above Maximum px.200px
Animate Left Maximum pxEnd of the pixel span. A rising value moves the object to the right by up to the difference between Maximum px and Minimum px.420px

Access Control

Configure access control for the DateTimePicker object.

SettingDescriptionExampleUnits
Access Control EnableEnables access control evaluation for the object.trueBoolean
Access ControlExpression controlling who can use or see the object.SYSTEM.UserGroups == "Operators"Expression
Access Control FilterCSS filter applied when access control is used to alter the object appearance.blur(0px) contrast(30%)CSS filter

Visibility

Configure the runtime visibility and blinking behavior for the DateTimePicker object.

SettingDescriptionExampleUnits
VisibilityExpression controlling whether the object is visible.PLC1.PickerVisibleExpression
BlinkExpression or boolean controlling picker blinking.PLC1.AlarmActiveBoolean or expression
Blink SpeedBlink speed used during runtime.500ms
Blink OffsetBlink offset used to stagger blinking between objects.falseBoolean
Something missing or wrong in this article? Contact us