Avalonia API Reference
Text
Represents a control that can be used to display or edit unformatted text.
Definition
Namespace: Avalonia.Controls
Assembly: Avalonia.Controls (in Avalonia.Controls.dll) Version: 11.3.999
Assembly: Avalonia.Controls (in Avalonia.Controls.dll) Version: 11.3.999
C#
[TemplatePartAttribute("PART_TextPresenter", typeof(TextPresenter), IsRequired = true)]
[TemplatePartAttribute("PART_ScrollViewer", typeof(ScrollViewer))]
[PseudoClassesAttribute(new string[] { ... })]
public class TextBox : TemplatedControlVB
<TemplatePartAttribute("PART_TextPresenter", GetType(TextPresenter), IsRequired := true)>
<TemplatePartAttribute("PART_ScrollViewer", GetType(ScrollViewer))>
<PseudoClassesAttribute(New String() { ... })>
Public Class TextBox
Inherits TemplatedControlF#
[<TemplatePartAttribute("PART_TextPresenter", typeof(TextPresenter), IsRequired = true)>]
[<TemplatePartAttribute("PART_ScrollViewer", typeof(ScrollViewer))>]
[<PseudoClassesAttribute(new string[] { ... })>]
type TextBox =
class
inherit TemplatedControl
end- Inheritance
- Object AvaloniaObject Animatable StyledElement Visual Layoutable Interactive InputElement Control TemplatedControl TextBox
- Derived
Constructors
| TextBox | Initializes a new instance of the TextBox class |
Properties
| AcceptsReturn | Gets or sets a value that determines whether the TextBox allows and displays newline or return characters |
| AcceptsTab | Gets or sets a value that determins whether the TextBox allows and displays tabs |
| ActualThemeVariant | (Inherited from StyledElement) |
| Background |
Gets or sets the brush used to draw the control's background.
(Inherited from TemplatedControl) |
| BackgroundSizing |
Gets or sets how the control's background is drawn relative to the control's border.
(Inherited from TemplatedControl) |
| BorderBrush |
Gets or sets the brush used to draw the control's border.
(Inherited from TemplatedControl) |
| BorderThickness |
Gets or sets the thickness of the control's border.
(Inherited from TemplatedControl) |
| Bounds | (Inherited from Visual) |
| BypassFlowDirectionPolicies | (Inherited from Visual) |
| CanCopy | Property for determining if the Copy command can be executed. |
| CanCut | Property for determining if the Cut command can be executed. |
| CanPaste | Property for determining if the Paste command can be executed. |
| CanRedo | Gets a value that indicates whether the redo stack has an action that can be redone |
| CanUndo | Gets a value that indicates whether the undo stack has an action that can be undone |
| CaretBlinkInterval | Gets or sets the caret blink rate |
| CaretBrush | Gets or sets a brush that is used for the text caret |
| CaretIndex | Gets or sets the index of the text caret |
| Classes | (Inherited from StyledElement) |
| ClearSelectionOnLostFocus | Gets or sets a value that determines whether the TextBox clears its selection after it loses focus. |
| Clip | (Inherited from Visual) |
| ClipToBounds | (Inherited from Visual) |
| ContextFlyout |
Gets or sets a context flyout to the control
(Inherited from Control) |
| ContextMenu |
Gets or sets a context menu to the control.
(Inherited from Control) |
| CopyGesture | Gets a platform-specific KeyGesture for the Copy action |
| CornerRadius |
Gets or sets the radius of the border rounded corners.
(Inherited from TemplatedControl) |
| Cursor | (Inherited from InputElement) |
| CutGesture | Gets a platform-specific KeyGesture for the Cut action |
| DataContext | (Inherited from StyledElement) |
| DataTemplates |
Gets or sets the data templates for the control.
(Inherited from Control) |
| DesiredSize | (Inherited from Layoutable) |
| Effect | (Inherited from Visual) |
| FlowDirection | (Inherited from Visual) |
| Focusable | (Inherited from InputElement) |
| FocusAdorner |
Gets or sets the control's focus adorner.
(Inherited from Control) |
| FontFamily |
Gets or sets the font family used to draw the control's text.
(Inherited from TemplatedControl) |
| FontFeatures |
Gets or sets the font features turned on/off.
(Inherited from TemplatedControl) |
| FontSize |
Gets or sets the size of the control's text in points.
(Inherited from TemplatedControl) |
| FontStretch |
Gets or sets the font stretch used to draw the control's text.
(Inherited from TemplatedControl) |
| FontStyle |
Gets or sets the font style used to draw the control's text.
(Inherited from TemplatedControl) |
| FontWeight |
Gets or sets the font weight used to draw the control's text.
(Inherited from TemplatedControl) |
| Foreground |
Gets or sets the brush used to draw the control's text and other foreground elements.
(Inherited from TemplatedControl) |
| GestureRecognizers | (Inherited from InputElement) |
| HasMirrorTransform | (Inherited from Visual) |
| Height | (Inherited from Layoutable) |
| HorizontalAlignment | (Inherited from Layoutable) |
| HorizontalContentAlignment | Gets or sets the horizontal alignment of the content within the control. |
| InheritanceParent | (Inherited from AvaloniaObject) |
| InnerLeftContent | Gets or sets custom content that is positioned on the left side of the text layout box |
| InnerRightContent | Gets or sets custom content that is positioned on the right side of the text layout box |
| IsArrangeValid | (Inherited from Layoutable) |
| IsEffectivelyEnabled | (Inherited from InputElement) |
| IsEffectivelyVisible | (Inherited from Visual) |
| IsEnabled | (Inherited from InputElement) |
| IsEnabledCore | (Inherited from InputElement) |
| IsFocused | (Inherited from InputElement) |
| IsHitTestVisible | (Inherited from InputElement) |
| IsInactiveSelectionHighlightEnabled | Gets or sets a value that determines whether the TextBox shows a selection highlight when it is not focused. |
| IsInitialized | (Inherited from StyledElement) |
| IsKeyboardFocusWithin | (Inherited from InputElement) |
| IsLoaded |
Gets a value indicating whether the control is fully constructed in the visual tree
and both layout and render are complete.
(Inherited from Control) |
| IsMeasureValid | (Inherited from Layoutable) |
| IsPointerOver | (Inherited from InputElement) |
| IsReadOnly | Gets or sets a value whether this TextBox is read-only |
| IsTabStop | (Inherited from InputElement) |
| IsUndoEnabled | Property for determining whether undo/redo is enabled |
| IsVisible | (Inherited from Visual) |
| Item | (Inherited from AvaloniaObject) |
| Item | (Inherited from AvaloniaObject) |
| KeyBindings | (Inherited from InputElement) |
| LetterSpacing | Gets or sets the spacing between characters |
| LineHeight | Gets or sets the line height. |
| LogicalChildren | (Inherited from StyledElement) |
| Margin | (Inherited from Layoutable) |
| MaxHeight | (Inherited from Layoutable) |
| MaxLength | Gets or sets the maximum number of characters that the TextBox can accept. This constraint only applies for manually entered (user-inputted) text. |
| MaxLines | Gets or sets the maximum number of visible lines to size to. |
| MaxWidth | (Inherited from Layoutable) |
| MinHeight | (Inherited from Layoutable) |
| MinLines | Gets or sets the minimum number of visible lines to size to. |
| MinWidth | (Inherited from Layoutable) |
| Name | (Inherited from StyledElement) |
| NewLine | Gets or sets which characters are inserted when Enter is pressed. Default: NewLine |
| Opacity | (Inherited from Visual) |
| OpacityMask | (Inherited from Visual) |
| Padding |
Gets or sets the padding placed between the border of the control and its content.
(Inherited from TemplatedControl) |
| Parent | (Inherited from StyledElement) |
| PasswordChar | Gets or sets the Char that should be used for password masking |
| PasteGesture | Gets a platform-specific KeyGesture for the Paste action |
| PseudoClasses | (Inherited from StyledElement) |
| RenderTransform | (Inherited from Visual) |
| RenderTransformOrigin | (Inherited from Visual) |
| Resources | (Inherited from StyledElement) |
| RevealPassword | Gets or sets whether text masked by PasswordChar should be revealed |
| SelectedText | Gets or sets the text selected in the TextBox |
| SelectionBrush | Gets or sets a brush that is used to highlight selected text |
| SelectionEnd | Gets or sets the end position of the text selected in the TextBox |
| SelectionForegroundBrush | Gets or sets a brush that is used for the foreground of selected text |
| SelectionStart | Gets or sets the starting position of the text selected in the TextBox |
| StyleKey | (Inherited from StyledElement) |
| StyleKeyOverride | (Inherited from StyledElement) |
| Styles | (Inherited from StyledElement) |
| TabIndex | (Inherited from InputElement) |
| Tag |
Gets or sets a user-defined object attached to the control.
(Inherited from Control) |
| Template |
Gets or sets the template that defines the control's appearance.
(Inherited from TemplatedControl) |
| TemplatedParent | (Inherited from StyledElement) |
| Text | Gets or sets the Text content of the TextBox |
| TextAlignment | Gets or sets the TextAlignment of the TextBox |
| TextWrapping | Gets or sets the TextWrapping of the TextBox |
| Theme | (Inherited from StyledElement) |
| Transitions | (Inherited from Animatable) |
| UndoLimit | Gets or sets the maximum number of items that can reside in the Undo stack |
| UseFloatingWatermark | Gets or sets a value indicating whether the Watermark will still be shown above the Text even after a text value is set. |
| UseLayoutRounding | (Inherited from Layoutable) |
| VerticalAlignment | (Inherited from Layoutable) |
| VerticalContentAlignment | Gets or sets the vertical alignment of the content within the control. |
| VisualChildren | (Inherited from Visual) |
| VisualRoot | (Inherited from Visual) |
| Watermark | Gets or sets the placeholder or descriptive text that is displayed even if the Text property is not yet set. |
| Width | (Inherited from Layoutable) |
| ZIndex | (Inherited from Visual) |
Methods
| AddHandler(RoutedEvent, Delegate, RoutingStrategies, Boolean) | (Inherited from Interactive) |
| AddHandler``1(RoutedEventUMP, EventHandlerUMP, RoutingStrategies, Boolean) | (Inherited from Interactive) |
| ApplyStyling | (Inherited from StyledElement) |
| ApplyTemplate | (Inherited from TemplatedControl) |
| Arrange(Rect) | (Inherited from Layoutable) |
| ArrangeCore(Rect) | (Inherited from Layoutable) |
| ArrangeOverride(Size) | (Inherited from Layoutable) |
| BeginInit | (Inherited from StyledElement) |
| Bind(AvaloniaProperty, IBinding) | (Inherited from AvaloniaObject) |
| Bind(AvaloniaProperty, IObservableObject, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableUMP) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableBindingValueUMP) | (Inherited from AvaloniaObject) |
| Bind``1(DirectPropertyBaseUMP, IObservableObject) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableUMP, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableBindingValueUMP, BindingPriority) | (Inherited from AvaloniaObject) |
| Bind``1(StyledPropertyUMP, IObservableObject, BindingPriority) | (Inherited from AvaloniaObject) |
| BuildEventRoute(RoutedEvent) | (Inherited from Interactive) |
| CheckAccess | (Inherited from AvaloniaObject) |
| Clear | Clears the text in the TextBox |
| ClearSelection | Clears the current selection, maintaining the CaretIndex |
| ClearValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| ClearValue``1(AvaloniaPropertyUMP) | (Inherited from AvaloniaObject) |
| ClearValue``1(DirectPropertyBaseUMP) | (Inherited from AvaloniaObject) |
| ClearValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| CoerceText(String) | Coerces the current text. |
| CoerceValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| Copy | Copies the current text onto the clipboard |
| Cut | Cuts the current text onto the clipboard |
| EndInit | (Inherited from StyledElement) |
| Equals(Object) | (Inherited from AvaloniaObject) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Focus(NavigationMethod, KeyModifiers) | (Inherited from InputElement) |
| GetBaseValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| GetHashCode | (Inherited from AvaloniaObject) |
| GetTemplateFocusTarget |
Gets the element that receives the focus adorner.
(Inherited from TemplatedControl) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| GetValue``1(DirectPropertyBaseUMP) | (Inherited from AvaloniaObject) |
| GetValue``1(StyledPropertyUMP) | (Inherited from AvaloniaObject) |
| InitializeIfNeeded | (Inherited from StyledElement) |
| InvalidateArrange | (Inherited from Layoutable) |
| InvalidateMeasure | (Inherited from Layoutable) |
| InvalidateMirrorTransform | (Inherited from Visual) |
| InvalidateVisual | (Inherited from Visual) |
| IsAnimating(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| IsSet(AvaloniaProperty) | (Inherited from AvaloniaObject) |
| LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs) | (Inherited from Visual) |
| Measure(Size) | (Inherited from Layoutable) |
| MeasureCore(Size) | (Inherited from Layoutable) |
| MeasureOverride(Size) | (Overrides Layoutable.MeasureOverride(Size)) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnAccessKey(RoutedEventArgs) | (Inherited from InputElement) |
| OnApplyTemplate(TemplateAppliedEventArgs) | (Overrides TemplatedControlOnApplyTemplate(TemplateAppliedEventArgs)) |
| OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) | (Inherited from TemplatedControl) |
| OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) | (Overrides Visual.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)) |
| OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) | (Inherited from Control) |
| OnCreateAutomationPeer | (Overrides ControlOnCreateAutomationPeer) |
| OnDataContextBeginUpdate | (Inherited from StyledElement) |
| OnDataContextChanged(EventArgs) | (Inherited from StyledElement) |
| OnDataContextEndUpdate | (Inherited from StyledElement) |
| OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) | (Inherited from TemplatedControl) |
| OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) | (Overrides Visual.OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)) |
| OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs) | (Inherited from Control) |
| OnGotFocus(GotFocusEventArgs) | (Overrides ControlOnGotFocus(GotFocusEventArgs)) |
| OnInitialized | (Inherited from StyledElement) |
| OnKeyDown(KeyEventArgs) | (Overrides InputElement.OnKeyDown(KeyEventArgs)) |
| OnKeyUp(KeyEventArgs) | (Inherited from Control) |
| OnLoaded(RoutedEventArgs) |
Invoked just before the Loaded event.
(Inherited from Control) |
| OnLostFocus(RoutedEventArgs) | (Overrides ControlOnLostFocus(RoutedEventArgs)) |
| OnMeasureInvalidated | (Inherited from Layoutable) |
| OnPointerCaptureLost(PointerCaptureLostEventArgs) | (Inherited from InputElement) |
| OnPointerEntered(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerExited(PointerEventArgs) | (Inherited from InputElement) |
| OnPointerMoved(PointerEventArgs) | (Overrides InputElement.OnPointerMoved(PointerEventArgs)) |
| OnPointerPressed(PointerPressedEventArgs) | (Overrides InputElement.OnPointerPressed(PointerPressedEventArgs)) |
| OnPointerReleased(PointerReleasedEventArgs) | (Overrides ControlOnPointerReleased(PointerReleasedEventArgs)) |
| OnPointerWheelChanged(PointerWheelEventArgs) | (Inherited from InputElement) |
| OnPropertyChanged(AvaloniaPropertyChangedEventArgs) | (Overrides ControlOnPropertyChanged(AvaloniaPropertyChangedEventArgs)) |
| OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs) | (Inherited from Animatable) |
| OnSizeChanged(SizeChangedEventArgs) |
Invoked just before the SizeChanged event.
(Inherited from Control) |
| OnTemplateChanged(AvaloniaPropertyChangedEventArgs) |
Called when the Template property changes.
(Inherited from TemplatedControl) |
| OnTextInput(TextInputEventArgs) | (Overrides InputElement.OnTextInput(TextInputEventArgs)) |
| OnUnloaded(RoutedEventArgs) |
Invoked just before the Unloaded event.
(Inherited from Control) |
| OnVisualParentChanged(Visual, Visual) | (Inherited from Layoutable) |
| Paste | Pastes the current clipboard text content into the TextBox |
| RaiseEvent(RoutedEventArgs) | (Inherited from Interactive) |
| RaisePropertyChanged``1(DirectPropertyBaseUMP, UMP, UMP) | (Inherited from AvaloniaObject) |
| Redo | Reapplies the first item on the redo stack |
| RemoveHandler(RoutedEvent, Delegate) | (Inherited from Interactive) |
| RemoveHandler``1(RoutedEventUMP, EventHandlerUMP) | (Inherited from Interactive) |
| Render(DrawingContext) | (Inherited from Visual) |
| ScrollToLine(Int32) | Scroll the TextBox to the specified line index. |
| SelectAll | Select all text in the TextBox |
| SetAndRaise``1(DirectPropertyBaseUMP, UMP, UMP) | (Inherited from AvaloniaObject) |
| SetCurrentValue(AvaloniaProperty, Object) | (Inherited from AvaloniaObject) |
| SetCurrentValue``1(StyledPropertyUMP, UMP) | (Inherited from AvaloniaObject) |
| SetValue(AvaloniaProperty, Object, BindingPriority) | (Inherited from AvaloniaObject) |
| SetValue``1(DirectPropertyBaseUMP, UMP) | (Inherited from AvaloniaObject) |
| SetValue``1(StyledPropertyUMP, UMP, BindingPriority) | (Inherited from AvaloniaObject) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetResource(Object, ThemeVariant, Object) | (Inherited from StyledElement) |
| Undo | Undoes the first action in the undo stack |
| UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception) | (Overrides AvaloniaObject.UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception)) |
| UpdateIsEffectivelyEnabled | (Inherited from InputElement) |
| UpdateLayout | (Inherited from Layoutable) |
| VerifyAccess | (Inherited from AvaloniaObject) |
Events
| ActualThemeVariantChanged | (Inherited from StyledElement) |
| AttachedToLogicalTree | (Inherited from StyledElement) |
| AttachedToVisualTree | (Inherited from Visual) |
| ContextRequested |
Occurs when the user has completed a context input gesture, such as a right-click.
(Inherited from Control) |
| CopyingToClipboard | Raised when content is being copied to the clipboard |
| CuttingToClipboard | Raised when content is being cut to the clipboard |
| DataContextChanged | (Inherited from StyledElement) |
| DetachedFromLogicalTree | (Inherited from StyledElement) |
| DetachedFromVisualTree | (Inherited from Visual) |
| DoubleTapped | (Inherited from InputElement) |
| EffectiveViewportChanged | (Inherited from Layoutable) |
| GotFocus | (Inherited from InputElement) |
| Holding | (Inherited from InputElement) |
| Initialized | (Inherited from StyledElement) |
| KeyDown | (Inherited from InputElement) |
| KeyUp | (Inherited from InputElement) |
| LayoutUpdated | (Inherited from Layoutable) |
| Loaded |
Occurs when the control has been fully constructed in the visual tree and both
layout and render are complete.
(Inherited from Control) |
| LostFocus | (Inherited from InputElement) |
| PastingFromClipboard | Raised when content is being pasted from the clipboard |
| PointerCaptureLost | (Inherited from InputElement) |
| PointerEntered | (Inherited from InputElement) |
| PointerExited | (Inherited from InputElement) |
| PointerMoved | (Inherited from InputElement) |
| PointerPressed | (Inherited from InputElement) |
| PointerReleased | (Inherited from InputElement) |
| PointerWheelChanged | (Inherited from InputElement) |
| PropertyChanged | (Inherited from AvaloniaObject) |
| ResourcesChanged | (Inherited from StyledElement) |
| SizeChanged |
Occurs when the bounds (actual size) of the control have changed.
(Inherited from Control) |
| Tapped | (Inherited from InputElement) |
| TemplateApplied |
Raised when the control's template is applied.
(Inherited from TemplatedControl) |
| TextChanged | Occurs asynchronously after text changes and the new text is rendered. |
| TextChanging | Occurs synchronously when text starts to change but before it is rendered. |
| TextInput | (Inherited from InputElement) |
| TextInputMethodClientRequested | (Inherited from InputElement) |
| Unloaded |
Occurs when the control is removed from the visual tree.
(Inherited from Control) |
Fields
Extension Methods
| BringIntoView |
Tries to bring the control into view.
(Defined by ControlExtensions) |
| BringIntoView(Rect) |
Tries to bring the control into view.
(Defined by ControlExtensions) |
| FindControlT(String) |
Finds the named control in the scope of the specified control.
(Defined by ControlExtensions) |
| FindDataTemplate(Object, IDataTemplate) |
Find a data template that matches a piece of data.
(Defined by DataTemplateExtensions) |
| GetControlT(String) |
Finds the named control in the scope of the specified control and throws if not found.
(Defined by ControlExtensions) |
| GetTemplateChildren | (Defined by TemplateExtensions) |