Skip to main content

TextBox Class

Represents a control that can be used to display or edit unformatted text.

Definition

Namespace: Avalonia.Controls
Assembly: Avalonia.Controls (in Avalonia.Controls.dll)

[TemplatePartAttribute("PART_TextPresenter", typeof(TextPresenter), IsRequired = true)]
[TemplatePartAttribute("PART_ScrollViewer", typeof(ScrollViewer))]
[PseudoClassesAttribute(new string[] { ... })]
public class TextBox : TemplatedControl
InheritanceObjectAvaloniaObjectAnimatableStyledElementVisualLayoutableInteractiveInputElementControlTemplatedControl → TextBox
DerivedAvalonia.Controls.MaskedTextBox

Constructors

TextBox()Initializes a new instance of the TextBox class

Properties

AcceptsReturnGets or sets a value that determines whether the TextBox allows and displays newline or return characters
AcceptsTabGets or sets a value that determins whether the TextBox allows and displays tabs
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty.
(Inherited from StyledElement)
BackgroundGets or sets the brush used to draw the control's background.
(Inherited from TemplatedControl)
BackgroundSizingGets or sets how the control's background is drawn relative to the control's border.
(Inherited from TemplatedControl)
BorderBrushGets or sets the brush used to draw the control's border.
(Inherited from TemplatedControl)
BorderThicknessGets or sets the thickness of the control's border.
(Inherited from TemplatedControl)
BoundsGets the bounds of the control relative to its parent.
(Inherited from Visual)
BypassFlowDirectionPoliciesGets a value indicating whether control bypass FlowDirecton policies.
(Inherited from Visual)
CanCopyProperty for determining if the Copy command can be executed.
CanCutProperty for determining if the Cut command can be executed.
CanPasteProperty for determining if the Paste command can be executed.
CanRedoGets a value that indicates whether the redo stack has an action that can be redone
CanUndoGets a value that indicates whether the undo stack has an action that can be undone
CaretBlinkIntervalGets or sets the caret blink rate
CaretBrushGets or sets a brush that is used for the text caret
CaretIndexGets or sets the index of the text caret
ClassesGets or sets the styled element's classes.
(Inherited from StyledElement)
ClearSelectionOnLostFocusGets or sets a value that determines whether the TextBox clears its selection after it loses focus.
ClipGets or sets the geometry clip for this visual.
(Inherited from Visual)
ClipToBoundsGets or sets a value indicating whether the control should be clipped to its bounds.
(Inherited from Visual)
ContextFlyoutGets or sets a context flyout to the control
(Inherited from Control)
ContextMenuGets or sets a context menu to the control.
(Inherited from Control)
CopyGestureGets a platform-specific KeyGesture for the Copy action
CornerRadiusGets or sets the radius of the border rounded corners.
(Inherited from TemplatedControl)
CursorGets or sets associated mouse cursor.
(Inherited from InputElement)
CutGestureGets a platform-specific KeyGesture for the Cut action
DataContextGets or sets the control's data context.
(Inherited from StyledElement)
DataTemplatesGets or sets the data templates for the control.
(Inherited from Control)
DesiredSizeGets the size that this element computed during the measure pass of the layout process.
(Inherited from Layoutable)
EffectGets or sets the effect of the control.
(Inherited from Visual)
FlowDirectionGets or sets the text flow direction.
(Inherited from Visual)
FocusableGets or sets a value indicating whether the control can receive focus.
(Inherited from InputElement)
FocusAdornerGets or sets the control's focus adorner.
(Inherited from Control)
FontFamilyGets or sets the font family used to draw the control's text.
(Inherited from TemplatedControl)
FontFeaturesGets or sets the font features turned on/off.
(Inherited from TemplatedControl)
FontSizeGets or sets the size of the control's text in points.
(Inherited from TemplatedControl)
FontStretchGets or sets the font stretch used to draw the control's text.
(Inherited from TemplatedControl)
FontStyleGets or sets the font style used to draw the control's text.
(Inherited from TemplatedControl)
FontWeightGets or sets the font weight used to draw the control's text.
(Inherited from TemplatedControl)
ForegroundGets or sets the brush used to draw the control's text and other foreground elements.
(Inherited from TemplatedControl)
GestureRecognizers
(Inherited from InputElement)
HasMirrorTransformGets or sets a value indicating whether to apply mirror transform on this control.
(Inherited from Visual)
HeightGets or sets the height of the element.
(Inherited from Layoutable)
HorizontalAlignmentGets or sets the element's preferred horizontal alignment in its parent.
(Inherited from Layoutable)
HorizontalContentAlignmentGets or sets the horizontal alignment of the content within the control.
InheritanceParentGets or sets the parent object that inherited AvaloniaProperty values are inherited from.
(Inherited from AvaloniaObject)
InnerLeftContentGets or sets custom content that is positioned on the left side of the text layout box
InnerRightContentGets or sets custom content that is positioned on the right side of the text layout box
IsArrangeValidGets a value indicating whether the control's layouts arrange is valid.
(Inherited from Layoutable)
IsEffectivelyEnabledGets a value indicating whether this control and all its parents are enabled.
(Inherited from InputElement)
IsEffectivelyVisibleGets a value indicating whether this control and all its parents are visible.
(Inherited from Visual)
IsEnabledGets or sets a value indicating whether the control is enabled for user interaction.
(Inherited from InputElement)
IsEnabledCoreAllows a derived class to override the enabled state of the control.
(Inherited from InputElement)
IsFocusedGets a value indicating whether the control is focused.
(Inherited from InputElement)
IsHitTestVisibleGets or sets a value indicating whether the control is considered for hit testing.
(Inherited from InputElement)
IsInactiveSelectionHighlightEnabledGets or sets a value that determines whether the TextBox shows a selection highlight when it is not focused.
IsInitializedGets a value that indicates whether the element has finished initialization.
(Inherited from StyledElement)
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.
(Inherited from InputElement)
IsLoadedGets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete.
(Inherited from Control)
IsMeasureValidGets a value indicating whether the control's layout measure is valid.
(Inherited from Layoutable)
IsPointerOverGets a value indicating whether the pointer is currently over the control.
(Inherited from InputElement)
IsReadOnlyGets or sets a value whether this TextBox is read-only
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation.
(Inherited from InputElement)
IsUndoEnabledProperty for determining whether undo/redo is enabled
IsVisibleGets or sets a value indicating whether this control is visible.
(Inherited from Visual)
Item(AvaloniaProperty)Gets or sets the value of a AvaloniaProperty.
(Inherited from AvaloniaObject)
Item(IndexerDescriptor)Gets or sets a binding for a AvaloniaProperty.
(Inherited from AvaloniaObject)
KeyBindings
(Inherited from InputElement)
LetterSpacingGets or sets the spacing between characters
LineHeightGets or sets the line height.
LogicalChildrenGets the styled element's logical children.
(Inherited from StyledElement)
MarginGets or sets the margin around the element.
(Inherited from Layoutable)
MaxHeightGets or sets the maximum height of the element.
(Inherited from Layoutable)
MaxLengthGets or sets the maximum number of characters that the TextBox can accept. This constraint only applies for manually entered (user-inputted) text.
MaxLinesGets or sets the maximum number of visible lines to size to.
MaxWidthGets or sets the maximum width of the element.
(Inherited from Layoutable)
MinHeightGets or sets the minimum height of the element.
(Inherited from Layoutable)
MinLinesGets or sets the minimum number of visible lines to size to.
MinWidthGets or sets the minimum width of the element.
(Inherited from Layoutable)
NameGets or sets the name of the styled element.
(Inherited from StyledElement)
NewLineGets or sets which characters are inserted when Enter is pressed. Default: NewLine
OpacityGets or sets the opacity of the control.
(Inherited from Visual)
OpacityMaskGets or sets the opacity mask of the control.
(Inherited from Visual)
PaddingGets or sets the padding placed between the border of the control and its content.
(Inherited from TemplatedControl)
ParentGets the styled element's logical parent.
(Inherited from StyledElement)
PasswordCharGets or sets the Char that should be used for password masking
PasteGestureGets a platform-specific KeyGesture for the Paste action
PseudoClassesGets the Classes collection in a form that allows adding and removing pseudoclasses.
(Inherited from StyledElement)
RenderTransformGets or sets the render transform of the control.
(Inherited from Visual)
RenderTransformOriginGets or sets the transform origin of the control.
(Inherited from Visual)
ResourcesGets or sets the styled element's resource dictionary.
(Inherited from StyledElement)
RevealPasswordGets or sets whether text masked by PasswordChar should be revealed
SelectedTextGets or sets the text selected in the TextBox
SelectionBrushGets or sets a brush that is used to highlight selected text
SelectionEndGets or sets the end position of the text selected in the TextBox
SelectionForegroundBrushGets or sets a brush that is used for the foreground of selected text
SelectionStartGets or sets the starting position of the text selected in the TextBox
StyleKeyGets the type by which the element is styled.
(Inherited from StyledElement)
StyleKeyOverrideGets the type by which the element is styled.
(Inherited from StyledElement)
StylesGets the styles for the styled element.
(Inherited from StyledElement)
TabIndexGets 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)
TagGets or sets a user-defined object attached to the control.
(Inherited from Control)
TemplateGets or sets the template that defines the control's appearance.
(Inherited from TemplatedControl)
TemplatedParentGets the styled element whose lookless template this styled element is part of.
(Inherited from StyledElement)
TextGets or sets the Text content of the TextBox
TextAlignmentGets or sets the TextAlignment of the TextBox
TextWrappingGets or sets the TextWrapping of the TextBox
ThemeGets or sets the theme to be applied to the element.
(Inherited from StyledElement)
TransitionsGets or sets the property transitions for the control.
(Inherited from Animatable)
UndoLimitGets or sets the maximum number of items that can reside in the Undo stack
UseFloatingWatermarkGets or sets a value indicating whether the Watermark will still be shown above the Text even after a text value is set.
UseLayoutRoundingGets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time.
(Inherited from Layoutable)
VerticalAlignmentGets or sets the element's preferred vertical alignment in its parent.
(Inherited from Layoutable)
VerticalContentAlignmentGets or sets the vertical alignment of the content within the control.
VisualChildrenGets the control's child visuals.
(Inherited from Visual)
VisualRootGets the root of the visual tree, if the control is attached to a visual tree.
(Inherited from Visual)
WatermarkGets or sets the placeholder or descriptive text that is displayed even if the Text property is not yet set.
WidthGets or sets the width of the element.
(Inherited from Layoutable)
ZIndexGets or sets the Z index of the control.
(Inherited from Visual)

Methods

AddHandler(RoutedEvent, Delegate, RoutingStrategies, Boolean)Adds a handler for the specified routed event.
(Inherited from Interactive)
AddHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs), RoutingStrategies, Boolean)Adds a handler for the specified routed event.
(Inherited from Interactive)
ApplyStyling()Applies styling to the control if the control is initialized and styling is not already applied.
(Inherited from StyledElement)
ApplyTemplate()Creates the visual children of the control, if necessary
(Inherited from TemplatedControl)
Arrange(Rect)Arranges the control and its children.
(Inherited from Layoutable)
ArrangeCore(Rect)The default implementation of the control's arrange pass.
(Inherited from Layoutable)
ArrangeOverride(Size)Positions child elements as part of a layout pass.
(Inherited from Layoutable)
BeginInit()Signals the object that initialization is starting.
(Inherited from StyledElement)
Bind(AvaloniaProperty, IBinding)Binds a AvaloniaProperty to an IBinding.
(Inherited from AvaloniaObject)
Bind(AvaloniaProperty, IObservable(Object), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(T))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(BindingValue(T)))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(Object))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(T), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(BindingValue(T)), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(Object), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BuildEventRoute(RoutedEvent)Builds an event route for a routed event.
(Inherited from Interactive)
CheckAccess()Returns a value indicating whether the current thread is the UI thread.
(Inherited from AvaloniaObject)
Clear()Clears the text in the TextBox
ClearSelection()Clears the current selection, maintaining the CaretIndex
ClearValue(AvaloniaProperty)Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(AvaloniaProperty(T))Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(DirectPropertyBase(T))Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(StyledProperty(T))Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
CoerceText(String)Coerces the current text.
CoerceValue(AvaloniaProperty)Coerces the specified AvaloniaProperty.
(Inherited from AvaloniaObject)
Copy()Copies the current text onto the clipboard
Cut()Cuts the current text onto the clipboard
EndInit()Signals the object that initialization is complete.
(Inherited from StyledElement)
Equals(Object)Compares two objects using reference equality.
(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)Focuses the control.
(Inherited from InputElement)
GetBaseValue(T)(StyledProperty(T))Gets an AvaloniaProperty base value.
(Inherited from AvaloniaObject)
GetHashCode()Gets the hash code for the object.
(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)Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
GetValue(T)(DirectPropertyBase(T))Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
GetValue(T)(StyledProperty(T))Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
InitializeIfNeeded()
(Inherited from StyledElement)
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)
InvalidateMirrorTransform()Computes the HasMirrorTransform value according to the FlowDirection and BypassFlowDirectionPolicies
(Inherited from Visual)
InvalidateVisual()Invalidates the visual and queues a repaint.
(Inherited from Visual)
IsAnimating(AvaloniaProperty)Checks whether a AvaloniaProperty is animating.
(Inherited from AvaloniaObject)
IsSet(AvaloniaProperty)Checks whether a AvaloniaProperty is set on this object.
(Inherited from AvaloniaObject)
LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs)
(Inherited from Visual)
Measure(Size)Carries out a measure of the control.
(Inherited from Layoutable)
MeasureCore(Size)The default implementation of the control's measure pass.
(Inherited from Layoutable)
MeasureOverride(Size)
(Overrides Layoutable.MeasureOverride(Size))
MemberwiseClone()Creates a shallow copy of the current Object.
(Inherited from Object)
OnApplyTemplate(TemplateAppliedEventArgs)
(Overrides TemplatedControl.OnApplyTemplate(TemplateAppliedEventArgs))
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs)Called when the styled element is added to a rooted logical tree.
(Inherited from TemplatedControl)
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)
(Overrides Visual.OnAttachedToVisualTree(VisualTreeAttachmentEventArgs))
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)Calls the OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) method for this control and all of its visual descendants.
(Inherited from Control)
OnCreateAutomationPeer()
(Overrides Control.OnCreateAutomationPeer())
OnDataContextBeginUpdate()Called when the DataContext begins updating.
(Inherited from StyledElement)
OnDataContextChanged(EventArgs)Called when the DataContext property changes.
(Inherited from StyledElement)
OnDataContextEndUpdate()Called when the DataContext finishes updating.
(Inherited from StyledElement)
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs)Called when the styled element is removed from a rooted logical tree.
(Inherited from TemplatedControl)
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)
(Overrides Visual.OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs))
OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)
(Inherited from Control)
OnGotFocus(GotFocusEventArgs)
(Overrides Control.OnGotFocus(GotFocusEventArgs))
OnInitialized()Called when the control finishes initialization.
(Inherited from StyledElement)
OnKeyDown(KeyEventArgs)
(Overrides InputElement.OnKeyDown(KeyEventArgs))
OnKeyUp(KeyEventArgs)Called before the KeyUp event occurs.
(Inherited from Control)
OnLoaded(RoutedEventArgs)Invoked just before the Loaded event.
(Inherited from Control)
OnLostFocus(RoutedEventArgs)
(Overrides Control.OnLostFocus(RoutedEventArgs))
OnMeasureInvalidated()Called by InvalidateMeasure
(Inherited from Layoutable)
OnPointerCaptureLost(PointerCaptureLostEventArgs)Called before the PointerCaptureLost event occurs.
(Inherited from InputElement)
OnPointerEntered(PointerEventArgs)Called before the PointerEntered event occurs.
(Inherited from InputElement)
OnPointerExited(PointerEventArgs)Called before the PointerExited event occurs.
(Inherited from InputElement)
OnPointerMoved(PointerEventArgs)
(Overrides InputElement.OnPointerMoved(PointerEventArgs))
OnPointerPressed(PointerPressedEventArgs)
(Overrides InputElement.OnPointerPressed(PointerPressedEventArgs))
OnPointerReleased(PointerReleasedEventArgs)
(Overrides Control.OnPointerReleased(PointerReleasedEventArgs))
OnPointerWheelChanged(PointerWheelEventArgs)Called before the PointerWheelChanged event occurs.
(Inherited from InputElement)
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
(Overrides Control.OnPropertyChanged(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)Called when the control's visual parent changes.
(Inherited from Layoutable)
Paste()Pastes the current clipboard text content into the TextBox
RaiseEvent(RoutedEventArgs)Raises a routed event.
(Inherited from Interactive)
RaisePropertyChanged(T)(DirectPropertyBase(T), T, T)Raises the PropertyChanged event for a direct property.
(Inherited from AvaloniaObject)
Redo()Reapplies the first item on the redo stack
RemoveHandler(RoutedEvent, Delegate)Removes a handler for the specified routed event.
(Inherited from Interactive)
RemoveHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs))Removes a handler for the specified routed event.
(Inherited from Interactive)
Render(DrawingContext)Renders the visual to a DrawingContext.
(Inherited from Visual)
ScrollToLine(Int32)Scroll the TextBox to the specified line index.
SelectAll()Select all text in the TextBox
SetAndRaise(T)(DirectPropertyBase(T), T, T)Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed.
(Inherited from AvaloniaObject)
SetCurrentValue(AvaloniaProperty, Object)Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject)
SetCurrentValue(T)(StyledProperty(T), T)Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject)
SetValue(AvaloniaProperty, Object, BindingPriority)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
SetValue(T)(DirectPropertyBase(T), T)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
SetValue(T)(StyledProperty(T), T, BindingPriority)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
ToString()Returns a string that represents the current object.
(Inherited from Object)
TryGetResource(Object, ThemeVariant, Object)Tries to find a resource within the object.
(Inherited from StyledElement)
Undo()Undoes the first action in the undo stack
UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception)
(Overrides AvaloniaObject.UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception))
UpdateIsEffectivelyEnabled()Updates the IsEffectivelyEnabled property value according to the parent control's enabled state and IsEnabledCore.
(Inherited from InputElement)
UpdateLayout()Executes a layout pass.
(Inherited from Layoutable)
VerifyAccess()Checks that the current thread is the UI thread and throws if not.
(Inherited from AvaloniaObject)

Events

ActualThemeVariantChangedRaised when the theme variant is changed on the element or an ancestor of the element.
(Inherited from StyledElement)
AttachedToLogicalTreeRaised when the styled element is attached to a rooted logical tree.
(Inherited from StyledElement)
AttachedToVisualTreeRaised when the control is attached to a rooted visual tree.
(Inherited from Visual)
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click.
(Inherited from Control)
CopyingToClipboardRaised when content is being copied to the clipboard
CuttingToClipboardRaised when content is being cut to the clipboard
DataContextChangedOccurs when the DataContext property changes.
(Inherited from StyledElement)
DetachedFromLogicalTreeRaised when the styled element is detached from a rooted logical tree.
(Inherited from StyledElement)
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree.
(Inherited from Visual)
DoubleTappedOccurs when a double-tap gesture occurs on the control.
(Inherited from InputElement)
EffectiveViewportChangedOccurs when the element's effective viewport changes.
(Inherited from Layoutable)
GotFocusOccurs when the control receives focus.
(Inherited from InputElement)
HoldingOccurs when a hold gesture occurs on the control.
(Inherited from InputElement)
InitializedOccurs when the styled element has finished initialization.
(Inherited from StyledElement)
KeyDownOccurs when a key is pressed while the control has focus.
(Inherited from InputElement)
KeyUpOccurs when a key is released while the control has focus.
(Inherited from InputElement)
LayoutUpdatedOccurs when a layout pass completes for the control.
(Inherited from Layoutable)
LoadedOccurs when the control has been fully constructed in the visual tree and both layout and render are complete.
(Inherited from Control)
LostFocusOccurs when the control loses focus.
(Inherited from InputElement)
PastingFromClipboardRaised when content is being pasted from the clipboard
PointerCaptureLostOccurs 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)
PointerEnteredOccurs when the pointer enters the control.
(Inherited from InputElement)
PointerExitedOccurs when the pointer leaves the control.
(Inherited from InputElement)
PointerMovedOccurs when the pointer moves over the control.
(Inherited from InputElement)
PointerPressedOccurs when the pointer is pressed over the control.
(Inherited from InputElement)
PointerReleasedOccurs when the pointer is released over the control.
(Inherited from InputElement)
PointerWheelChangedOccurs when the mouse is scrolled over the control.
(Inherited from InputElement)
PropertyChangedRaised when a AvaloniaProperty value changes on this object.
(Inherited from AvaloniaObject)
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed.
(Inherited from StyledElement)
SizeChangedOccurs when the bounds (actual size) of the control have changed.
(Inherited from Control)
TappedOccurs when a tap gesture occurs on the control.
(Inherited from InputElement)
TemplateAppliedRaised when the control's template is applied.
(Inherited from TemplatedControl)
TextChangedOccurs asynchronously after text changes and the new text is rendered.
TextChangingOccurs synchronously when text starts to change but before it is rendered.
TextInputOccurs when a user typed some text while the control has focus.
(Inherited from InputElement)
TextInputMethodClientRequestedOccurs when an input element gains input focus and input method is looking for the corresponding client
(Inherited from InputElement)
UnloadedOccurs when the control is removed from the visual tree.
(Inherited from Control)

Fields

AcceptsReturnPropertyDefines the AcceptsReturn property
AcceptsTabPropertyDefines the AcceptsTab property
CanCopyPropertyDefines the CanCopy property
CanCutPropertyDefines the CanCut property
CanPastePropertyDefines the CanPaste property
CanRedoPropertyDefines the CanRedo property
CanUndoPropertyDefines the CanUndo property
CaretBlinkIntervalPropertyDefines the CaretBlinkInterval property
CaretBrushPropertyDefines the CaretBrush property
CaretIndexPropertyDefines the CaretIndex property
ClearSelectionOnLostFocusPropertyDefines the ClearSelectionOnLostFocus property
CopyingToClipboardEventDefines the CopyingToClipboard event.
CuttingToClipboardEventDefines the CuttingToClipboard event.
HorizontalContentAlignmentPropertyDefines the HorizontalAlignment property.
InnerLeftContentPropertyDefines the InnerLeftContent property
InnerRightContentPropertyDefines the InnerRightContent property
IsInactiveSelectionHighlightEnabledPropertyDefines the IsInactiveSelectionHighlightEnabled property
IsReadOnlyPropertyDefines the IsReadOnly property
IsUndoEnabledPropertyDefines the IsUndoEnabled property
LetterSpacingPropertyDefines see LetterSpacing property.
LineHeightPropertyDefines see LineHeight property.
MaxLengthPropertyDefines the MaxLength property
MaxLinesPropertyDefines the MaxLines property
MinLinesPropertyDefines the MinLines property
NewLinePropertyDefines the NewLine property
PasswordCharPropertyDefines the PasswordChar property
PastingFromClipboardEventDefines the PastingFromClipboard event.
RevealPasswordPropertyDefines the RevealPassword property
SelectionBrushPropertyDefines the SelectionBrush property
SelectionEndPropertyDefines the SelectionEnd property
SelectionForegroundBrushPropertyDefines the SelectionForegroundBrush property
SelectionStartPropertyDefines the SelectionStart property
TextAlignmentPropertyDefines the TextAlignment property
TextChangedEventDefines the TextChanged event.
TextChangingEventDefines the TextChanging event.
TextPropertyDefines the Text property
TextWrappingProperty 
UndoLimitPropertyDefines the UndoLimit property
UseFloatingWatermarkPropertyDefines the UseFloatingWatermark property
VerticalContentAlignmentPropertyDefines the VerticalAlignment property.
WatermarkPropertyDefines the Watermark property

Extension Methods

AddDisposableHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs), RoutingStrategies, Boolean)Adds a handler for the specified routed event and returns a disposable that can terminate the event subscription.
(Defined by InteractiveExtensions)
Bind(AvaloniaProperty, IBinding, Object)Binds a property on an AvaloniaObject to an IBinding.
(Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(BindingValue(T)), BindingPriority)Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(T), BindingPriority)Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
BindClass(String, IBinding, Object)
(Defined by StyledElementExtensions)
BringIntoView()Tries to bring the control into view.
(Defined by ControlExtensions)
BringIntoView(Rect)Tries to bring the control into view.
(Defined by ControlExtensions)
CalculateDistanceFromAncestor(Visual)Calculates the distance from a visual's ancestor.
(Defined by VisualExtensions)
FindAncestorOfType(T)(Boolean)Finds first ancestor of given type.
(Defined by VisualExtensions)
FindCommonVisualAncestor(Visual)Tries to get the first common ancestor of two visuals.
(Defined by VisualExtensions)
FindControl(T)(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)
FindDescendantOfType(T)(Boolean)Finds first descendant of given type.
(Defined by VisualExtensions)
GetBaseValue(AvaloniaProperty)Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBaseValue(T)(AvaloniaProperty(T))Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(AvaloniaProperty)Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(T)(AvaloniaProperty(T))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(TResult)(AvaloniaProperty, Func(Object, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingSubject(AvaloniaProperty, BindingPriority)Gets a subject for a AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetBindingSubject(T)(AvaloniaProperty(T), BindingPriority)Gets a subject for a AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetControl(T)(String)Finds the named control in the scope of the specified control and throws if not found.
(Defined by ControlExtensions)
GetDiagnostic(AvaloniaProperty)Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject.
(Defined by AvaloniaObjectExtensions)
GetInteractiveParent()
(Defined by InteractiveExtensions)
GetObservable(AvaloniaProperty)Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(T)(AvaloniaProperty(T))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(TResult)(AvaloniaProperty, Func(Object, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(TEventArgs)(RoutedEvent(TEventArgs), RoutingStrategies, Boolean)Gets an observable for a RoutedEvent(TEventArgs).
(Defined by InteractiveExtensions)
GetObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetPropertyChangedObservable(AvaloniaProperty)Gets an observable that listens for property changed events for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetSelfAndVisualAncestors()Enumerates an Visual and its ancestors in the visual tree.
(Defined by VisualExtensions)
GetSelfAndVisualDescendants()Enumerates an Visual and its descendants in the visual tree.
(Defined by VisualExtensions)
GetSubject(AvaloniaProperty, BindingPriority)Gets a subject for an AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetSubject(T)(AvaloniaProperty(T), BindingPriority)Gets a subject for an AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetTemplateChildren()
(Defined by TemplateExtensions)
GetTransformedBounds()
(Defined by VisualExtensions)
GetValue(T)(AvaloniaProperty(T))Gets a AvaloniaProperty value.
(Defined by AvaloniaObjectExtensions)
GetValueStoreDiagnostic()Gets a value store diagnostics for a AvaloniaObject.
(Defined by AvaloniaObjectExtensions)
GetVisualAncestors()Enumerates the ancestors of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualAt(Point)Gets the first visual in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualAt(Point, Func(Visual, Boolean))Gets the first visual in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualChildren()Enumerates the children of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualDescendants()Enumerates the descendants of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualParent()Gets the visual parent of an Visual.
(Defined by VisualExtensions)
GetVisualParent(T)()Gets the visual parent of an Visual.
(Defined by VisualExtensions)
GetVisualRoot()Gets the root visual for an Visual.
(Defined by VisualExtensions)
GetVisualsAt(Point)Enumerates the visible visuals in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualsAt(Point, Func(Visual, Boolean))Enumerates the visuals in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
IsAttachedToVisualTree()Returns a value indicating whether this control is attached to a visual root.
(Defined by VisualExtensions)
IsVisualAncestorOf(Visual)Tests whether an Visual is an ancestor of another visual.
(Defined by VisualExtensions)
PointToClient(PixelPoint)Converts a point from screen to client coordinates.
(Defined by VisualExtensions)
PointToScreen(Point)Converts a point from client to screen coordinates.
(Defined by VisualExtensions)
TransformToVisual(Visual)Returns a transform that transforms the visual's coordinates into the coordinates of the specified to.
(Defined by VisualExtensions)
TranslatePoint(Point, Visual)Translates a point relative to this visual to coordinates that are relative to the specified visual.
(Defined by VisualExtensions)

See Also

Reference

Avalonia.Controls Namespace