New to Telerik UI for WinFormsStart a free 30-day trial

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
[DefaultBindingProperty("Text")]
public abstract class RadTextBoxBase : RadEditorControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadEditorControlRadTextBoxBase...

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Inherited Members RadEditorControl.OnParentChanged(EventArgs)RadEditorControl.GetPreferredSize(Size)RadEditorControl.GetRootElementDesiredSize(int, int, int, int)RadEditorControl.SetBoundsCore(int, int, int, int, BoundsSpecified)RadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Construct()RadControl.CreateBehavior()RadControl.CreateRootElement()RadControl.CreateChildItems(RadElement)RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyDown(KeyEventArgs)RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseDown(MouseEventArgs)RadControl.OnMouseUp(MouseEventArgs)RadControl.OnMouseEnter(EventArgs)RadControl.OnMouseLeave(EventArgs)RadControl.OnMouseMove(MouseEventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnBindingContextChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnRightToLeftChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.OnInvalidated(RadElement)RadControl.OnLoad(Size)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessFocusRequested(RadElement)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.IsInputKey(Keys)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(string)RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.ScaleControl(SizeF, BoundsSpecified)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.GetMonitorDpiScaleFactor(Control)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.EnableThemingRadControl.ThemeClassNameRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGesture...

Constructors

Represents RadTextBoxBase constructor

C#
public RadTextBoxBase()

Properties

Gets or sets a value indicating whether pressing ENTER in a multiline RadTextBox control creates a new line of text in the control or activates the default button for the form.

C#
public bool AcceptsReturn { get; set; }

Gets or sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order.

C#
public bool AcceptsTab { get; set; }
C#
[Browsable(true)]
public AutoCompleteStringCollection AutoCompleteCustomSource { get; set; }
C#
[Browsable(true)]
public AutoCompleteMode AutoCompleteMode { get; set; }
C#
[Browsable(true)]
[TypeConverter(typeof(TextBoxAutoCompleteSourceConverter))]
public AutoCompleteSource AutoCompleteSource { get; set; }

Gets or sets whether the edit control is auto-sized. Note that auto-size functionality does not work when MultiLine property is true.

C#
[Browsable(true)]
public override bool AutoSize { get; set; }

Overrides: RadControl.AutoSize

Gets value indicating whether undo is allowed.

C#
public bool CanUndo { get; }

Gets or sets a value indicating whether the RadTextBox control modifies the case of characters as they are typed.

C#
public CharacterCasing CharacterCasing { get; set; }
C#
protected override Size DefaultSize { get; }

Overrides: Control.DefaultSize

Gets or sets the font of the text displayed by the control.

C#
public override Font Font { get; set; }

Overrides: RadControl.Font

Gets or sets a value indicating whether the selected text remains highlighted even when the RadTextBox has lost the focus.

C#
public bool HideSelection { get; set; }

Gets or sets the lines of text in multiline configurations.

C#
public string[] Lines { get; set; }

Gets or sets the maximum number of characters allowed in the text box.

C#
public int MaxLength { get; set; }

Gets or sets a value indicating whether the RadTextBox control has been modified by the user since the control was created or since its contents were last set.

C#
public bool Modified { get; set; }

Gets or sets a value indicating whether this is a multiline TextBox control. When the value is true, the AutoSize property is automatically changed to false and the user needs to take care of the height of this control.

C#
public bool Multiline { get; set; }

Gets or sets the text that is displayed when the ComboBox contains a null reference.

C#
public string NullText { get; set; }

Gets or sets the character used to mask characters of a password in a single-line TextBox control.

C#
public char PasswordChar { get; set; }

Gets or sets a value indicating whether the contents of the TextBox control can be changed.

C#
public bool ReadOnly { get; set; }

Gets or sets which scroll bars should appear in a multiline TextBox control.

C#
public ScrollBars ScrollBars { get; set; }

Gets or sets a value indicating the currently selected text in the control.

C#
public string SelectedText { get; set; }

Gets or sets the number of characters selected in the text box.

C#
public int SelectionLength { get; set; }

Gets or sets the starting point of text selected in the text box.

C#
public int SelectionStart { get; set; }

Gets or sets a value indicating whether the defined shortcuts are enabled.

C#
public bool ShortcutsEnabled { get; set; }

Gets or sets a value indicating whether the null text will be shown when the control is focused and the text is empty.

C#
public bool ShowNullText { get; set; }
C#
public bool TabStop { get; set; }

Gets or sets the displayed text.

C#
public override string Text { get; set; }

Overrides: RadControl.Text

Gets or sets how text is aligned in a TextBox control.

C#
public virtual HorizontalAlignment TextAlign { get; set; }

Gets the length of the text in the control.

C#
public int TextLength { get; }

Gets or sets a value indicating whether a multiline text box control automatically wraps words to the beginning of the next line when necessary.

C#
public bool WordWrap { get; set; }

Methods

Appends text to the current text.

C#
public void AppendText(string text)
Parameters:textstring

Empties the TextBox.

C#
public void Clear()

Undo to the previous text value before clear invocation.

C#
public void ClearUndo()

Copies the text value to the clipboard.

C#
public void Copy()

Cuts the text value to the clipboard.

C#
public void Cut()

Deselects the text in the cotrol.

C#
public void DeselectAll()
C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

Overrides: RadControl.Dispose(bool)

Sets input focus to the control.

C#
public bool Focus()
Returns:

bool

true if the input focus request was successful; otherwise, false.

Retrieves the character that is closest to the specified location within the control.

C#
public char GetCharFromPosition(Point point)
Parameters:pointPointReturns:

char

Retrieves the index of the character nearest to the specified location.

C#
public int GetCharIndexFromPosition(Point point)
Parameters:pointPointReturns:

int

Retrieves the index of the first character of a given line.

C#
public int GetFirstCharIndexFromLine(int lineNumber)
Parameters:lineNumberintReturns:

int

Retrieves the index of the first character of the current line. This method is not supported by MaskedTextBox.

C#
public int GetFirstCharIndexOfCurrentLine()
Returns:

int

Retrieves the line number from the specified character position within the text of the control.

C#
public int GetLineFromCharIndex(int index)
Parameters:indexintReturns:

int

Retrieves the location within the control at the specified character index.

C#
public Point GetPositionFromCharIndex(int index)
Parameters:indexintReturns:

Point

Initializes textbox's children

C#
protected abstract void InitializeTextElement()

Raises the AcceptsTabChanged event.

C#
protected virtual void OnAcceptsTabChanged(EventArgs e)
Parameters:eEventArgs

Raises the HideSelectionChanged event.

C#
protected virtual void OnHideSelectionChanged(EventArgs e)
Parameters:eEventArgs
C#
protected override void OnLostFocus(EventArgs e)
Parameters:eEventArgs

Overrides: RadControl.OnLostFocus(EventArgs)

Raises the ModifiedChanged event.

C#
protected virtual void OnModifiedChanged(EventArgs e)
Parameters:eEventArgs

Raises the MultilineChanged event.

C#
protected virtual void OnMultilineChanged(EventArgs e)
Parameters:eEventArgs

Raises the ReadOnlyChanged event.

C#
protected virtual void OnReadOnlyChanged(EventArgs e)
Parameters:eEventArgs

Raises the TextAlignChanged event.

C#
protected virtual void OnTextAlignChanged(EventArgs e)
Parameters:eEventArgs

Raises the TextChanging event.

C#
protected virtual void OnTextChanging(TextChangingEventArgs e)
Parameters:eTextChangingEventArgs

Pastes the text value to the clipboard.

C#
public void Paste()

Pastes the string parameter to the clipboard.

C#
public void Paste(string text)
Parameters:textstring
C#
protected override void ProcessAutoSizeChanged(bool value)
Parameters:valuebool

Overrides: RadControl.ProcessAutoSizeChanged(bool)

Scrolls the contents of the control to the current caret position.

C#
public void ScrollToCaret()

Activates the control.

C#
public void Select()

Selects the text in the TextBox from the start position inclusive to the end position exclusive.

C#
public void Select(int start, int length)
Parameters:startintlengthint

Selects the text in the TextBox.

C#
public void SelectAll()

Undoes the last edit operation in the text box.

C#
public void Undo()
C#
protected virtual void UnwireHostEvents()
C#
protected virtual void WireHostEvents()
C#
protected override void WndProc(ref Message m)
Parameters:mMessage

Overrides: RadControl.WndProc(ref Message)

Events

Occurs when the value of the AcceptsTab property has changed.

C#
[Browsable(true)]
public event EventHandler AcceptsTabChanged

Occurs when the value of the HideSelection property changes.

C#
[Browsable(true)]
public event EventHandler HideSelectionChanged

Occurs when the value of the Modified property has changed.

C#
[Browsable(true)]
public event EventHandler ModifiedChanged

Occurs when the value of the Multiline property has changed.

C#
[Browsable(true)]
public event EventHandler MultilineChanged

Occurs when the ReadOnly property changes.

C#
[Browsable(true)]
public event EventHandler ReadOnlyChanged

Occurs when the value of the TextAlign property has changed.

C#
[Browsable(true)]
public event EventHandler TextAlignChanged

Occurs when text is being changed.

C#
[Browsable(true)]
public event TextChangingEventHandler TextChanging