DateTimePicker.Format Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the format of the date and time displayed in the control.

public:
 property System::Windows::Forms::DateTimePickerFormat Format { System::Windows::Forms::DateTimePickerFormat get(); void set(System::Windows::Forms::DateTimePickerFormat value); };

public System.Windows.Forms.DateTimePickerFormat Format { get; set; }

member this.Format : System.Windows.Forms.DateTimePickerFormat with get, set

Public Property Format As DateTimePickerFormat

Property Value

DateTimePickerFormat

One of the DateTimePickerFormat values. The default is Long.

Exceptions

InvalidEnumArgumentException

The value assigned is not one of the DateTimePickerFormat values.

Examples

The following code example sets the CustomFormat property so that the DateTimePicker will display the date as "June 01, 2001 - Friday". This code assumes that an instance of a DateTimePicker control has been created on a Form.

public:
   void SetMyCustomFormat()
   {
      // Set the Format type and the CustomFormat string.
      dateTimePicker1->Format = DateTimePickerFormat::Custom;
      dateTimePicker1->CustomFormat = "MMMM dd, yyyy - dddd";
   }

public void SetMyCustomFormat()
{
   // Set the Format type and the CustomFormat string.
   dateTimePicker1.Format = DateTimePickerFormat.Custom;
   dateTimePicker1.CustomFormat = "MMMM dd, yyyy - dddd";
}

Public Sub SetMyCustomFormat()
    ' Set the Format type and the CustomFormat string.
    dateTimePicker1.Format = DateTimePickerFormat.Custom
    dateTimePicker1.CustomFormat = "MMMM dd, yyyy - dddd"
End Sub

Remarks

This property determines the date/time format the date is displayed in. The date/time format is based on the user's regional settings in their operating system.

Note

The Format property must be set to DateTimePickerFormat.Custom for the CustomFormat property to affect the formatting of the displayed date and time.

To display only time in a DateTimePicker, set the Format to Time, and the ShowUpDown property to true.

Applies to

Share via