OlkCommandButton Interface

Reference

Definition

Namespace:: Microsoft.Office.Interop.Outlook

Assembly:: Microsoft.Office.Interop.Outlook.dll

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 a user action specified as a command.

public interface class OlkCommandButton : Microsoft::Office::Interop::Outlook::_OlkCommandButton, Microsoft::Office::Interop::Outlook::OlkCommandButtonEvents_Event

[System.Runtime.InteropServices.Guid("000672DB-0000-0000-C000-000000000046")]
public interface OlkCommandButton : Microsoft.Office.Interop.Outlook._OlkCommandButton, Microsoft.Office.Interop.Outlook.OlkCommandButtonEvents_Event

Public Interface OlkCommandButton
Implements _OlkCommandButton, OlkCommandButtonEvents_Event

Derived: Microsoft.Office.Interop.Outlook.OlkCommandButtonClass

Attributes: GuidAttribute

Implements: _OlkCommandButton OlkCommandButtonEvents_Event

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 _OlkCommandButton. For information about the event members of the COM object, see OlkCommandButtonEvents_Event.

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

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 _OlkCommandButton)
AutoSize	Returns or sets a Boolean (bool in C#) that automatically sizes the control to display the entire contents. Read/write. (Inherited from _OlkCommandButton)
Caption	Returns or sets a String (string in C#) that appears on an object to identify or describe it. Read/write. (Inherited from _OlkCommandButton)
DisplayDropArrow	Returns or sets a Boolean (bool in C#) that enables the rendering of a downward-pointing arrow on the button. Read/write. (Inherited from _OlkCommandButton)
Enabled	Returns or sets a Boolean (bool in C#) that indicates if the control is allowed to function. Read/write. (Inherited from _OlkCommandButton)
Font	Returns an StdFont that represents the font used to render the text inside the control. Read-only. (Inherited from _OlkCommandButton)
MouseIcon	Returns or sets an StdPicture that represents a custom picture to the mouse cursor for this control. Read/write. (Inherited from _OlkCommandButton)
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 _OlkCommandButton)
Picture	Returns or sets an StdPicture that represents the picture that is displayed on the control. Read/write. (Inherited from _OlkCommandButton)
PictureAlignment	Returns or sets an OlPictureAlignment constant that specifies the alignment of the image and the text on the button. Read/write. (Inherited from _OlkCommandButton)
TextAlign	Returns or sets an OlTextAlign constant that specifies how text is aligned in the control. Read/write. (Inherited from _OlkCommandButton)
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 _OlkCommandButton)

Events

AfterUpdate	Occurs after the data in the control has been changed through the user interface. (Inherited from OlkCommandButtonEvents_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 OlkCommandButtonEvents_Event)
Click	Occurs when the user clicks inside the control. (Inherited from OlkCommandButtonEvents_Event)
DoubleClick	Occurs when the user double-clicks inside the control. (Inherited from OlkCommandButtonEvents_Event)
Enter	Occurs before the control actually receives the focus from a control on the same form. (Inherited from OlkCommandButtonEvents_Event)
Exit	Occurs just after the focus passes from this control to another control on the same form. (Inherited from OlkCommandButtonEvents_Event)
KeyDown	Occurs when a user presses a key. (Inherited from OlkCommandButtonEvents_Event)
KeyPress	Occurs when the user presses an ANSI key. (Inherited from OlkCommandButtonEvents_Event)
KeyUp	Occurs when the user releases a key. (Inherited from OlkCommandButtonEvents_Event)
MouseDown	Occurs when the user presses a mouse button on the control. (Inherited from OlkCommandButtonEvents_Event)
MouseMove	Occurs after a mouse movement has been registered over the control. (Inherited from OlkCommandButtonEvents_Event)
MouseUp	Occurs after the user releases a mouse button that has been pressed on the control. (Inherited from OlkCommandButtonEvents_Event)

Applies to

Share via