OlkListBox Interface

Definition

A control that supports displaying a scrollable list of items.

public interface class OlkListBox : Microsoft::Office::Interop::Outlook::_OlkListBox, Microsoft::Office::Interop::Outlook::OlkListBoxEvents_Event
[System.Runtime.InteropServices.Guid("000672DF-0000-0000-C000-000000000046")]
public interface OlkListBox : Microsoft.Office.Interop.Outlook._OlkListBox, Microsoft.Office.Interop.Outlook.OlkListBoxEvents_Event
Public Interface OlkListBox
Implements _OlkListBox, OlkListBoxEvents_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 _OlkListBox. For information about the event members of the COM object, see OlkListBoxEvents_Event.

Before you use this control for the first time in the forms designer, add the Microsoft Outlook List 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 the list box control that has been bound to the Sensitivity field at runtime. This control supports Microsoft Windows themes.

For more information about Outlook controls, see Controls in a Custom Form

Properties

BackColor

Returns or sets a UInteger (uint in C#) value that indicates the background color of the control. Read/write.

(Inherited from _OlkListBox)
BorderStyle

Returns or sets an OlBorderStyle constant that defines the style of the border around the control. Read/write.

(Inherited from _OlkListBox)
Enabled

Returns or sets a Boolean (bool in C#) that indicates if the control is allowed to function. Read/write.

(Inherited from _OlkListBox)
Font

Returns an StdFont that represents the font used to render the text inside the control. Read-only.

(Inherited from _OlkListBox)
ForeColor

Returns or sets a UInteger (uint in C#) value that indicates the foreground color of the control. Read/write.

(Inherited from _OlkListBox)
ListCount

Returns an Integer (int in C#) value that specifies the number of elements in the drop-down list of the list box control. Read-only.

(Inherited from _OlkListBox)
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 _OlkListBox)
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 _OlkListBox)
MatchEntry

Returns or sets an OlMatchEntry constant that indicates how the control searches its list as the user types. Read/write.

(Inherited from _OlkListBox)
MouseIcon

Returns or sets a StdPicture that represents the custom picture to the mouse cursor for this control. Read/write.

(Inherited from _OlkListBox)
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 _OlkListBox)
MultiSelect

Returns or sets an OlMultiSelect constant that specifies the range of items that can be selected in the list box control. Read/write.

(Inherited from _OlkListBox)
Text

Returns or sets a String (string in C#) that is the text displayed in the control. Read/write.

(Inherited from _OlkListBox)
TextAlign

Returns or sets an OlTextAlign constant that specifies how text is aligned in the control. Read/write.

(Inherited from _OlkListBox)
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. Read/write.

(Inherited from _OlkListBox)
Value

Returns or sets an Object that represents the content selected in the list displayed by the control. Read/write.

(Inherited from _OlkListBox)

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 _OlkListBox)
Clear()

Removes all objects from the list.

(Inherited from _OlkListBox)
Copy()

Copies the current selection in the drop-down list to the clipboard.

(Inherited from _OlkListBox)
GetItem(Int32)

Obtains a String (string in C#) that represents an item at the specified location in the list.

(Inherited from _OlkListBox)
GetSelected(Int32)

Returns a Boolean (bool in C#) that indicates if the indexed item is currently selected.

(Inherited from _OlkListBox)
RemoveItem(Int32)

Removes the specified item from the list.

(Inherited from _OlkListBox)
SetItem(Int32, String)

Sets the item at the specified location in the list to the specified value.

(Inherited from _OlkListBox)
SetSelected(Int32, Boolean)

Sets the selected state of an item at the specified location in the list to the given Selected value.

(Inherited from _OlkListBox)

Events

AfterUpdate

Occurs after the data in the control has been changed through the user interface.

(Inherited from OlkListBoxEvents_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 OlkListBoxEvents_Event)
Change

Occurs when the selection in the list displayed by the control changes.

(Inherited from OlkListBoxEvents_Event)
Click

Occurs when the user clicks inside the control.

(Inherited from OlkListBoxEvents_Event)
DoubleClick

Occurs when the user double-clicks inside the control.

(Inherited from OlkListBoxEvents_Event)
Enter

Occurs when the control receives focus, immediately after the previous control's Exit event.

(Inherited from OlkListBoxEvents_Event)
Exit

Occurs just after the focus passes from this control to another control on the same form.

(Inherited from OlkListBoxEvents_Event)
KeyDown

Occurs when a user presses a key.

(Inherited from OlkListBoxEvents_Event)
KeyPress

Occurs when the user presses an ANSI key.

(Inherited from OlkListBoxEvents_Event)
KeyUp

Occurs when the user releases a key.

(Inherited from OlkListBoxEvents_Event)
MouseDown

Occurs when the user presses a mouse button on the control.

(Inherited from OlkListBoxEvents_Event)
MouseMove

Occurs after a mouse movement has been registered over the control.

(Inherited from OlkListBoxEvents_Event)
MouseUp

Occurs after the user releases a mouse button that has been pressed on the control.

(Inherited from OlkListBoxEvents_Event)

Applies to