OlkTextBox 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 a single or multiple-line data entry.
public interface class OlkTextBox : Microsoft::Office::Interop::Outlook::_OlkTextBox, Microsoft::Office::Interop::Outlook::OlkTextBoxEvents_Event[System.Runtime.InteropServices.Guid("000672DA-0000-0000-C000-000000000046")]
public interface OlkTextBox : Microsoft.Office.Interop.Outlook._OlkTextBox, Microsoft.Office.Interop.Outlook.OlkTextBoxEvents_EventPublic Interface OlkTextBox
Implements _OlkTextBox, OlkTextBoxEvents_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 _OlkTextBox. For information about the event members of the COM object, see OlkTextBoxEvents_Event.
Before you use this control for the first time in the forms designer, add the Microsoft Outlook Text 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 text box control that has been bound to the Organizer field. This control supports Microsoft Windows themes.
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 _OlkTextBox) |
| 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 _OlkTextBox) |
| 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 _OlkTextBox) |
| BackColor |
Returns or sets a UInteger (uint in C#) value that indicates the background color of the control. Read/write. (Inherited from _OlkTextBox) |
| BorderStyle |
Returns or sets an OlBorderStyle constant that defines the style of the border around the control. Read/write. (Inherited from _OlkTextBox) |
| 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 _OlkTextBox) |
| Enabled |
Returns or sets a Boolean (bool in C#) that indicates if the control is allowed to function. Read/write. (Inherited from _OlkTextBox) |
| EnableRichText |
This object, member, or enumeration is deprecated and is not intended to be used in your code. (Inherited from _OlkTextBox) |
| EnterFieldBehavior |
Returns or sets an OlEnterFieldBehavior constant that specifies the selection behavior when entering the control. Read/write. (Inherited from _OlkTextBox) |
| EnterKeyBehavior |
Returns or sets a Boolean (bool in C#) that defines the way the ENTER key behaves in the control. Read/write. (Inherited from _OlkTextBox) |
| Font |
Returns an StdFont that represents the font used to render the text inside the control. Read-only. (Inherited from _OlkTextBox) |
| ForeColor |
Returns or sets a UInteger (uint in C#) value that indicates the foreground color of the control. Read/write. (Inherited from _OlkTextBox) |
| 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 _OlkTextBox) |
| IntegralHeight |
Returns or sets a Boolean (bool in C#) that specifies whether this control displays full lines of text. Read/write. (Inherited from _OlkTextBox) |
| 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 _OlkTextBox) |
| 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 _OlkTextBox) |
| MouseIcon |
Returns or sets a StdPicture that represent the custom picture to the mouse cursor for this control. Read/write. (Inherited from _OlkTextBox) |
| 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 _OlkTextBox) |
| MultiLine |
Returns or sets a Boolean (bool in C#) that specifies whether a control can accept and display multiple lines of text. Read/write. (Inherited from _OlkTextBox) |
| PasswordChar |
Returns or sets a String (string in C#) that specifies a placeholder character that is to be displayed repetitively as a string instead of the actual characters entered in the text box. Read/write. (Inherited from _OlkTextBox) |
| Scrollbars |
Returns or sets an OlScrollBars constant that specifies whether the control has a vertical scroll bar, horizontal scroll bar, or both. Read/write. (Inherited from _OlkTextBox) |
| 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 _OlkTextBox) |
| SelLength |
Returns or sets an Integer (int in C#) value that specifies the number of characters in the current selection. Read/write. (Inherited from _OlkTextBox) |
| 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 _OlkTextBox) |
| SelText |
Returns a String (string in C#) that represents the currently selected portion of the value of the text box. Read-only. (Inherited from _OlkTextBox) |
| TabKeyBehavior |
Returns or sets a Boolean (bool in C#) that specifies how the control responds to the TAB key. Read/write. (Inherited from _OlkTextBox) |
| Text |
Returns or sets a String (string in C#) that is the text displayed in the control. Read/write. (Inherited from _OlkTextBox) |
| TextAlign |
Returns or sets an OlTextAlign constant that specifies how text is aligned in the control. Read/write. (Inherited from _OlkTextBox) |
| Value |
Returns or sets an Object that represents the content of the control. Read/write. (Inherited from _OlkTextBox) |
| 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 _OlkTextBox) |
Methods
| Clear() |
Removes the text in the text box. (Inherited from _OlkTextBox) |
| Copy() |
Copies the contents of the control to the clipboard. (Inherited from _OlkTextBox) |
| Cut() |
Removes the contents of the control and copies the contents to the clipboard. (Inherited from _OlkTextBox) |
| Paste() |
Pastes the contents of the clipboard in the control. (Inherited from _OlkTextBox) |
Events
| AfterUpdate |
Occurs after the data in the control has been changed through the user interface. (Inherited from OlkTextBoxEvents_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 OlkTextBoxEvents_Event) |
| Change |
Occurs when the Value property changes. (Inherited from OlkTextBoxEvents_Event) |
| Click |
Occurs when the user clicks inside the control. (Inherited from OlkTextBoxEvents_Event) |
| DoubleClick |
Occurs when the user double-clicks inside the control. (Inherited from OlkTextBoxEvents_Event) |
| Enter |
Occurs when the control receives focus, immediately after the previous control's Exit event. (Inherited from OlkTextBoxEvents_Event) |
| Exit |
Occurs just after the focus passes from this control to another control on the same form. (Inherited from OlkTextBoxEvents_Event) |
| KeyDown |
Occurs when a user presses a key. (Inherited from OlkTextBoxEvents_Event) |
| KeyPress |
Occurs when the user presses an ANSI key. (Inherited from OlkTextBoxEvents_Event) |
| KeyUp |
Occurs when the user releases a key. (Inherited from OlkTextBoxEvents_Event) |
| MouseDown |
Occurs when the user presses a mouse button on the control. (Inherited from OlkTextBoxEvents_Event) |
| MouseMove |
Occurs after a mouse movement has been registered over the control. (Inherited from OlkTextBoxEvents_Event) |
| MouseUp |
Occurs after the user releases a mouse button that has been pressed on the control. (Inherited from OlkTextBoxEvents_Event) |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for