OlkComboBox 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 supports the display of a selection from a drop-down list of all choices.
public interface class OlkComboBox : Microsoft::Office::Interop::Outlook::_OlkComboBox, Microsoft::Office::Interop::Outlook::OlkComboBoxEvents_Event[System.Runtime.InteropServices.Guid("000672DE-0000-0000-C000-000000000046")]
public interface OlkComboBox : Microsoft.Office.Interop.Outlook._OlkComboBox, Microsoft.Office.Interop.Outlook.OlkComboBoxEvents_EventPublic Interface OlkComboBox
Implements _OlkComboBox, OlkComboBoxEvents_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 _OlkComboBox. For information about the event members of the COM object, see OlkComboBoxEvents_Event.
Before you use this control for the first time in the forms designer, add the Microsoft Outlook Combo Box Control to the control toolbox. You can only add this control to a form region in an Outlook form using the forms designer.
The following is an example of a combo box control that has been bound to the Sensitivity field. 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.
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 _OlkComboBox) |
| AutoTab |
Returns or sets a Boolean (bool in C#) that specifies if a tab is inserted automatically when the control has been filled to the maximum length specified. Read/write. (Inherited from _OlkComboBox) |
| 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 _OlkComboBox) |
| BackColor |
Returns or sets a UInteger (uint in C#) value that indicates the background color of the control. Read/write. (Inherited from _OlkComboBox) |
| BorderStyle |
Returns or sets an OlBorderStyle constant that defines the style of the border around the control. Read/write. (Inherited from _OlkComboBox) |
| DragBehavior |
Returns or sets an OlDragBehavior constant that indicates whether the system enables the drag-and-drop feature for this control. Read/write. (Inherited from _OlkComboBox) |
| Enabled |
Returns or sets a Boolean (bool in C#) that indicates if the control is allowed to function. Read/write. (Inherited from _OlkComboBox) |
| EnterFieldBehavior |
Returns or sets an OlEnterFieldBehavior constant that specifies the selection behavior when entering the control. Read/write. (Inherited from _OlkComboBox) |
| Font |
Returns a StdFont that represents the font used to render the text inside the control. Read-only. (Inherited from _OlkComboBox) |
| ForeColor |
Returns or sets a UInteger (uint in C#) value that indicates the foreground color of the control. Read/write. (Inherited from _OlkComboBox) |
| 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 _OlkComboBox) |
| ListCount |
Returns an Integer (int in C#) value that specifies the number of elements in the drop-down list of the combo box control. Read-only. (Inherited from _OlkComboBox) |
| ListIndex |
Returns or sets an Integer (int in C#) value that indicates the location of the currently selected element in the list of the combo box control. Read/write. (Inherited from _OlkComboBox) |
| 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 _OlkComboBox) |
| MaxLength |
Returns or sets an Integer (int in C#) value that specifies the maximum number of characters for the Value of this control. Read/write. (Inherited from _OlkComboBox) |
| MouseIcon |
Returns or sets a StdPicture that represents a custom picture to the mouse cursor for this control. Read/write. (Inherited from _OlkComboBox) |
| 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 _OlkComboBox) |
| SelectionMargin |
Returns or sets a Boolean (bool in C#) that specifies whether the user can select a line of text by clicking in the region to the left of the text. Read/write. (Inherited from _OlkComboBox) |
| SelLength |
Returns or sets an Integer (int in C#) value that specifies the number of characters in the current selection. Read/write. (Inherited from _OlkComboBox) |
| SelStart |
Returns or sets an Integer (int in C#) value that specifies either the starting point of the selected text or the insertion point if no text has been selected. Read/write. (Inherited from _OlkComboBox) |
| SelText |
Returns a String (string in C#) that represents the selected portion of the value of the combo box. Read-only. (Inherited from _OlkComboBox) |
| Style |
Returns or sets an OlComboBoxStyle constant to specify how the user can choose or set the control's value. Read/write. (Inherited from _OlkComboBox) |
| Text |
Returns or sets a String (string in C#) that is the text displayed in the control. Read/write. (Inherited from _OlkComboBox) |
| TextAlign |
Returns or sets an OlTextAlign constant that specifies how text is aligned in the control. Read/write. (Inherited from _OlkComboBox) |
| TopIndex |
Returns or sets an Integer (int in C#) value that represents the index of the item at the top of the displayed portion of the list in the combo box. Read/write. (Inherited from _OlkComboBox) |
| Value |
Returns or sets an Object that represents the content selected in the list displayed by the control. Read/write. (Inherited from _OlkComboBox) |
Methods
| AddItem(String, Object) |
Adds an item to the list, optionally specifying an index for the new item to appear in the list. (Inherited from _OlkComboBox) |
| Clear() |
Removes all objects from the list in the combo box. (Inherited from _OlkComboBox) |
| Copy() |
Copies the contents of the control to the clipboard. (Inherited from _OlkComboBox) |
| Cut() |
Removes the contents of the control and copies the contents to the clipboard. (Inherited from _OlkComboBox) |
| DropDown() |
Expands the drop-down portion of the combo box. (Inherited from _OlkComboBox) |
| GetItem(Int32) |
Obtains a String (string in C#) that represents an item at the specified location in the list of the combo box control. (Inherited from _OlkComboBox) |
| Paste() |
Pastes the contents of the clipboard in the control. (Inherited from _OlkComboBox) |
| RemoveItem(Int32) |
Removes the specified item from the list. (Inherited from _OlkComboBox) |
| SetItem(Int32, String) |
Sets the item at the specified location in the list of the combo box to the specified value. (Inherited from _OlkComboBox) |
Events
| AfterUpdate |
Occurs after the data in the control has been changed through the user interface. (Inherited from OlkComboBoxEvents_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 OlkComboBoxEvents_Event) |
| Change |
Occurs when the selection in the list displayed by the control changes. (Inherited from OlkComboBoxEvents_Event) |
| Click |
Occurs when the user clicks inside the control. (Inherited from OlkComboBoxEvents_Event) |
| DoubleClick |
Occurs when the user double-clicks inside the control. (Inherited from OlkComboBoxEvents_Event) |
| DropButtonClick |
Occurs when the user clicks the drop button to expand the drop-down list in the combo box control, or when the DropDown() method is called programmatically. (Inherited from OlkComboBoxEvents_Event) |
| Enter |
Occurs when the control receives focus, immediately after the previous control's Exit event. (Inherited from OlkComboBoxEvents_Event) |
| Exit |
Occurs just after the focus passes from this control to another control on the same form. (Inherited from OlkComboBoxEvents_Event) |
| KeyDown |
Occurs when a user presses a key. (Inherited from OlkComboBoxEvents_Event) |
| KeyPress |
Occurs when the user presses an ANSI key. (Inherited from OlkComboBoxEvents_Event) |
| KeyUp |
Occurs when the user releases a key. (Inherited from OlkComboBoxEvents_Event) |
| MouseDown |
Occurs when the user presses a mouse button on the control. (Inherited from OlkComboBoxEvents_Event) |
| MouseMove |
Occurs after a mouse movement has been registered over the control. (Inherited from OlkComboBoxEvents_Event) |
| MouseUp |
Occurs after the user releases a mouse button that has been pressed on the control. (Inherited from OlkComboBoxEvents_Event) |