TextBox

Table of Contents Definition Properties Methods Events

Definition

Namespace: My.Sys.Forms

TextBox - Displays information entered at design time by the user, or in code at run time.

Properties

Name	Description
Align	Returns/sets which control borders are docked to its parent control and determines how a control is resized with its parent (Windows, Linux).
Alignment
AllowDrop	Gets or sets a value indicating whether the control can accept data that the user drags onto it (Windows, Linux).
Anchor	Returns/sets the edges of the container to which a control is bound and determines how a control is resized with its parent (Windows, Linux).
BackColor	Returns/sets the background color used to display text and graphics in an object (Windows, Linux).
BorderStyle
Canvas	Canvas is all about drawing in a container (Windows, Linux).
CaretPos
CharCase
Constraints	Specifies the size constraints for the control (Windows, Linux).
ContextMenu	Returns/sets the PopupMenu associated with this control (Windows, Linux).
ControlIndex
Controls	Gets the collection of controls contained within the control (Windows, Linux).
Ctl3D
Cursor	Returns/sets the type of mouse pointer displayed when over part of an object (Windows, Linux).
Designer
DesignMode	Gets a value that indicates whether the Component is currently in design mode.
DoubleBuffered	Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker (Windows only)
Enabled	Returns/sets a value that determines whether an object can respond to user-generated events (Windows, Linux).
ExtraMargins	Returns/sets the extra space between controls.
Font	Returns a Font object (Windows, Linux).
ForeColor	Returns/sets the foreground color used to display text and graphics in an object (Windows, Linux).
Grouped	Returns/sets the value indicating the first control of a group of controls (Windows only).
Handle	Gets the window handle that the control is bound to.
Height	Returns/sets the height of an object.
HelpContext	Specifies the default Help file context ID for an object (Windows only).
HideSelection
Hint	Returns/sets the text displayed when the mouse is paused over the control (Windows, Linux).
ID	Gets or sets the programmatic identifier assigned to the control (Windows only).
IsChild	Determines whether a window is a child window or descendant window of a specified parent window (Windows only).
LayoutHandle
Left	Returns/sets the distance between the internal left edge of an object and the left edge of its container.
LeftMargin
Lines
Location	Returns/sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
Margins	Returns/sets the space between controls.
MaskChar
Masked
MaxLength
Modified
Multiline
Name	Returns the name used in code to identify an object.
NumbersOnly
OEMConvert
Parent	Returns/sets the parent container of the control (Windows, Linux).
ReadOnly
RightMargin
ScrollBars
SelEnd
SelLength
SelStart
SelText
ShowHint	Returns/sets the value indicating show hint (Windows, Linux).
Size	Returns/sets the height and width of the control.
SubClass	Returs/sets a value indicating type is subclass or not (Windows only).
TabIndex
TabStop
Tag	Stores any extra data needed for your program.
Text
Top	Returns/sets the distance between the internal top edge of an object and the top edge of its container.
TopLine
Visible	Returns/sets a value that determines whether an object is visible or hidden (Windows, Linux).
WantReturn
WantTab
Width	Returns/sets the width of an object.
WordWraps

Methods

Name	Description
Add	Adds the specified control to the control collection (Windows, Linux).
AddLine
AddRange	Adds the specified controls range to the control collection (Windows, Linux).
BringToFront	Brings the control to the front of the z-order (Windows only).
CanUndo
ClassAncestor	Returns ancestor class of control.
ClassName
Clear
ClearUndo
ClientHeight	Returns/sets the height of the client area of the control (Windows, Linux).
ClientToScreen	Converts the client-area coordinates of a specified point to screen coordinates (Windows only).
ClientWidth	Returns/sets the width of the client area of the control (Windows, Linux).
ControlByName	Retrieves the Control object from Control name in the collection (Windows, Linux).
ControlCount	Gets the number of controls in the Control collection (Windows, Linux).
CopyToClipboard
CreateWnd	Creates the window (Windows only)
CutToClipboard
Focused	Returns a value indicating whether the control has input focus (Windows, Linux).
FreeWnd	Destroys the specified window handle (Windows, Linux).
FullTypeName	Function to get any typename in the inheritance up hierarchy of the type of an instance (address: 'po') compatible with the built-in 'Object' ('baseIndex = 0' to get the typename of the instance) ('baseIndex = -1' to get the base.typename of the instance, or "" if not existing) ('baseIndex = -2' to get the base.base.typename of the instance, or "" if not existing)
GetBounds	Gets the bounds of the control to the specified location and size.
GetCharIndexFromLine
GetForm	Retrieves the form that the control is on (Windows, Linux).
GetLineFromCharIndex
GetLineLength
GetSel
GetTextLength
GetTopLevel	Determines if the control is a top-level control.
Hide	Conceals the control from the user (Windows, Linux).
IndexOf	Retrieves the index of a specified Control object in the collection (Windows, Linux).
InputFilter
InsertLine
Invalidate	Invalidates the entire surface of the control and causes the control to be redrawn (Windows only).
IsEmpty
LinesCount
LoadFromFile
PasteFromClipboard
ProcessMessage
ReadProperty
RecreateWnd	Recreates the window (Windows only)
Remove	Removes the specified control from the control collection (Windows, Linux).
RemoveLine
Repaint	Forces the control to invalidate its client area and immediately redraw itself and any child controls (Windows, Linux).
RequestAlign	Instructs the parent of a control to reposition the control, enforcing its Align property (Windows, Linux).
SaveToFile
ScreenToClient	Converts the screen coordinates of a specified point on the screen to client coordinates (Windows only).
ScrollToCaret
SelectAll	Declare Sub Delete
SelectNextControl	Activates the next control (Windows only).
SendToBack	Sends the control to the back of the z-order (Windows only).
SetBounds	Sets the bounds of the control to the specified location and size.
SetFocus	Moves the focus to the specified form or the specified control on the active form (Windows, Linux).
SetMargins	Sets the left, top, right, bottom margins for a container control (Windows, Linux).
SetSel
Show	Displays the control to the user (Windows, Linux).
TopLevelControl	Returns the parent control that is not parented by another Forms control. Typically, this is the outermost Form that the control is contained in (Windows, Linux).
ToString	Returns a string that represents the current object.
Undo
Update	Causes the control to redraw the invalidated regions within its client area (Windows, Linux).
UpdateLock	Disables drawing in the specified window (Windows only).
UpdateUnLock	Enables drawing in the specified window (Windows only).
WriteProperty

Events

Name	Description
OnActivate
OnChange
OnClick	Occurs when the control is clicked (Windows, Linux, Android, Web).
OnCopy
OnCreate	Occurs when the control is created (Windows, Linux).
OnCut	OnHScroll As Sub(ByRef Designer As My.Sys.Object, ByRef Sender As TextBox) OnVScroll As Sub(ByRef Designer As My.Sys.Object, ByRef Sender As TextBox)
OnDblClick	Occurs when the control is double-clicked (Windows, Linux).
OnDestroy	Occurs when the control's handle is in the process of being destroyed (Windows, Linux).
OnDropFile	Occurs when the user drops a file on the window of an application that has registered itself as a recipient of dropped files (Windows, Linux).
OnGotFocus
OnKeyDown	Occurs when a key is pressed while the control has focus (Windows, Linux).
OnKeyPress	Occurs when a character. space or backspace key is pressed while the control has focus (Windows, Linux).
OnKeyUp	Occurs when a key is released while the control has focus (Windows, Linux).
OnLostFocus
OnMessage	Occurs when the window receives a message (Windows, Linux).
OnMouseDown	Occurs when the mouse pointer is over the control and a mouse button is pressed (Windows, Linux).
OnMouseEnter	Occurs when the mouse pointer enters the control (Windows, Linux).
OnMouseHover	Occurs when the mouse pointer rests on the control (Windows only).
OnMouseLeave	Occurs when the mouse pointer leaves the control (Windows, Linux).
OnMouseMove	Occurs when the mouse pointer is moved over the control (Windows, Linux).
OnMouseUp	Occurs when the mouse pointer is over the control and a mouse button is released (Windows, Linux).
OnMouseWheel	Occurs when the mouse wheel moves while the control has focus (Windows, Linux).
OnMove	Occurs when the control is moved (Windows, Linux).
OnPaint	Occurs when the control is redrawn (Windows, Linux).
OnPaste
OnResize	Occurs when the control is resized (Windows, Linux).
OnScroll	Occurs when the scroll box has been moved by either a mouse or keyboard action (Windows only).
OnUpdate	Raises the Update event.

See also

• My.Sys.Forms