DatePicker

A button that, when clicked on, launches a popup dialog to allow the user to select a date.

Events

  • AfterDateSet(): Event that runs after the user chooses a Date in the dialog.

  • GotFocus(): Indicates the cursor moved over the button so it is now possible to click it.

  • LostFocus(): Indicates the cursor moved away from the button so it is now no longer possible to click it.

  • TouchDown(): Indicates that the button was pressed down.

  • TouchUp(): Indicates that a button has been released.

Methods

  • LaunchPicker(): Launches the DatePicker popup.

  • SetDateToDisplay(number year, number month, number day): Allows the user to set the date to be displayed when the date picker opens. Valid values for the month field are 1-12 and 1-31 for the day field.

  • SetDateToDisplayFromInstant(InstantInTime instant): Allows the instant to set the year, month, and day to be displayed when the date picker opens. Instants are used in Clock, DatePicker, and TimePicker components.

  • SetShadow:

Properties

  • BackgroundColor: Returns the button's background color. Also available in the Designer properties.

  • Day: the Day of the month that was last picked using the DatePicker.

  • Enabled: If set, user can tap check box to cause action. Also available in the Designer properties.

  • FontBold: If set, button text is displayed in bold. Also available in the Designer properties.

  • FontItalic: If set, button text is displayed in italics. Also available in the Designer properties.

  • FontSize: Point size for button text. Also available in the Designer properties.

  • FontTypeface (designer only): Font family for button text.

  • FontTypefaceCustom. Also available in the Designer properties.

  • Height. Also available in the Designer properties.

  • Image: Image to display on button. Also available in the Designer properties.

  • Instant: Instant of date. This instant can be used with Clock component for date documentation, conversion, and matriculation.

  • Month: the number of the Month that was last picked using the DatePicker. Note that months start in 1 = January, 12 = December.

  • MonthInText: Returns the name of the Month that was last picked using the DatePicker, in textual format.

  • Shape (designer only): Specifies the button's shape (default, rounded, rectangular, oval). The shape will not be visible if an Image is being displayed.

  • ShowFeedback: Specifies if a visual feedback should be shown for a button that as an image as background. Also available in the Designer properties.

  • Text: Text to display on button. Also available in the Designer properties.

  • TextAlignment (designer only): Left, center, or right.

  • TextColor: Color for button text. Also available in the Designer properties.

  • Visible: Specifies whether the component should be visible on the screen. Value is true if the component is showing and false if hidden. Also available in the Designer properties.

  • Width: Also available in the Designer properties.

  • Year: the Year that was last picked using the DatePicker.