TextBox Class
Definition
Represents a control that can be used to display or edit unformatted text.
public class TextBox
Constructors
| Name | Description |
|---|---|
| TextBox | No summary available. |
TextBox Constructor
public TextBox()
Methods
| Name | Description |
|---|---|
| Clear | Clears the text in the TextBox |
| ClearSelection | Clears the current selection, maintaining the Avalonia.Controls.TextBox.CaretIndex |
| Copy | Copies the current text onto the clipboard |
| Cut | Cuts the current text onto the clipboard |
| GetLineCount | Get the number of lines in the TextBox. |
| Paste | Pastes the current clipboard text content into the TextBox |
| Redo | Reapplies the first item on the redo stack |
| ScrollToLine | Scroll the Avalonia.Controls.TextBox to the specified line index. |
| SelectAll | Select all text in the TextBox |
| Undo | Undoes the first action in the undo stack |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from TemplatedControl. |
| GetIsTemplateFocusTarget | Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| SetIsTemplateFocusTarget | Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | Inherited from StyledElement. |
| EndInit | Inherited from StyledElement. |
| TryGetResource | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Clear Method
Clears the text in the TextBox
public void Clear()
ClearSelection Method
Clears the current selection, maintaining the Avalonia.Controls.TextBox.CaretIndex
public void ClearSelection()
Copy Method
Copies the current text onto the clipboard
public void Copy()
Cut Method
Cuts the current text onto the clipboard
public void Cut()
GetLineCount Method
Get the number of lines in the TextBox.
public int GetLineCount()
Returns
int
Value
number of lines in the TextBox, or -1 if no layout information is available
Remarks
If Wrap == true, changing the width of the TextBox may change this value. The value returned is the number of lines in the entire TextBox, regardless of how many are currently in view.
Paste Method
Pastes the current clipboard text content into the TextBox
public void Paste()
Redo Method
Reapplies the first item on the redo stack
public void Redo()
ScrollToLine Method
Scroll the Avalonia.Controls.TextBox to the specified line index.
public void ScrollToLine(int lineIndex)
Parameters
lineIndex int
The line index to scroll to.
Exceptions
SelectAll Method
Select all text in the TextBox
public void SelectAll()
Undo Method
Undoes the first action in the undo stack
public void Undo()
Properties
| Name | Description |
|---|---|
| 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 determines whether the TextBox allows and displays tabs |
| 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 |
| ClearSelectionOnLostFocus | Gets or sets a value that determines whether the TextBox clears its selection after it loses focus. |
| CopyGesture | Gets a platform-specific Avalonia.Input.KeyGesture for the Copy action |
| CutGesture | Gets a platform-specific Avalonia.Input.KeyGesture for the Cut action |
| HorizontalContentAlignment | Gets or sets the horizontal alignment of the content within the control. |
| 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 |
| IsInactiveSelectionHighlightEnabled | Gets or sets a value that determines whether the TextBox shows a selection highlight when it is not focused. |
| IsReadOnly | Gets or sets a value whether this TextBox is read-only |
| IsUndoEnabled | Property for determining whether undo/redo is enabled |
| LineHeight | Gets or sets the line height. |
| MaxLength | Gets or sets the maximum number of characters that the Avalonia.Controls.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. |
| MinLines | Gets or sets the minimum number of visible lines to size to. |
| NewLine | Gets or sets which characters are inserted when Enter is pressed. Default: Environment.NewLine |
| PasswordChar | Gets or sets the char that should be used for password masking |
| PasteGesture | Gets a platform-specific Avalonia.Input.KeyGesture for the Paste action |
| PlaceholderForeground | Gets or sets the brush used for the foreground color of the placeholder text. |
| PlaceholderText | Gets or sets the placeholder or descriptive text that is displayed even if the Avalonia.Controls.TextBox.Text property is not yet set. |
| RevealPassword | Gets or sets whether text masked by Avalonia.Controls.TextBox.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 |
| Text | Gets or sets the Text content of the TextBox |
| TextAlignment | Gets or sets the Avalonia.Media.TextAlignment of the TextBox |
| TextWrapping | Gets or sets the Avalonia.Media.TextWrapping of the TextBox |
| UndoLimit | Gets or sets the maximum number of items that can reside in the Undo stack |
| UseFloatingPlaceholder | Gets or sets a value indicating whether the Avalonia.Controls.TextBox.PlaceholderText will still be shown above the Avalonia.Controls.TextBox.Text even after a text value is set. |
| UseFloatingWatermark | Gets or sets a value indicating whether the Avalonia.Controls.TextBox.PlaceholderText will still be shown above the Avalonia.Controls.TextBox.Text even after a text value is set. |
| VerticalContentAlignment | Gets or sets the vertical alignment of the content within the control. |
| Watermark | Gets or sets the placeholder or descriptive text that is displayed even if the Avalonia.Controls.TextBox.Text property is not yet set. |
| WatermarkForeground | Gets or sets the brush used for the foreground color of the placeholder text. |
| 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. |
| CornerRadius | Gets or sets the radius of the border rounded corners. Inherited from TemplatedControl. |
| 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. |
| LetterSpacing | Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl. |
| Padding | Gets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl. |
| Template | Gets or sets the template that defines the control's appearance. Inherited from TemplatedControl. |
| 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. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| 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. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| GestureRecognizers | Inherited from InputElement. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement. |
| IsFocused | Gets a value indicating whether the control is focused. Inherited from InputElement. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| KeyBindings | Inherited from InputElement. |
| TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| Height | Gets or sets the height of the element. Inherited from Layoutable. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| MaxHeight | Gets or sets the maximum height of the element. Inherited from Layoutable. |
| MaxWidth | Gets or sets the maximum width of the element. Inherited from Layoutable. |
| MinHeight | Gets or sets the minimum height of the element. Inherited from Layoutable. |
| MinWidth | Gets or sets the minimum width of the element. Inherited from Layoutable. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Opacity | Gets or sets the opacity of the control. Inherited from Visual. |
| OpacityMask | Gets or sets the opacity mask of the control. Inherited from Visual. |
| RenderTransform | Gets or sets the render transform of the control. Inherited from Visual. |
| RenderTransformOrigin | Gets or sets the transform origin of the control. Inherited from Visual. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
AcceptsReturn Property
Gets or sets a value that determines whether the TextBox allows and displays newline or return characters
public bool AcceptsReturn { get; set; }
AcceptsTab Property
Gets or sets a value that determines whether the TextBox allows and displays tabs
public bool AcceptsTab { get; set; }
CanCopy Property
Property for determining if the Copy command can be executed.
public bool CanCopy { get; set; }
CanCut Property
Property for determining if the Cut command can be executed.
public bool CanCut { get; set; }
CanPaste Property
Property for determining if the Paste command can be executed.
public bool CanPaste { get; set; }
CanRedo Property
Gets a value that indicates whether the redo stack has an action that can be redone
public bool CanRedo { get; set; }
CanUndo Property
Gets a value that indicates whether the undo stack has an action that can be undone
public bool CanUndo { get; set; }
CaretBlinkInterval Property
Gets or sets the caret blink rate
public TimeSpan CaretBlinkInterval { get; set; }
CaretBrush Property
Gets or sets a brush that is used for the text caret
public Avalonia.Media.IBrush CaretBrush { get; set; }
CaretIndex Property
Gets or sets the index of the text caret
public int CaretIndex { get; set; }
ClearSelectionOnLostFocus Property
Gets or sets a value that determines whether the TextBox clears its selection after it loses focus.
public bool ClearSelectionOnLostFocus { get; set; }
CopyGesture Property
Gets a platform-specific Avalonia.Input.KeyGesture for the Copy action
public Avalonia.Input.KeyGesture CopyGesture { get; set; }
CutGesture Property
Gets a platform-specific Avalonia.Input.KeyGesture for the Cut action
public Avalonia.Input.KeyGesture CutGesture { get; set; }
HorizontalContentAlignment Property
Gets or sets the horizontal alignment of the content within the control.
public Avalonia.Layout.HorizontalAlignment HorizontalContentAlignment { get; set; }
InnerLeftContent Property
Gets or sets custom content that is positioned on the left side of the text layout box
public object InnerLeftContent { get; set; }
InnerRightContent Property
Gets or sets custom content that is positioned on the right side of the text layout box
public object InnerRightContent { get; set; }
IsInactiveSelectionHighlightEnabled Property
Gets or sets a value that determines whether the TextBox shows a selection highlight when it is not focused.
public bool IsInactiveSelectionHighlightEnabled { get; set; }
IsReadOnly Property
Gets or sets a value whether this TextBox is read-only
public bool IsReadOnly { get; set; }
IsUndoEnabled Property
Property for determining whether undo/redo is enabled
public bool IsUndoEnabled { get; set; }
LineHeight Property
Gets or sets the line height.
public double LineHeight { get; set; }
MaxLength Property
Gets or sets the maximum number of characters that the Avalonia.Controls.TextBox can accept. This constraint only applies for manually entered (user-inputted) text.
public int MaxLength { get; set; }
MaxLines Property
Gets or sets the maximum number of visible lines to size to.
public int MaxLines { get; set; }
MinLines Property
Gets or sets the minimum number of visible lines to size to.
public int MinLines { get; set; }
NewLine Property
Gets or sets which characters are inserted when Enter is pressed. Default: Environment.NewLine
public string NewLine { get; set; }
PasswordChar Property
Gets or sets the char that should be used for password masking
public char PasswordChar { get; set; }
PasteGesture Property
Gets a platform-specific Avalonia.Input.KeyGesture for the Paste action
public Avalonia.Input.KeyGesture PasteGesture { get; set; }
PlaceholderForeground Property
Gets or sets the brush used for the foreground color of the placeholder text.
public Avalonia.Media.IBrush PlaceholderForeground { get; set; }
PlaceholderText Property
Gets or sets the placeholder or descriptive text that is displayed even if the Avalonia.Controls.TextBox.Text property is not yet set.
public string PlaceholderText { get; set; }
RevealPassword Property
Gets or sets whether text masked by Avalonia.Controls.TextBox.PasswordChar should be revealed
public bool RevealPassword { get; set; }
SelectedText Property
Gets or sets the text selected in the TextBox
public string SelectedText { get; set; }
SelectionBrush Property
Gets or sets a brush that is used to highlight selected text
public Avalonia.Media.IBrush SelectionBrush { get; set; }
SelectionEnd Property
Gets or sets the end position of the text selected in the TextBox
public int SelectionEnd { get; set; }
Remarks
When the SelectionEnd is equal to Avalonia.Controls.TextBox.SelectionStart, there is no selected text and it marks the caret position
SelectionForegroundBrush Property
Gets or sets a brush that is used for the foreground of selected text
public Avalonia.Media.IBrush SelectionForegroundBrush { get; set; }
SelectionStart Property
Gets or sets the starting position of the text selected in the TextBox
public int SelectionStart { get; set; }
Text Property
Gets or sets the Text content of the TextBox
public string Text { get; set; }
TextAlignment Property
Gets or sets the Avalonia.Media.TextAlignment of the TextBox
public Avalonia.Media.TextAlignment TextAlignment { get; set; }
TextWrapping Property
Gets or sets the Avalonia.Media.TextWrapping of the TextBox
public Avalonia.Media.TextWrapping TextWrapping { get; set; }
UndoLimit Property
Gets or sets the maximum number of items that can reside in the Undo stack
public int UndoLimit { get; set; }
UseFloatingPlaceholder Property
Gets or sets a value indicating whether the Avalonia.Controls.TextBox.PlaceholderText will still be shown above the Avalonia.Controls.TextBox.Text even after a text value is set.
public bool UseFloatingPlaceholder { get; set; }
UseFloatingWatermark Property
Gets or sets a value indicating whether the Avalonia.Controls.TextBox.PlaceholderText will still be shown above the Avalonia.Controls.TextBox.Text even after a text value is set.
public bool UseFloatingWatermark { get; set; }
VerticalContentAlignment Property
Gets or sets the vertical alignment of the content within the control.
public Avalonia.Layout.VerticalAlignment VerticalContentAlignment { get; set; }
Watermark Property
Gets or sets the placeholder or descriptive text that is displayed even if the Avalonia.Controls.TextBox.Text property is not yet set.
public string Watermark { get; set; }
WatermarkForeground Property
Gets or sets the brush used for the foreground color of the placeholder text.
public Avalonia.Media.IBrush WatermarkForeground { get; set; }
Fields
AcceptsReturnProperty Field
Defines the Avalonia.Controls.TextBox.AcceptsReturn property
public Avalonia.StyledProperty<bool> AcceptsReturnProperty
AcceptsTabProperty Field
Defines the Avalonia.Controls.TextBox.AcceptsTab property
public Avalonia.StyledProperty<bool> AcceptsTabProperty
CanCopyProperty Field
Defines the Avalonia.Controls.TextBox.CanCopy property
public Avalonia.DirectProperty<Avalonia.Controls.TextBox, bool> CanCopyProperty
CanCutProperty Field
Defines the Avalonia.Controls.TextBox.CanCut property
public Avalonia.DirectProperty<Avalonia.Controls.TextBox, bool> CanCutProperty
CanPasteProperty Field
Defines the Avalonia.Controls.TextBox.CanPaste property
public Avalonia.DirectProperty<Avalonia.Controls.TextBox, bool> CanPasteProperty
CanRedoProperty Field
Defines the Avalonia.Controls.TextBox.CanRedo property
public Avalonia.DirectProperty<Avalonia.Controls.TextBox, bool> CanRedoProperty
CanUndoProperty Field
Defines the Avalonia.Controls.TextBox.CanUndo property
public Avalonia.DirectProperty<Avalonia.Controls.TextBox, bool> CanUndoProperty
CaretBlinkIntervalProperty Field
Defines the Avalonia.Controls.TextBox.CaretBlinkInterval property
public Avalonia.StyledProperty<TimeSpan> CaretBlinkIntervalProperty
CaretBrushProperty Field
Defines the Avalonia.Controls.TextBox.CaretBrush property
public Avalonia.StyledProperty<Avalonia.Media.IBrush> CaretBrushProperty
CaretIndexProperty Field
Defines the Avalonia.Controls.TextBox.CaretIndex property
public Avalonia.StyledProperty<int> CaretIndexProperty
ClearSelectionOnLostFocusProperty Field
Defines the Avalonia.Controls.TextBox.ClearSelectionOnLostFocus property
public Avalonia.StyledProperty<bool> ClearSelectionOnLostFocusProperty
CopyingToClipboardEvent Field
Defines the Avalonia.Controls.TextBox.CopyingToClipboard event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.RoutedEventArgs> CopyingToClipboardEvent
CuttingToClipboardEvent Field
Defines the Avalonia.Controls.TextBox.CuttingToClipboard event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.RoutedEventArgs> CuttingToClipboardEvent
HorizontalContentAlignmentProperty Field
Defines the Avalonia.Layout.HorizontalAlignment property.
public Avalonia.StyledProperty<Avalonia.Layout.HorizontalAlignment> HorizontalContentAlignmentProperty
InnerLeftContentProperty Field
Defines the Avalonia.Controls.TextBox.InnerLeftContent property
public Avalonia.StyledProperty<object> InnerLeftContentProperty
InnerRightContentProperty Field
Defines the Avalonia.Controls.TextBox.InnerRightContent property
public Avalonia.StyledProperty<object> InnerRightContentProperty
IsInactiveSelectionHighlightEnabledProperty Field
Defines the Avalonia.Controls.TextBox.IsInactiveSelectionHighlightEnabled property
public Avalonia.StyledProperty<bool> IsInactiveSelectionHighlightEnabledProperty
IsReadOnlyProperty Field
Defines the Avalonia.Controls.TextBox.IsReadOnly property
public Avalonia.StyledProperty<bool> IsReadOnlyProperty
IsUndoEnabledProperty Field
Defines the Avalonia.Controls.TextBox.IsUndoEnabled property
public Avalonia.StyledProperty<bool> IsUndoEnabledProperty
LineHeightProperty Field
Defines see Avalonia.Controls.Presenters.TextPresenter.LineHeight property.
public Avalonia.StyledProperty<double> LineHeightProperty
MaxLengthProperty Field
Defines the Avalonia.Controls.TextBox.MaxLength property
public Avalonia.StyledProperty<int> MaxLengthProperty
MaxLinesProperty Field
Defines the Avalonia.Controls.TextBox.MaxLines property
public Avalonia.StyledProperty<int> MaxLinesProperty
MinLinesProperty Field
Defines the Avalonia.Controls.TextBox.MinLines property
public Avalonia.StyledProperty<int> MinLinesProperty
NewLineProperty Field
Defines the Avalonia.Controls.TextBox.NewLine property
public Avalonia.StyledProperty<string> NewLineProperty
PasswordCharProperty Field
Defines the Avalonia.Controls.TextBox.PasswordChar property
public Avalonia.StyledProperty<char> PasswordCharProperty
PastingFromClipboardEvent Field
Defines the Avalonia.Controls.TextBox.PastingFromClipboard event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.RoutedEventArgs> PastingFromClipboardEvent
PlaceholderForegroundProperty Field
Defines the Avalonia.Controls.TextBox.PlaceholderForeground property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> PlaceholderForegroundProperty
PlaceholderTextProperty Field
Defines the Avalonia.Controls.TextBox.PlaceholderText property.
public Avalonia.StyledProperty<string> PlaceholderTextProperty
RevealPasswordProperty Field
Defines the Avalonia.Controls.TextBox.RevealPassword property
public Avalonia.StyledProperty<bool> RevealPasswordProperty
SelectionBrushProperty Field
Defines the Avalonia.Controls.TextBox.SelectionBrush property
public Avalonia.StyledProperty<Avalonia.Media.IBrush> SelectionBrushProperty
SelectionEndProperty Field
Defines the Avalonia.Controls.TextBox.SelectionEnd property
public Avalonia.StyledProperty<int> SelectionEndProperty
SelectionForegroundBrushProperty Field
Defines the Avalonia.Controls.TextBox.SelectionForegroundBrush property
public Avalonia.StyledProperty<Avalonia.Media.IBrush> SelectionForegroundBrushProperty
SelectionStartProperty Field
Defines the Avalonia.Controls.TextBox.SelectionStart property
public Avalonia.StyledProperty<int> SelectionStartProperty
TextAlignmentProperty Field
Defines the Avalonia.Controls.TextBox.TextAlignment property
public Avalonia.StyledProperty<Avalonia.Media.TextAlignment> TextAlignmentProperty
TextChangedEvent Field
Defines the Avalonia.Controls.TextBox.TextChanged event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.TextChangedEventArgs> TextChangedEvent
TextChangingEvent Field
Defines the Avalonia.Controls.TextBox.TextChanging event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.TextChangingEventArgs> TextChangingEvent
TextProperty Field
Defines the Avalonia.Controls.TextBox.Text property
public Avalonia.StyledProperty<string> TextProperty
TextWrappingProperty Field
public Avalonia.StyledProperty<Avalonia.Media.TextWrapping> TextWrappingProperty
UndoLimitProperty Field
Defines the Avalonia.Controls.TextBox.UndoLimit property
public Avalonia.StyledProperty<int> UndoLimitProperty
UseFloatingPlaceholderProperty Field
Defines the Avalonia.Controls.TextBox.UseFloatingPlaceholder property.
public Avalonia.StyledProperty<bool> UseFloatingPlaceholderProperty
UseFloatingWatermarkProperty Field
Defines the Avalonia.Controls.TextBox.UseFloatingWatermark property.
public Avalonia.StyledProperty<bool> UseFloatingWatermarkProperty
VerticalContentAlignmentProperty Field
Defines the Avalonia.Layout.VerticalAlignment property.
public Avalonia.StyledProperty<Avalonia.Layout.VerticalAlignment> VerticalContentAlignmentProperty
WatermarkForegroundProperty Field
Defines the Avalonia.Controls.TextBox.WatermarkForeground property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> WatermarkForegroundProperty
WatermarkProperty Field
Defines the Avalonia.Controls.TextBox.Watermark property.
public Avalonia.StyledProperty<string> WatermarkProperty
Events
| Name | Description |
|---|---|
| CopyingToClipboard | Raised when content is being copied to the clipboard |
| CuttingToClipboard | Raised when content is being cut to the clipboard |
| PastingFromClipboard | Raised when content is being pasted from the clipboard |
| 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. |
| TemplateApplied | Raised when the control's template is applied. Inherited from TemplatedControl. |
| Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| DoubleTapped | Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from InputElement. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from InputElement. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| Pinch | Occurs when the user moves two contact points closer together. Inherited from InputElement. |
| PinchEnded | Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement. |
| PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement. |
| PointerEntered | Occurs when the pointer enters the control. Inherited from InputElement. |
| PointerExited | Occurs when the pointer leaves the control. Inherited from InputElement. |
| PointerMoved | Occurs when the pointer moves over the control. Inherited from InputElement. |
| PointerPressed | Occurs when the pointer is pressed over the control. Inherited from InputElement. |
| PointerReleased | Occurs when the pointer is released over the control. Inherited from InputElement. |
| PointerTouchPadGestureMagnify | Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PullGesture | Occurs when the user drags from the edge of a control. Inherited from InputElement. |
| PullGestureEnded | Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement. |
| RightTapped | Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement. |
| ScrollGesture | Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement. |
| SwipeGesture | Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement. |
| SwipeGestureEnded | Occurs when a swipe gesture ends on the control. Inherited from InputElement. |
| Tapped | Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
CopyingToClipboard Event
Raised when content is being copied to the clipboard
public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> CopyingToClipboard
CuttingToClipboard Event
Raised when content is being cut to the clipboard
public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> CuttingToClipboard
PastingFromClipboard Event
Raised when content is being pasted from the clipboard
public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> PastingFromClipboard
TextChanged Event
Occurs asynchronously after text changes and the new text is rendered.
public event EventHandler<Avalonia.Controls.TextChangedEventArgs> TextChanged
TextChanging Event
Occurs synchronously when text starts to change but before it is rendered.
public event EventHandler<Avalonia.Controls.TextChangingEventArgs> TextChanging
Remarks
This event occurs just after the Avalonia.Controls.TextBox.Text property value has been updated.