Skip to main content
Version: 3.5

DateTimePicker

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a control that allows the user to select or type a date and a time.

public class DateTimePicker : Control, INotifyPropertyChanged, IModified, ILabel, IReadOnly, IValidation

There are 4 tooltip labels that can be localized for this control. They are already localized in the default languages provided by Wisej. An application can localize the tooltip labels by adding the string resources to the localized Resources.resx or /Properties/Resources.resx.

  • $Next year The tooltip text displayed on the popup calendar for the next-year button.
  • $Last year The tooltip text displayed on the popup calendar for the last-year button.
  • $Next month The tooltip text displayed on the popup calendar for the next-month button.
  • $Last month The tooltip text displayed on the popup calendar for the last-month button.

Constructors​

Instance memberDateTimePicker()​

Initializes a new instance of the DateTimePicker class.

Instance memberDateTimePicker(onValueChanged)​

Initializes a new instance of the DateTimePicker class with specific initial settings.

NameTypeDescription
onValueChangedAction<Object, EventArgs>Handler for the ValueChanged event.

Instance memberDateTimePicker(label, onValueChanged)​

Initializes a new instance of DateTimePicker class with specific initial settings.

NameTypeDescription
labelStringInitial LabelText value.
onValueChangedAction<Object, EventArgs>Handler for the ValueChanged event.

Instance memberDateTimePicker(location, size, onValueChanged)​

Initializes a new instance of DateTimePicker class with specific initial settings.

NameTypeDescription
locationPointThe Point representing the upper-left corner of the control relative to the upper-left corner of its container.
sizeSizeThe Size representing the height and width of the control.
onValueChangedAction<Object, EventArgs>The delegate to invoke when the ValueChanged event is raised.

Instance memberDateTimePicker(label, location, size, onValueChanged)​

Initializes a new instance of DateTimePicker class with specific initial settings.

NameTypeDescription
labelStringInitial LabelText value.
locationPointThe Point representing the upper-left corner of the control relative to the upper-left corner of its container.
sizeSizeThe Size representing the height and width of the control.
onValueChangedAction<Object, EventArgs>The delegate to invoke when the ValueChanged event is raised.

Properties​

Instance memberAutoSize​

Boolean: Returns or sets whether the height of the control is set automatically. (Default: True)

Instance memberBorderStyle​

BorderStyle: Returns or sets the type of border that is drawn around the DateTimePicker. (Default: Solid)

Instance memberChecked​

Boolean: Returns or sets whether the checkbox in the DateTimePicker is checked and the user can change the control's value. It works in conjunction with the ShowCheckBox property. (Default: True)

Instance memberCustomFormat​

String: Returns or sets the custom date/time format string. (Default: "")

See Custom Date and Time Format Strings for the supported format definitions.

Instance memberEditable​

Boolean: Returns or sets whether the user can edit the text in the control. (Default: True)

Instance memberEnableNativeContextMenu​

Boolean: Enables or disables the browser's context menu. (Default: True)

Instance memberFirstDayOfWeek​

Day: Returns or sets the first day of the week as displayed in the month calendar. (Default: Default)

Instance memberFormat​

DateTimePickerFormat: Returns or sets the format of the date/time value displayed in the control. (Default: Long)

Instance memberHidePromptOnLeave​

Boolean: Returns or sets whether the prompt characters in the input mask are hidden when the masked datetime picker loses focus. (Default: False)

Instance memberInvalid​

Boolean: Returns or sets a value that indicates that the control is invalid.

Instance memberInvalidMessage​

String: Returns or sets the invalid message that is shown in the invalid tooltip. (Default: "")

Instance memberLabel​

LabelWrapper: Provides a label related to the control.

Instance memberLabelText​

String: Returns or sets the localizable label associated with this control. (Default: "")

Instance memberMask​

String: Returns or sets the input mask. (Default: "")

When setting an edit mask on the DateTimePicker control you must also select a Format that matches the mask. Otherwise the formatted date selected using the drop down calendar or by code will be formatted into a string that is not compatible with the edit mask. For example, if the mask is "##/##/####" the Format should be Short or CustomFormat should be "dd/MM/yyyy". See also the TextMaskFormat property to determine how the mask is stripped when reading the Text property.

Instance memberMaxDate​

DateTime: Returns or sets the maximum date and time that can be selected in the control.

Throws:

Instance memberMinDate​

DateTime: Returns or sets the minimum date and time that can be selected in the control.

Throws:

Instance memberModified​

Boolean: Returns or sets a value that indicates that the date time picker control has been modified by the user since the control was created or its contents were last set.

Instance memberNullableValue​

Nullable<DateTime>: Returns or sets the date/time Value assigned to the control with the difference that if the value is DateTime.MinValue it returns null.

This property should be used when the DateTimePicker may hold a null date and it's bound to a database nullable column. Throws:

Instance memberPromptChar​

Char: Returns or sets the character used to represent the absence of user input in the DateTimePicker control. (Default: _)

Throws:

  • ArgumentException The character specified when setting this property is not a valid prompt character.

Instance memberReadOnly​

Boolean: Returns or sets whether the control is read-only. (Default: False)

Instance memberSelectOnEnter​

Boolean: Selects the text when gaining the focus. (Default: False)

Instance memberShowCalendar​

Boolean: Returns or sets a value indicating if a calendar button (drop down control) is displayed and can be used to pick the date/time value. (Default: True)

Instance memberShowCheckBox​

Boolean: Returns or sets whether a check box is displayed to the left of the selected date. (Default: False)

Instance memberShowToday​

Boolean: Returns or sets whether the current date is displayed at the bottom of the control. (Default: False)

Instance memberShowToolTips​

Boolean: Returns or sets whether the popup calendar shows ToolTips. (Default: True)

Instance memberShowUpDown​

Boolean: Returns or sets a value indicating if the spin buttons (up and down controls) are displayed and can be used to adjust the date/time value. (Default: False)

Instance memberShowWeekNumbers​

Boolean: Returns or sets whether the calendar control displays week numbers (1-52) to the left of each row of days. (Default: True)

Instance memberText​

String: Returns or sets the text associated with this control. (Default: "")

Instance memberTextMaskFormat​

MaskFormat: Since 3.2.8 Returns or sets a value that determines whether literals and prompt characters are included in the Text value when the DateTimePicker also specifies a Mask. (Default: IncludeLiterals)

This property lets you control the value returned by the Text property when there is an edit Mask. The default is to remove the prompt and keep the literal in order to return a text value that can be parsed to a valid date: i.e. "1_/10/__23" is retuned as "1/10/23". Since 3.2.8 Note that when the value is null or empty, and regardless of the mask, the Text property returns an empty string.

Instance memberTodayDate​

DateTime: Returns or sets the value that is used by DateTimePicker as today's date.

Throws:

  • ArgumentOutOfRangeException The value is less than the minimum allowable date; or the value is greater than the maximum allowable date.

Instance memberTodayFormat​

String: Returns or sets the format string used to display today's date. (Default: "d")

See Custom Date and Time Format Strings for the supported format definitions.

Instance memberTools​

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

Instance memberValue​

DateTime: Returns or sets the DateTime value assigned to the control.

Throws:

Instance memberWatermark​

String: Returns or sets the text to show when the field is empty. (Default: null)

Events​

Instance memberCheckedChanged​

EventHandler Fired when the value of the Checked property changes.

Instance memberCloseUp​

EventHandler Fired when the drop-down calendar is dismissed and disappears.

EventHandler Fired when the drop-down calendar is shown.

Instance memberEditableChanged​

EventHandler Fired when the value of the Editable property has changed.

Instance memberFormatChanged​

EventHandler Fired when the Format property value has changed.

Instance memberMaskChanged​

EventHandler Occurs after the input mask is changed.

Instance memberModifiedChanged​

EventHandler Fired when the value of the Modified property has changed.

Instance memberReadOnlyChanged​

EventHandler Fired when the value of the ReadOnly property has changed.

Instance memberToolClick​

ToolClickEventHandler Fired when a ComponentTool is clicked.

Instance memberValueChanged​

EventHandler Fired when the Value property changes.

Inherited By​

NameDescription
DataGridViewDateTimePickerEditingControlRepresents a DateTimePicker control that can be hosted in a DataGridViewDateTimePickerCell.

Implements​

NameDescription
IBindableComponentBindable components implement this interface.
IDropTargetControls that support drag & drop operations implement this interface.
ILabelProvides access to the LabelWrapper associated with the controls that implement this interface.
IReadOnlyProvides access to the ReadOnly property for coontrols that support the read-only mode.
IModifiedProvides access to the Modified property and ModifiedChanged event for controls that implement this interface.
IValidationProvides access to the validation events and properties property for controls that support validation.
IWisejComponentAll wisej components implement this interface.
IWisejControlAll wisej controls derived from the Control class must implement this interface.
IWisejSerializableAllows an object to serialize itself.