OlkTimeControl Interface
Definition
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.
A control that displays the Outlook time drop-down menu.
public interface class OlkTimeControl : Microsoft::Office::Interop::Outlook::_OlkTimeControl, Microsoft::Office::Interop::Outlook::OlkTimeControlEvents_Event[System.Runtime.InteropServices.Guid("000672EF-0000-0000-C000-000000000046")]
public interface OlkTimeControl : Microsoft.Office.Interop.Outlook._OlkTimeControl, Microsoft.Office.Interop.Outlook.OlkTimeControlEvents_EventPublic Interface OlkTimeControl
Implements _OlkTimeControl, OlkTimeControlEvents_Event- Derived
- Attributes
- Implements
Remarks
This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _OlkTimeControl. For information about the event members of the COM object, see OlkTimeControlEvents_Event.
Before you use this control for the first time in the forms designer, add the Microsoft Outlook Time Control to the control toolbox. You can only add this control to a form region in an Outlook form using the forms designer; you cannot add this control to a Visual Basic UserForm object in the Visual Basic Editor.
The time control has several different modes which are exposed via properties on the control. It can be bound to any DateTime property, and can be bound to the same property as a date control to provide the capability to select both date and time.
The following is an example of the time control at runtime. This control supports Microsoft Windows themes.
If the Click event is implemented but the DropButtonClick event is not implemented, then clicking the drop button will fire only the Click event.
If you bind the time control to the start time or the end time of an appointment item, you must use an add-in to control enabling and disabling of the time control. In particular, when the user sets the appointment as an all-day event, you must use code to disable the time controls for the start time and the end time, and enable the controls only when the user clears this setting.
For more information about Outlook controls, see Controls in a Custom Form
Properties
| AutoSize |
Returns or sets a Boolean (bool in C#) that automatically sizes the control to display the entire contents. Read/write. (Inherited from _OlkTimeControl) |
| AutoWordSelect |
Returns or sets a Boolean (bool in C#) that specifies whether a word or a character is the basic unit used to extend a selection. Read/write. (Inherited from _OlkTimeControl) |
| BackColor |
Returns or sets a UInteger (uint in C#) value that indicates the background color of the control. Read/write. (Inherited from _OlkTimeControl) |
| BackStyle |
Returns or sets an OlBackStyle constant that changes the background style of the control between transparent and opaque. Read/write. (Inherited from _OlkTimeControl) |
| Enabled |
Returns or sets a Boolean (bool in C#) that indicates if the control is allowed to function. Read/write. (Inherited from _OlkTimeControl) |
| EnterFieldBehavior |
Returns or sets an OlEnterFieldBehavior constant that specifies the selection behavior when entering the control. Read/write. (Inherited from _OlkTimeControl) |
| Font |
Returns an StdFont that represents the font used to render the text inside the control. Read-only. (Inherited from _OlkTimeControl) |
| ForeColor |
Returns or sets a UInteger (uint in C#) value that indicates the foreground color of the control. Read/write. (Inherited from _OlkTimeControl) |
| HideSelection |
Returns or sets a Boolean (bool in C#) that specifies if a selection is displayed or hidden for the control when the control loses focus. Read/write. (Inherited from _OlkTimeControl) |
| IntervalTime |
Returns or sets a DateTime that specifies the number of minutes displayed as an interval used for the olTimeStyleTimeDuration style setting on the time control. Read/write. (Inherited from _OlkTimeControl) |
| Locked |
Returns or sets a Boolean (bool in C#) that specifies whether or not the control is locked from being changed. Read/write. (Inherited from _OlkTimeControl) |
| MouseIcon |
Returns or sets a StdPicture that represents the custom picture to the mouse cursor for this control. Read/write. (Inherited from _OlkTimeControl) |
| MousePointer |
Returns or sets an OlMousePointer constant that specifies the type of pointer displayed when the user positions the mouse over the control. Read/write. (Inherited from _OlkTimeControl) |
| ReferenceTime |
Returns or sets a DateTime that specifies a reference time used for the olTimeStyleTimeDuration style setting on the time control. Read/write. (Inherited from _OlkTimeControl) |
| Style |
Returns or sets an OlTimeStyle constant that specifies the style of the time control. Read/write. (Inherited from _OlkTimeControl) |
| Text |
Returns or sets a String (string in C#) that is the text displayed in the control. Read/write. (Inherited from _OlkTimeControl) |
| TextAlign |
Returns or sets an OlTextAlign constant that specifies how text is aligned in the control. Read/write. (Inherited from _OlkTimeControl) |
| Time |
Returns or sets a DateTime that represents the time value currently selected in the control. Read/write. (Inherited from _OlkTimeControl) |
| Value |
Returns or sets an Object that represents the content of the control. Read/write. (Inherited from _OlkTimeControl) |
Methods
| DropDown() |
Expands the time drop-down list of the time control. (Inherited from _OlkTimeControl) |
Events
| AfterUpdate |
Occurs after the data in the control has been changed through the user interface. (Inherited from OlkTimeControlEvents_Event) |
| BeforeUpdate |
Occurs when the data in the control is changed through the user interface and is about to be saved to the item. (Inherited from OlkTimeControlEvents_Event) |
| Change |
Occurs when the Value property changes. (Inherited from OlkTimeControlEvents_Event) |
| Click |
Occurs when the user clicks inside the control. (Inherited from OlkTimeControlEvents_Event) |
| DoubleClick |
Occurs when the user double-clicks inside the control. (Inherited from OlkTimeControlEvents_Event) |
| DropButtonClick |
Occurs when the user clicks the drop button to expand the time drop-down list in the time control. (Inherited from OlkTimeControlEvents_Event) |
| Enter |
Occurs before the control actually receives the focus from a control on the same form. (Inherited from OlkTimeControlEvents_Event) |
| Exit |
Occurs just after the focus passes from this control to another control on the same form. (Inherited from OlkTimeControlEvents_Event) |
| KeyDown |
Occurs when a user presses a key. (Inherited from OlkTimeControlEvents_Event) |
| KeyPress |
Occurs when the user presses an ANSI key. (Inherited from OlkTimeControlEvents_Event) |
| KeyUp |
Occurs when the user releases a key. (Inherited from OlkTimeControlEvents_Event) |
| MouseDown |
Occurs when the user presses a mouse button on the control. (Inherited from OlkTimeControlEvents_Event) |
| MouseMove |
Occurs after a mouse movement has been registered over the control. (Inherited from OlkTimeControlEvents_Event) |
| MouseUp |
Occurs after the user releases a mouse button that has been pressed on the control. (Inherited from OlkTimeControlEvents_Event) |