OlkTextBox Members (Outlook)

GitHub-Mark-64px

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

A control that supports a single or multiple-line data entry.

Events

Name

Description

AfterUpdate

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

BeforeUpdate

Occurs when the data in the control is changed through the user interface and is about to be saved to the item.

Change

Occurs when the Value property changes.

Click

Occurs when the user clicks inside the control.

DoubleClick

Occurs when the user double-clicks inside the control.

Enter

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

Exit

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

KeyDown

Occurs when a user presses a key.

KeyPress

Occurs when the user presses an ANSI key.

KeyUp

Occurs when the user releases a key.

MouseDown

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

MouseMove

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

MouseUp

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

Methods

Name

Description

Clear

Removes the text in the text box.

Copy

Copies the contents of the control to the clipboard.

Cut

Removes the contents of the control and copies the contents to the clipboard.

Paste

Pastes the contents of the clipboard in the control.

Properties

Name

Description

AutoSize

Returns or sets a Boolean that automatically sizes the control to display the entire contents. Read/write.

AutoTab

Returns or sets a Boolean that specifies if a tab is inserted automatically when the control has been filled to the maximum length specified. Read/write.

AutoWordSelect

Returns or sets a Boolean that specifies whether a word or a character is the basic unit used to extend a selection. Read/write.

BackColor

Returns or sets a Long that indicates the background color of the control. Read/write.

BorderStyle

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

DragBehavior

Returns or sets an OlDragBehavior Enumeration constant that indicates whether the system enables the drag-and-drop feature for this control. Read/write.

Enabled

Returns or sets a Boolean that indicates if the control is allowed to function. Read/write.

EnterFieldBehavior

Returns or sets an olEnterFieldBehavior constant that specifies the selection behavior when entering the control. Read/write.

EnterKeyBehavior

Returns or sets a Boolean that defines the way the ENTER key behaves in the control. Read/write.

Font

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

ForeColor

Returns or sets a Long that indicates the foreground color of the control. Read/write.

HideSelection

Returns or sets a Boolean that specifies if a selection is displayed or hidden for the control when the control loses focus. Read/write.

IntegralHeight

Returns or sets a Boolean that specifies whether this control displays full lines of text. Read/write.

Locked

Returns or sets a Boolean that specifies whether or not the control is locked from being changed. Read/write.

MaxLength

Returns or sets a Long that specifies the maximum number of characters for the Value of this control. Read/write.

MouseIcon

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

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.

MultiLine

Returns or sets a Boolean that specifies whether a control can accept and display multiple lines of text. Read/write.

PasswordChar

Returns or sets a String 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.

Scrollbars

Returns or sets an olScrollBars constant that specifies whether the control has a vertical scroll bar, horizontal scroll bar, or both. Read/write.

SelectionMargin

Returns or sets a Boolean that specifies whether the user can select a line of text by clicking in the region to the left of the text. Read/write.

SelLength

Returns or sets a Long that specifies the number of characters in the current selection. Read/write.

SelStart

Returns or sets a Long that specifies either the starting point of the selected text or the insertion point if no text has been selected. Read/write.

SelText

Returns a String that represents the currently selected portion of the value of the text box. Read-only.

TabKeyBehavior

Returns or sets a Boolean that specifies how the control responds to the TAB key. Read/write.

Text

Returns or sets a String that is the text displayed in the control. Read/write.

TextAlign

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

Value

Returns or sets a Variant that represents the content of the control. Read/write.

WordWrap

Returns or sets a Boolean that specifies whether the contents of a control automatically wrap at the end of a line. Read/write.