OlkOptionButton Interface

Definition

A control that supports a single exclusive selection within a defined group of option button choices.

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

Before you use this control for the first time in the forms designer, add the Microsoft Outlook Option Button 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 an option button control at runtime. This control supports Microsoft Windows themes.

Typically more than one option button control is defined in a group. Each option button control in the group provides a single, mutually exclusive choice. Selecting one option button in the group will automatically remove the prior selection of another option button in the same group.

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

Properties

Accelerator

Returns or sets a String (string in C#) value that represents the accelerator or hot key for the control. Read/write.

(Inherited from _OlkOptionButton)
Alignment

Returns or sets an OlAlignment constant that indicates the position of a control relative to its caption. Read/write.

(Inherited from _OlkOptionButton)
BackColor

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

(Inherited from _OlkOptionButton)
BackStyle

Returns or sets an OlBackStyle constant that changes the background style of the control between transparent and opaque. Read/write.

(Inherited from _OlkOptionButton)
Caption

Returns or sets a String (string in C#) that appears on an object to identify or describe it. Read/write.

(Inherited from _OlkOptionButton)
Enabled

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

(Inherited from _OlkOptionButton)
Font

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

(Inherited from _OlkOptionButton)
ForeColor

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

(Inherited from _OlkOptionButton)
GroupName

Returns or sets a String (string in C#) that identifies a group of mutually exclusive option button controls. Read/write.

(Inherited from _OlkOptionButton)
MouseIcon

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

(Inherited from _OlkOptionButton)
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 _OlkOptionButton)
Value

Returns or sets an Object that represents the state of the control. Read/write.

(Inherited from _OlkOptionButton)
WordWrap

Returns or sets a Boolean (bool in C#) that specifies whether the contents of a control automatically wrap at the end of a line. Read/write.

(Inherited from _OlkOptionButton)

Events

AfterUpdate

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

(Inherited from OlkOptionButtonEvents_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 OlkOptionButtonEvents_Event)
Change

Occurs when the Value property changes.

(Inherited from OlkOptionButtonEvents_Event)
Click

Occurs when the user clicks inside the control.

(Inherited from OlkOptionButtonEvents_Event)
DoubleClick

Occurs when the user double-clicks inside the control.

(Inherited from OlkOptionButtonEvents_Event)
Enter

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

(Inherited from OlkOptionButtonEvents_Event)
Exit

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

(Inherited from OlkOptionButtonEvents_Event)
KeyDown

Occurs when a user presses a key.

(Inherited from OlkOptionButtonEvents_Event)
KeyPress

Occurs when the user presses an ANSI key.

(Inherited from OlkOptionButtonEvents_Event)
KeyUp

Occurs when the user releases a key.

(Inherited from OlkOptionButtonEvents_Event)
MouseDown

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

(Inherited from OlkOptionButtonEvents_Event)
MouseMove

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

(Inherited from OlkOptionButtonEvents_Event)
MouseUp

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

(Inherited from OlkOptionButtonEvents_Event)

Applies to