v3.2
HomeNewsSupportVideos

DateTimePicker

Wisej.Web.DateTimePicker

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.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

DateTimePicker()

Initializes a new instance of the DateTimePicker class.

Properties

AutoSize

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

BorderStyle

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

Checked

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)

CustomFormat

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

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

Editable

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

EnableNativeContextMenu

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

FirstDayOfWeek

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

Format

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

HidePromptOnLeave

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

Invalid

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

InvalidMessage

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

Label

LabelWrapper: Provides a label related to the control.

LabelText

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

Mask

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.

MaxDate

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

Throws:

MinDate

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

Throws:

Modified

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.

NullableValue

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:

PromptChar

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.

ReadOnly

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

SelectOnEnter

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

ShowCalendar

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)

ShowCheckBox

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

ShowToday

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

ShowToolTips

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

ShowUpDown

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)

ShowWeekNumbers

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

Text

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

TextMaskFormat

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.

TodayDate

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.

TodayFormat

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.

Tools

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

Value

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

Throws:

Watermark

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

Events

CheckedChanged

EventHandler Fired when the value of the Checked property changes.

CloseUp

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

DropDown

EventHandler Fired when the drop-down calendar is shown.

EditableChanged

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

FormatChanged

EventHandler Fired when the Format property value has changed.

MaskChanged

EventHandler Occurs after the input mask is changed.

ModifiedChanged

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

ReadOnlyChanged

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

ToolClick

ToolClickEventHandler Fired when a ComponentTool is clicked.

ValueChanged

EventHandler Fired when the Value property changes.

Inherited By

NameDescription

DataGridViewDateTimePickerEditingControl

Represents a DateTimePicker control that can be hosted in a DataGridViewDateTimePickerCell.

Implements

NameDescription

IBindableComponent

Bindable components implement this interface.

IDropTarget

Controls that support drag & drop operations implement this interface.

ILabel

Provides access to the LabelWrapper associated with the controls that implement this interface.

IReadOnly

Provides access to the ReadOnly property for coontrols that support the read-only mode.

IModified

Provides access to the Modified property and ModifiedChanged event for controls that implement this interface.

IValidation

Provides access to the validation events and properties property for controls that support validation.

IWisejComponent

All wisej components implement this interface.

IWisejControl

All wisej controls derived from the Control class must implement this interface.

IWisejSerializable

Allows an object to serialize itself.

Last updated