The date/time edit control implements an edit field that allows users to edit date information in various display formats using either keyboard or mouse with optional spin buttons. The date is internally represented with a COleDateTime object, limiting it to 32-bit environments.

Some features of the date time control include:

• Default and customizable display formats

• Null date entry mode

• Fast entry mode (automatic cursor advancement as data is entered)

• Minimum/maximum range restriction

• Spinner buttons

• Popup calendar

• Y2K compliance

The SECDateTimeCtrl class implements the date/time control. The entry field is divided into a number of subfields, depending on the specified format. Each subfield or component is controlled by a gadget class specialized for the input and display of that particular subfield. Each gadget class is based on SECDTGadget.

4.10.1 SECDateTimeCtrl

SECDateTimeCtrl is a date/time editing control class. SECDateTimeCtrl manages several gadget objects to display the data in a specified format.

4.10.1.1 SECDateTimeCtrl styles

Table 11: Extended Styles for SECDateTimeCtrl

4.10.1.2 SECDateTimeCtrl messages

4.10.2 SECDTGadget

SECDTGadget is an abstract base class that handles the input and display of data in the subfields of a date/time control. SECDateTimeCtrl uses several subclasses of SECDTGadget including:

• SECDTStaticGadget. Implements a non-editable text gadget.

• SECDTNumericGadget. Implements an editable numeric gadget.

• SECDTListGadget. Implements a text gadget with a defined list of possible strings.

• SECDTButtonGadget. Implements a simple push button gadget.

• SECDTSpinGadget. Implements a spin button gadget.

4.10.3 Date Formats

SECDataTimeCtrl's SetFormat() method specifies how the date or time data is displayed. The format determines which subfields or gadgets are shown. Several predefined format types are available. In addition, you can specify custom formats using codes in a user-defined string.

4.10.3.1 Predefined Format Types

The table below lists the format types that the application can pass as a parameter to SetFormat(). To specify a custom format, the user-defined string is passed to SetFormat(); don't pass SECDateTimeCtrl::Custom.

Table 12: Supported Format Types for SetFormat()

4.10.3.2 Format Strings

You can use the codes in the following table to build a custom format string.

Table 13: Format Strings Supported by SECDateTimeCtrl

4.10.4 Null Data Entry Mode

SECDateTimeCtrl supports a null date entry mode. This mode allows you to enter date time information in an empty control. You can specify a character to fill the fields of the control so that the user can see them. The following figure is an example date time control that has been put into null date entry mode.

4.10.5 Using SECDateTimeCtrl

The following sections give tips on using the SECDateTimeCtrl class.

To use the date/time control in a dialog:

1. Create an edit control on a dialog resource in the resource editor.

2. Add a data member to the dialog class for the date time control. For example:

   SECDateTimeCtrl m_dateCtrl;

3. In the OnInitDialog() method of the dialog, set the display format for the date time object with the SetFormat() method. For example:

   m_dateCtrl.SetFormat(SECDateTimeCtrl::Time);

4. After setting the display format, attach the resource edit control to the date time object with the AttachDateTimeCtrl() method. For example:

   VERIFY(m_dateCtrl.AttachDateTimeCtrl(IDC_TIME, this, SEC_DTS_UPDOWN));

To set the date or time for the control:

Call the SetDateTime(), SetDate(), or SetTime() methods. For example:

m_dateCtrl.SetDateTime(minDate);

To change a date/time control to the null date entry mode:

Call the SetNull() method. This method accepts a character that is used to blank out the control. For example:

m_dateCtrl.SetNull('_');

To make the control always remain in the null date entry mode:

m_dateCtrl.SetNull('_', TRUE);

To clear the control using the delete key:

1. Derive a class from SECDateTimeCtrl.

2. Override the OnKeyDown() method. In this override, test for the VK_DELETE key, and if detected, call the SetNull() method. For example:

   void CMyDateTimeCtrl::OnKeyDown(UINT nChar, UINT nRepCnt, UINT nFlags) { // TODO: Add your message handler code here and/or call default SECDateTimeCtrl::OnKeyDown(nChar, nRepCnt, nFlags); if (VK_DELETE == nChar) { SetNull('_'); } }

To set focus back to the first gadget of the control:

1. Derive a class from SECDateTimeCtrl.

2. Create a method, or in a method override, use the following code to locate the first gadget index:

   // Find first gadget int nGadget; for(nGadget = m_nFixed; nGadget < m_gadgets.GetSize() && !(m_gadgets[nGadget]->GetStyle() & SECDTGadget::WantFocus); nGadget++);

3. When you locate the first gadget index, call the Enable() method on the gadget, and then call the BringIntoView() method. For example:

   if(nGadget >= m_nFixed && nGadget < m_gadgets.GetSize()) { m_gadgets[m_nCurGadget = nGadget]->Enable(TRUE); BringIntoView(m_nCurGadget); }

To change the color of the text in the control:

1. In the parent window, override OnCtlColor() and set the text and background colors using the SetBkColor() and SetTextColor() methods. For example:

   HBRUSH CDatetimeDlg::OnCtlColor(CDC* pDC, CWnd* pWnd, UINT nCtlColor) { HBRUSH hbr = CPropertyPage::OnCtlColor(pDC, pWnd, nCtlColor); if (pWnd-> IsKindOf(RUNTIME_CLASS(SECDateTimeCtrl)) && nCtlColor == CTLCOLOR_EDIT) { //pDC->SetBkMode(OPAQUE); pDC->SetBkColor(RGB(75,75,255)); pDC->SetTextColor(RGB(255,255,0)); } // for all other windows, use the default brush from the // base class else hbr = CPropertyPage::OnCtlColor(pDC, pWnd, nCtlColor); return hbr; }

4.10.6 Date/Time Edit Control Sample