AutoCompleteBox Class

Summary

Represents a control that provides a text box for user input and a drop-down that contains possible matches based on the input in the text box.
Namespace
Avalonia.Controls
Interfaces
Base Types
graph BT Type-->Base0["TemplatedControl"] click Base0 "/api/Avalonia.Controls.Primitives/TemplatedControl" Base0-->Base1["Control"] click Base1 "/api/Avalonia.Controls/Control" Base1-->Base2["InputElement"] click Base2 "/api/Avalonia.Input/InputElement" Base2-->Base3["Interactive"] click Base3 "/api/Avalonia.Interactivity/Interactive" Base3-->Base4["Layoutable"] click Base4 "/api/Avalonia.Layout/Layoutable" Base4-->Base5["Visual"] click Base5 "/api/Avalonia/Visual" Base5-->Base6["StyledElement"] click Base6 "/api/Avalonia/StyledElement" Base6-->Base7["Animatable"] click Base7 "/api/Avalonia.Animation/Animatable" Base7-->Base8["AvaloniaObject"] click Base8 "/api/Avalonia/AvaloniaObject" Base8-->Base9["object"] Type-.->Interface0["IAvaloniaObjectDebug"] click Interface0 "/api/Avalonia.Diagnostics/IAvaloniaObjectDebug" Type-.->Interface1["INotifyPropertyChanged"] Type-.->Interface2["IValueSink"] Type-.->Interface3["ISetLogicalParent"] click Interface3 "/api/Avalonia.Controls/ISetLogicalParent" Type-.->Interface4["ISetInheritanceParent"] click Interface4 "/api/Avalonia.Controls/ISetInheritanceParent" Type-.->Interface5["IControl"] click Interface5 "/api/Avalonia.Controls/IControl" Type-.->Interface6["IDataTemplateHost"] click Interface6 "/api/Avalonia.Controls.Templates/IDataTemplateHost" Type-.->Interface7["ILayoutable"] click Interface7 "/api/Avalonia.Layout/ILayoutable" Type-.->Interface8["IInputElement"] click Interface8 "/api/Avalonia.Input/IInputElement" Type-.->Interface9["IInteractive"] click Interface9 "/api/Avalonia.Interactivity/IInteractive" Type-.->Interface10["IVisual"] click Interface10 "/api/Avalonia.VisualTree/IVisual" Type-.->Interface11["IStyledElement"] click Interface11 "/api/Avalonia/IStyledElement" Type-.->Interface12["IStyleable"] click Interface12 "/api/Avalonia.Styling/IStyleable" Type-.->Interface13["IStyleHost"] click Interface13 "/api/Avalonia.Styling/IStyleHost" Type-.->Interface14["ILogical"] click Interface14 "/api/Avalonia.LogicalTree/ILogical" Type-.->Interface15["IResourceHost"] click Interface15 "/api/Avalonia.Controls/IResourceHost" Type-.->Interface16["IResourceNode"] click Interface16 "/api/Avalonia.Controls/IResourceNode" Type-.->Interface17["IDataContextProvider"] click Interface17 "/api/Avalonia/IDataContextProvider" Type-.->Interface18["ISupportInitialize"] Type-.->Interface19["INamed"] click Interface19 "/api/Avalonia/INamed" Type-.->Interface20["IVisualBrushInitialize"] click Interface20 "/api/Avalonia.Rendering/IVisualBrushInitialize" Type-.->Interface21["ISetterValue"] click Interface21 "/api/Avalonia.Styling/ISetterValue" Type-.->Interface22["ITemplatedControl"] click Interface22 "/api/Avalonia.Styling/ITemplatedControl" Type-.->Interface23["IAvaloniaObject"] click Interface23 "/api/Avalonia/IAvaloniaObject" Type["AutoCompleteBox"] class Type type-node

Syntax

[PseudoClasses(":dropdownopen")]
public class AutoCompleteBox : TemplatedControl, IAvaloniaObjectDebug, INotifyPropertyChanged, 
    IValueSink, ISetLogicalParent, ISetInheritanceParent, IControl, IDataTemplateHost, ILayoutable, 
    IInputElement, IInteractive, IVisual, IStyledElement, IStyleable, IStyleHost, ILogical, 
    IResourceHost, IResourceNode, IDataContextProvider, ISupportInitialize, INamed, 
    IVisualBrushInitialize, ISetterValue, ITemplatedControl, IAvaloniaObject

Attributes

Type Description
PseudoClassesAttribute

Constructors

Name Summary
AutoCompleteBox() Initializes a new instance of the AutoCompleteBox class.

Events

Name Type Summary
AttachedToLogicalTree EventHandler<LogicalTreeAttachmentEventArgs>?
Raised when the styled element is attached to a rooted logical tree.
Inherited from StyledElement
AttachedToVisualTree EventHandler<VisualTreeAttachmentEventArgs>
Raised when the control is attached to a rooted visual tree.
Inherited from Visual
DataContextChanged EventHandler?
Occurs when the DataContext property changes.
Inherited from StyledElement
DetachedFromLogicalTree EventHandler<LogicalTreeAttachmentEventArgs>?
Raised when the styled element is detached from a rooted logical tree.
Inherited from StyledElement
DetachedFromVisualTree EventHandler<VisualTreeAttachmentEventArgs>
Raised when the control is detached from a rooted visual tree.
Inherited from Visual
DoubleTapped EventHandler<RoutedEventArgs>
Occurs when a double-tap gesture occurs on the control.
Inherited from InputElement
DropDownClosed EventHandler
Occurs when the IsDropDownOpen property was changed from true to false and the drop-down is open.
DropDownClosing EventHandler<CancelEventArgs>
Occurs when the IsDropDownOpen property is changing from true to false.
DropDownOpened EventHandler
Occurs when the value of the IsDropDownOpen property has changed from false to true and the drop-down is open.
DropDownOpening EventHandler<CancelEventArgs>
Occurs when the value of the IsDropDownOpen property is changing from false to true.
EffectiveViewportChanged EventHandler<EffectiveViewportChangedEventArgs>?
Occurs when the element's effective viewport changes.
Inherited from Layoutable
GotFocus EventHandler<GotFocusEventArgs>
Occurs when the control receives focus.
Inherited from InputElement
Initialized EventHandler?
Occurs when the styled element has finished initialization.
Inherited from StyledElement
KeyDown EventHandler<KeyEventArgs>
Occurs when a key is pressed while the control has focus.
Inherited from InputElement
KeyUp EventHandler<KeyEventArgs>
Occurs when a key is released while the control has focus.
Inherited from InputElement
LayoutUpdated EventHandler?
Occurs when a layout pass completes for the control.
Inherited from Layoutable
LostFocus EventHandler<RoutedEventArgs>
Occurs when the control loses focus.
Inherited from InputElement
PointerCaptureLost EventHandler<PointerCaptureLostEventArgs>
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
PointerEnter EventHandler<PointerEventArgs>
Occurs when the pointer enters the control.
Inherited from InputElement
PointerLeave EventHandler<PointerEventArgs>
Occurs when the pointer leaves the control.
Inherited from InputElement
PointerMoved EventHandler<PointerEventArgs>
Occurs when the pointer moves over the control.
Inherited from InputElement
PointerPressed EventHandler<PointerPressedEventArgs>
Occurs when the pointer is pressed over the control.
Inherited from InputElement
PointerReleased EventHandler<PointerReleasedEventArgs>
Occurs when the pointer is released over the control.
Inherited from InputElement
PointerWheelChanged EventHandler<PointerWheelEventArgs>
Occurs when the mouse wheen is scrolled over the control.
Inherited from InputElement
Populated EventHandler<PopulatedEventArgs>
Occurs when the AutoCompleteBox has populated the drop-down with possible matches based on the Text property.
Populating EventHandler<PopulatingEventArgs>
Occurs when the AutoCompleteBox is populating the drop-down with possible matches based on the Text property.
PropertyChanged EventHandler<AvaloniaPropertyChangedEventArgs>
Raised when a AvaloniaProperty value changes on this object.
Inherited from AvaloniaObject
ResourcesChanged EventHandler<ResourcesChangedEventArgs>?
Occurs when a resource in this styled element or a parent styled element has changed.
Inherited from StyledElement
SelectionChanged EventHandler<SelectionChangedEventArgs>
Occurs when the selected item in the drop-down portion of the AutoCompleteBox has changed.
Tapped EventHandler<RoutedEventArgs>
Occurs when a tap gesture occurs on the control.
Inherited from InputElement
TemplateApplied EventHandler<TemplateAppliedEventArgs>
Raised when the control's template is applied.
Inherited from TemplatedControl
TextChanged EventHandler
Occurs when the text in the text box portion of the AutoCompleteBox changes.
TextInput EventHandler<TextInputEventArgs>
Occurs when a user typed some text while the control has focus.
Inherited from InputElement
TextInputMethodClientRequested EventHandler<TextInputMethodClientRequestedEventArgs>
Occurs when an input element gains input focus and input method is looking for the corresponding client
Inherited from InputElement
TextInputOptionsQuery EventHandler<TextInputOptionsQueryEventArgs>
Occurs when an input element gains input focus and input method is asking for required content options
Inherited from InputElement

Fields

Name Constant Value Summary
AsyncPopulatorProperty
static
BackgroundProperty
Defines the Background property.
Inherited from TemplatedControl
static
BorderBrushProperty
Defines the BorderBrush property.
Inherited from TemplatedControl
static
BorderThicknessProperty
Defines the BorderThickness property.
Inherited from TemplatedControl
static
BoundsProperty
Defines the Bounds property.
Inherited from Visual
static
ClipProperty
Defines the Clip property.
Inherited from Visual
static
ClipToBoundsProperty
Defines the ClipToBounds property.
Inherited from Visual
static
ClockProperty
Defines the Clock property.
Inherited from Animatable
static
ContextFlyoutProperty
Defines the ContextFlyout property
Inherited from Control
static
ContextMenuProperty
Defines the ContextMenu property.
Inherited from Control
static
CursorProperty
Gets or sets associated mouse cursor.
Inherited from InputElement
static
DataContextProperty
Defines the DataContext property.
Inherited from StyledElement
static
DesiredSizeProperty
Defines the DesiredSize property.
Inherited from Layoutable
static
DoubleTappedEvent
Defines the DoubleTapped event.
Inherited from InputElement
static
FilterModeProperty
Gets the identifier for the FilterMode dependency property.
static
FocusableProperty
Defines the Focusable property.
Inherited from InputElement
static
FocusAdornerProperty
Defines the FocusAdorner property.
Inherited from Control
static
FontFamilyProperty
Defines the FontFamily property.
Inherited from TemplatedControl
static
FontSizeProperty
Defines the FontSize property.
Inherited from TemplatedControl
static
FontStyleProperty
Defines the FontStyle property.
Inherited from TemplatedControl
static
FontWeightProperty
Defines the FontWeight property.
Inherited from TemplatedControl
static
ForegroundProperty
Defines the Foreground property.
Inherited from TemplatedControl
static
GotFocusEvent
Defines the GotFocus event.
Inherited from InputElement
static
HeightProperty
Defines the Height property.
Inherited from Layoutable
static
HorizontalAlignmentProperty
Defines the HorizontalAlignment property.
Inherited from Layoutable
static
IsDropDownOpenProperty
Identifies the IsDropDownOpen dependency property.
static
IsEffectivelyEnabledProperty
Defines the IsEffectivelyEnabled property.
Inherited from InputElement
static
IsEnabledProperty
Defines the IsEnabled property.
Inherited from InputElement
static
IsFocusedProperty
Defines the IsFocused property.
Inherited from InputElement
static
IsHitTestVisibleProperty
Defines the IsHitTestVisible property.
Inherited from InputElement
static
IsKeyboardFocusWithinProperty
Defines the IsKeyboardFocusWithin property.
Inherited from InputElement
static
IsPointerOverProperty
Defines the IsPointerOver property.
Inherited from InputElement
static
IsTemplateFocusTargetProperty
Defines the IsTemplateFocusTarget attached property.
Inherited from TemplatedControl
static
IsTextCompletionEnabledProperty
Identifies the IsTextCompletionEnabled dependency property.
static
IsVisibleProperty
Defines the IsVisibleProperty property.
Inherited from Visual
static
ItemFilterProperty
Identifies the ItemFilter dependency property.
static
ItemSelectorProperty
Identifies the ItemSelector dependency property.
static
ItemsProperty
Identifies the Avalonia.Controls.AutoCompleteBox.ItemsSource dependency property.
static
ItemTemplateProperty
Identifies the ItemTemplate dependency property.
static
KeyDownEvent
Defines the KeyDown event.
Inherited from InputElement
static
KeyUpEvent
Defines the KeyUp event.
Inherited from InputElement
static
LostFocusEvent
Defines the LostFocus event.
Inherited from InputElement
static
MarginProperty
Defines the Margin property.
Inherited from Layoutable
static
MaxDropDownHeightProperty
Identifies the MaxDropDownHeight dependency property.
static
MaxHeightProperty
Defines the MaxHeight property.
Inherited from Layoutable
static
MaxWidthProperty
Defines the MaxWidth property.
Inherited from Layoutable
static
MinHeightProperty
Defines the MinHeight property.
Inherited from Layoutable
static
MinimumPopulateDelayProperty
Identifies the MinimumPopulateDelay dependency property.
static
MinimumPrefixLengthProperty
Identifies the MinimumPrefixLength dependency property.
static
MinWidthProperty
Defines the MinWidth property.
Inherited from Layoutable
static
NameProperty
Defines the Name property.
Inherited from StyledElement
static
OpacityMaskProperty
Defines the OpacityMask property.
Inherited from Visual
static
OpacityProperty
Defines the Opacity property.
Inherited from Visual
static
PaddingProperty
Defines the Padding property.
Inherited from TemplatedControl
static
ParentProperty
Defines the Parent property.
Inherited from StyledElement
static
PointerCaptureLostEvent
Defines the PointerCaptureLost routed event.
Inherited from InputElement
static
PointerEnterEvent
Defines the PointerEnter event.
Inherited from InputElement
static
PointerLeaveEvent
Defines the PointerLeave event.
Inherited from InputElement
static
PointerMovedEvent
Defines the PointerMoved event.
Inherited from InputElement
static
PointerPressedEvent
Defines the PointerPressed event.
Inherited from InputElement
static
PointerReleasedEvent
Defines the PointerReleased event.
Inherited from InputElement
static
PointerWheelChangedEvent
Defines the PointerWheelChanged event.
Inherited from InputElement
static
RenderTransformOriginProperty
Defines the RenderTransformOrigin property.
Inherited from Visual
static
RenderTransformProperty
Defines the RenderTransform property.
Inherited from Visual
static
RequestBringIntoViewEvent
Event raised when an element wishes to be scrolled into view.
Inherited from Control
static
SearchTextProperty
Identifies the SearchText dependency property.
static
SelectedItemProperty
Identifies the SelectedItem dependency property.
static
SelectionChangedEvent
static
TagProperty
Defines the Tag property.
Inherited from Control
static
TappedEvent
Defines the Tapped event.
Inherited from InputElement
static
TemplateAppliedEvent
Defines the TemplateApplied routed event.
Inherited from TemplatedControl
static
TemplatedParentProperty
Defines the TemplatedParent property.
Inherited from StyledElement
static
TemplateProperty
Defines the Template property.
Inherited from TemplatedControl
static
TextFilterProperty
Identifies the TextFilter dependency property.
static
TextInputEvent
Defines the TextInput event.
Inherited from InputElement
static
TextInputMethodClientRequestedEvent
Defines the TextInputMethodClientRequested event.
Inherited from InputElement
static
TextInputOptionsQueryEvent
Defines the TextInputOptionsQuery event.
Inherited from InputElement
static
TextProperty
Identifies the Text dependency property.
static
TextSelectorProperty
Identifies the TextSelector dependency property.
static
TransformedBoundsProperty
Inherited from Visual
static
TransitionsProperty
Defines the Transitions property.
Inherited from Animatable
static
UseLayoutRoundingProperty
Defines the UseLayoutRoundingProperty property.
Inherited from Layoutable
static
VerticalAlignmentProperty
Defines the VerticalAlignment property.
Inherited from Layoutable
static
VisualParentProperty
Defines the VisualParent property.
Inherited from Visual
static
WatermarkProperty
static
WidthProperty
Defines the Width property.
Inherited from Layoutable
static
ZIndexProperty
Defines the ZIndex property.
Inherited from Visual
static

Properties

Name Value Summary
AsyncPopulator Func<string, CancellationToken, Task<IEnumerable<object>>>
Background IBrush
Gets or sets the brush used to draw the control's background.
Inherited from TemplatedControl
BorderBrush IBrush
Gets or sets the brush used to draw the control's border.
Inherited from TemplatedControl
BorderThickness Thickness
Gets or sets the thickness of the control's border.
Inherited from TemplatedControl
Bounds Rect
Gets the bounds of the control relative to its parent.
Inherited from Visual
Classes Classes
Gets or sets the styled element's classes.
Inherited from StyledElement
Clip Geometry
Gets or sets the geometry clip for this visual.
Inherited from Visual
ClipToBounds bool
Gets or sets a value indicating whether the control should be clipped to its bounds.
Inherited from Visual
Clock IClock
Gets or sets the clock which controls the animations on the control.
Inherited from Animatable
ContextFlyout FlyoutBase?
Gets or sets a context flyout to the control
Inherited from Control
ContextMenu ContextMenu?
Gets or sets a context menu to the control.
Inherited from Control
Cursor Cursor?
Gets or sets associated mouse cursor.
Inherited from InputElement
DataContext object?
Gets or sets the control's data context.
Inherited from StyledElement
DataTemplates DataTemplates
Gets or sets the data templates for the control.
Inherited from Control
DesiredSize Size
Gets the size that this element computed during the measure pass of the layout process.
Inherited from Layoutable
FilterMode AutoCompleteFilterMode
Gets or sets how the text in the text box is used to filter items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource property for display in the drop-down.
Focusable bool
Gets or sets a value indicating whether the control can receive focus.
Inherited from InputElement
FocusAdorner ITemplate<IControl>?
Gets or sets the control's focus adorner.
Inherited from Control
FontFamily FontFamily
Gets or sets the font family used to draw the control's text.
Inherited from TemplatedControl
FontSize double
Gets or sets the size of the control's text in points.
Inherited from TemplatedControl
FontStyle FontStyle
Gets or sets the font style used to draw the control's text.
Inherited from TemplatedControl
FontWeight FontWeight
Gets or sets the font weight used to draw the control's text.
Inherited from TemplatedControl
Foreground IBrush
Gets or sets the brush used to draw the control's text and other foreground elements.
Inherited from TemplatedControl
GestureRecognizers GestureRecognizerCollection
Inherited from InputElement
Height double
Gets or sets the height of the element.
Inherited from Layoutable
HorizontalAlignment HorizontalAlignment
Gets or sets the element's preferred horizontal alignment in its parent.
Inherited from Layoutable
InheritanceParent IAvaloniaObject
Gets or sets the parent object that inherited AvaloniaProperty values are inherited from.
Inherited from AvaloniaObject
IsArrangeValid bool
Gets a value indicating whether the control's layouts arrange is valid.
Inherited from Layoutable
IsDropDownOpen bool
Gets or sets a value indicating whether the drop-down portion of the control is open.
IsEffectivelyEnabled bool
Gets a value indicating whether this control and all its parents are enabled.
Inherited from InputElement
IsEffectivelyVisible bool
Gets a value indicating whether this control and all its parents are visible.
Inherited from Visual
IsEnabled bool
Gets or sets a value indicating whether the control is enabled for user interaction.
Inherited from InputElement
IsEnabledCore bool
Allows a derived class to override the enabled state of the control.
Inherited from InputElement
IsFocused bool
Gets a value indicating whether the control is focused.
Inherited from InputElement
IsHitTestVisible bool
Gets or sets a value indicating whether the control is considered for hit testing.
Inherited from InputElement
IsInitialized bool
Gets a value that indicates whether the element has finished initialization.
Inherited from StyledElement
IsKeyboardFocusWithin bool
Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.
Inherited from InputElement
IsMeasureValid bool
Gets a value indicating whether the control's layout measure is valid.
Inherited from Layoutable
IsPointerOver bool
Gets a value indicating whether the pointer is currently over the control.
Inherited from InputElement
IsTextCompletionEnabled bool
Gets or sets a value indicating whether the first possible match found during the filtering process will be displayed automatically in the text box.
IsVisible bool
Gets or sets a value indicating whether this control is visible.
Inherited from Visual
ItemFilter AutoCompleteFilterPredicate<object>
Gets or sets the custom method that uses user-entered text to filter the items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource property for display in the drop-down.
Items IEnumerable
Gets or sets a collection that is used to generate the items for the drop-down portion of the AutoCompleteBox control.
ItemSelector AutoCompleteSelector<object>
Gets or sets the custom method that combines the user-entered text and one of the items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource.
ItemTemplate IDataTemplate
Gets or sets the Avalonia.DataTemplate used to display each item in the drop-down portion of the control.
KeyBindings List<KeyBinding>
Inherited from InputElement
LogicalChildren IAvaloniaList<ILogical>
Gets the styled element's logical children.
Inherited from StyledElement
Margin Thickness
Gets or sets the margin around the element.
Inherited from Layoutable
MaxDropDownHeight double
Gets or sets the maximum height of the drop-down portion of the AutoCompleteBox control.
MaxHeight double
Gets or sets the maximum height of the element.
Inherited from Layoutable
MaxWidth double
Gets or sets the maximum width of the element.
Inherited from Layoutable
MinHeight double
Gets or sets the minimum height of the element.
Inherited from Layoutable
MinimumPopulateDelay TimeSpan
Gets or sets the minimum delay, after text is typed in the text box before the AutoCompleteBox control populates the list of possible matches in the drop-down.
MinimumPrefixLength int
Gets or sets the minimum number of characters required to be entered in the text box before the AutoCompleteBox displays possible matches. matches.
MinWidth double
Gets or sets the minimum width of the element.
Inherited from Layoutable
Name string?
Gets or sets the name of the styled element.
Inherited from StyledElement
Opacity double
Gets or sets the opacity of the control.
Inherited from Visual
OpacityMask IBrush
Gets or sets the opacity mask of the control.
Inherited from Visual
Padding Thickness
Gets or sets the padding placed between the border of the control and its content.
Inherited from TemplatedControl
Parent IControl?
Inherited from Control
Parent IStyledElement?
Gets the styled element's logical parent.
Inherited from StyledElement
PseudoClasses IPseudoClasses
Gets the Classes collection in a form that allows adding and removing pseudoclasses.
Inherited from StyledElement
RenderTransform ITransform
Gets or sets the render transform of the control.
Inherited from Visual
RenderTransformOrigin RelativePoint
Gets or sets the transform origin of the control.
Inherited from Visual
Resources IResourceDictionary
Gets or sets the styled element's resource dictionary.
Inherited from StyledElement
SearchText string
Gets the text that is used to filter items in the Avalonia.Controls.AutoCompleteBox.ItemsSource item collection.
SelectedItem object
Gets or sets the selected item in the drop-down.
SelectionAdapter ISelectionAdapter
Gets or sets the selection adapter used to populate the drop-down with a list of selectable items.
Styles Styles
Gets the styles for the styled element.
Inherited from StyledElement
Tag object?
Gets or sets a user-defined object attached to the control.
Inherited from Control
Template IControlTemplate
Gets or sets the template that defines the control's appearance.
Inherited from TemplatedControl
TemplatedParent ITemplatedControl?
Gets the styled element whose lookless template this styled element is part of.
Inherited from StyledElement
Text string
Gets or sets the text in the text box portion of the AutoCompleteBox control.
TextFilter AutoCompleteFilterPredicate<string>
Gets or sets the custom method that uses the user-entered text to filter items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource property in a text-based way for display in the drop-down.
TextSelector AutoCompleteSelector<string>
Gets or sets the custom method that combines the user-entered text and one of the items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource in a text-based way.
this[AvaloniaProperty] object
Gets or sets the value of a AvaloniaProperty.
Inherited from AvaloniaObject
this[IndexerDescriptor] IBinding
Gets or sets a binding for a AvaloniaProperty.
Inherited from AvaloniaObject
TransformedBounds TransformedBounds?
Gets the bounds of the control relative to the window, accounting for rendering transforms.
Inherited from Visual
Transitions Transitions?
Gets or sets the property transitions for the control.
Inherited from Animatable
UseLayoutRounding bool
Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time.
Inherited from Layoutable
ValueMemberBinding IBinding
Gets or sets the Binding that is used to get the values for display in the text portion of the AutoCompleteBox control.
VerticalAlignment VerticalAlignment
Gets or sets the element's preferred vertical alignment in its parent.
Inherited from Layoutable
VisualChildren IAvaloniaList<IVisual>
Gets the control's child visuals.
Inherited from Visual
VisualRoot IRenderRoot
Gets the root of the visual tree, if the control is attached to a visual tree.
Inherited from Visual
Watermark string
Width double
Gets or sets the width of the element.
Inherited from Layoutable
ZIndex int
Gets or sets the Z index of the control.
Inherited from Visual

Methods

Name Value Summary
AddHandler(RoutedEvent, Delegate, RoutingStrategies, bool) void
Adds a handler for the specified routed event.
Inherited from Interactive
AddHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool) void
Adds a handler for the specified routed event.
Inherited from Interactive
AffectsArrange(AvaloniaProperty[]) void
Marks a property as affecting the control's arrangement.
Inherited from Layoutable
static
AffectsArrange<T>(AvaloniaProperty[]) void
Marks a property as affecting the control's arrangement.
Inherited from Layoutable
static
AffectsMeasure(AvaloniaProperty[]) void
Marks a property as affecting the control's measurement.
Inherited from Layoutable
static
AffectsMeasure<T>(AvaloniaProperty[]) void
Marks a property as affecting the control's measurement.
Inherited from Layoutable
static
AffectsRender(AvaloniaProperty[]) void
Indicates that a property change should cause InvalidateVisual() to be called.
Inherited from Visual
static
AffectsRender<T>(AvaloniaProperty[]) void
Indicates that a property change should cause InvalidateVisual() to be called.
Inherited from Visual
static
ApplyStyling() bool
Applies styling to the control if the control is initialized and styling is not already applied.
Inherited from StyledElement
ApplyTemplate() void
Creates the visual children of the control, if necessary
Inherited from TemplatedControl
Arrange(Rect) void
Arranges the control and its children.
Inherited from Layoutable
ArrangeCore(Rect) void
The default implementation of the control's arrange pass.
Inherited from Layoutable
ArrangeOverride(Size) Size
Positions child elements as part of a layout pass.
Inherited from Layoutable
BeginBatchUpdate() void
Inherited from AvaloniaObject
BeginInit() void
Inherited from StyledElement
Bind<T>(DirectPropertyBase<T>, IObservable<BindingValue<T>>) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
Bind<T>(StyledPropertyBase<T>, IObservable<BindingValue<T>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
BuildEventRoute(RoutedEvent) EventRoute
Builds an event route for a routed event.
Inherited from Interactive
CheckAccess() bool
Inherited from AvaloniaObject
ClearValue(AvaloniaProperty) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
ClearValue<T>(AvaloniaProperty<T>) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
ClearValue<T>(DirectPropertyBase<T>) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
ClearValue<T>(StyledPropertyBase<T>) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
CoerceValue<T>(StyledPropertyBase<T>) void
Coerces the specified AvaloniaProperty.
Inherited from AvaloniaObject
DisableTransitions() void
Disables transitions for the control.
Inherited from Animatable
EnableTransitions() void
Enables transitions for the control.
Inherited from Animatable
EndBatchUpdate() void
Inherited from AvaloniaObject
EndInit() void
Inherited from StyledElement
Equals(object) bool
Compares two objects using reference equality.
Inherited from AvaloniaObject
Focus() void
Focuses the control.
Inherited from InputElement
FormatValue(object) string
Converts the specified object to a string by using the Avalonia.Data.Binding.Converter and Avalonia.Data.Binding.ConverterCulture values of the binding object specified by the ValueMemberBinding property.
GetBaseValue<T>(StyledPropertyBase<T>, BindingPriority) Optional<T>
Gets an AvaloniaProperty base value.
Inherited from AvaloniaObject
GetHashCode() int
Gets the hash code for the object.
Inherited from AvaloniaObject
GetIsTemplateFocusTarget(Control) bool
Gets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
static
GetSelectionAdapterPart(INameScope) ISelectionAdapter
Returns the Avalonia.Controls.ISelectionAdapter part, if possible.
GetTemplateFocusTarget() IControl
Gets the element that receives the focus adorner.
Inherited from TemplatedControl
GetValue(AvaloniaProperty) object
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
GetValue<T>(DirectPropertyBase<T>) T
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
GetValue<T>(StyledPropertyBase<T>) T
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
HasFocus() bool
Determines whether the text box or drop-down portion of the AutoCompleteBox control has focus.
InitializeIfNeeded() void
Inherited from StyledElement
InvalidateArrange() void
Invalidates the arrangement of the control and queues a new layout pass.
Inherited from Layoutable
InvalidateMeasure() void
Invalidates the measurement of the control and queues a new layout pass.
Inherited from Layoutable
InvalidateStyles() void
Inherited from Layoutable
InvalidateVisual() void
Invalidates the visual and queues a repaint.
Inherited from Visual
IsAnimating(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is animating.
Inherited from AvaloniaObject
IsSet(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is set on this object.
Inherited from AvaloniaObject
LogicalChildrenCollectionChanged(object, NotifyCollectionChangedEventArgs) void
Inherited from Visual
Measure(Size) void
Carries out a measure of the control.
Inherited from Layoutable
MeasureCore(Size) Size
The default implementation of the control's measure pass.
Inherited from Layoutable
MeasureOverride(Size) Size
Measures the control and its child elements as part of a layout pass.
Inherited from Layoutable
NotifyChildResourcesChanged(ResourcesChangedEventArgs) void
Inherited from TemplatedControl
OnApplyTemplate(TemplateAppliedEventArgs) void
Builds the visual tree for the AutoCompleteBox control when a new template is applied.
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) void
Called when the styled element is added to a rooted logical tree.
Inherited from TemplatedControl
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) void
Called when the control is added to a rooted visual tree.
Inherited from Visual
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) void
Inherited from Control
OnDataContextBeginUpdate() void
Called when the DataContext begins updating.
Inherited from StyledElement
OnDataContextChanged(EventArgs) void
Called when the DataContext property changes.
Inherited from StyledElement
OnDataContextEndUpdate() void
Called when the DataContext finishes updating.
Inherited from StyledElement
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) void
Called when the styled element is removed from a rooted logical tree.
Inherited from TemplatedControl
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) void
Called when the control is removed from a rooted visual tree.
Inherited from Visual
OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs) void
Inherited from Control
OnDropDownClosed(EventArgs) void
Raises the DropDownClosed event.
OnDropDownClosing(CancelEventArgs) void
Raises the DropDownClosing event.
OnDropDownOpened(EventArgs) void
Raises the DropDownOpened event.
OnDropDownOpening(CancelEventArgs) void
Raises the DropDownOpening event.
OnGotFocus(GotFocusEventArgs) void
Provides handling for the Avalonia.UIElement.GotFocus event.
OnInitialized() void
Called when the control finishes initialization.
Inherited from StyledElement
OnKeyDown(KeyEventArgs) void
Provides handling for the Avalonia.InputElement.KeyDown event.
OnKeyUp(KeyEventArgs) void
Called before the KeyUp event occurs.
Inherited from InputElement
OnLostFocus(RoutedEventArgs) void
Provides handling for the Avalonia.UIElement.LostFocus event.
OnMeasureInvalidated() void
Called by InvalidateMeasure
Inherited from Layoutable
OnPointerCaptureLost(PointerCaptureLostEventArgs) void
Called before the PointerCaptureLost event occurs.
Inherited from InputElement
OnPointerEnter(PointerEventArgs) void
Called before the PointerEnter event occurs.
Inherited from InputElement
OnPointerLeave(PointerEventArgs) void
Called before the PointerLeave event occurs.
Inherited from InputElement
OnPointerMoved(PointerEventArgs) void
Called before the PointerMoved event occurs.
Inherited from InputElement
OnPointerPressed(PointerPressedEventArgs) void
Called before the PointerPressed event occurs.
Inherited from InputElement
OnPointerReleased(PointerReleasedEventArgs) void
Called before the PointerReleased event occurs.
Inherited from InputElement
OnPointerWheelChanged(PointerWheelEventArgs) void
Called before the PointerWheelChanged event occurs.
Inherited from InputElement
OnPopulated(PopulatedEventArgs) void
Raises the Populated event.
OnPopulating(PopulatingEventArgs) void
Raises the Populating event.
OnPropertyChanged<T>(AvaloniaPropertyChangedEventArgs<T>) void
Inherited from InputElement
OnPropertyChangedCore<T>(AvaloniaPropertyChangedEventArgs<T>) void
Inherited from Animatable
OnSelectionChanged(SelectionChangedEventArgs) void
Raises the SelectionChanged event.
OnTemplateApplied(TemplateAppliedEventArgs) void
Called when the control's template is applied.
Inherited from TemplatedControl
OnTemplateChanged(AvaloniaPropertyChangedEventArgs) void
Called when the Template property changes.
Inherited from TemplatedControl
OnTextChanged(RoutedEventArgs) void
Raises the TextChanged event.
OnTextInput(TextInputEventArgs) void
Called before the TextInput event occurs.
Inherited from InputElement
OnVisualParentChanged(IVisual, IVisual) void
Called when the control's visual parent changes.
Inherited from Layoutable
PopulateComplete() void
Notifies the AutoCompleteBox that the Items property has been set and the data can be filtered to provide possible matches in the drop-down.
RaiseEvent(RoutedEventArgs) void
Raises a routed event.
Inherited from Interactive
RemoveHandler(RoutedEvent, Delegate) void
Removes a handler for the specified routed event.
Inherited from Interactive
RemoveHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>) void
Removes a handler for the specified routed event.
Inherited from Interactive
Render(DrawingContext) void
Renders the visual to a DrawingContext.
Inherited from Visual
SetIsTemplateFocusTarget(Control, bool) void
Sets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
static
SetValue(AvaloniaProperty, object, BindingPriority) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
SetValue<T>(DirectPropertyBase<T>, T) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
SetValue<T>(StyledPropertyBase<T>, T, BindingPriority) IDisposable
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
UpdateDataValidation<T>(AvaloniaProperty<T>, BindingValue<T>) void
Called to update the validation state for properties for which data validation is enabled.
UpdateIsEffectivelyEnabled() void
Updates the IsEffectivelyEnabled property value according to the parent control's enabled state and IsEnabledCore.
Inherited from InputElement
VerifyAccess() void
Inherited from AvaloniaObject

Extension Methods

Name Value Summary
AddDisposableHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool) IDisposable
Adds a handler for the specified routed event and returns a disposable that can terminate the event subscription.
Bind(AvaloniaProperty, IObservable<BindingValue<object>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Bind<T>(AvaloniaProperty<T>, IObservable<BindingValue<T>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
BindClass(string, IBinding, object) IDisposable
BringIntoView() void
Tries to bring the control into view.
BringIntoView(Rect) void
Tries to bring the control into view.
CalculateDistanceFromAncestor(IVisual) int
Calculates the distance from a visual's ancestor.
Find<T>(string) T
Finds a named element in an INameScope.
FindAncestorOfType<T>(bool) T
Finds first ancestor of given type.
FindCommonVisualAncestor(IVisual) IVisual
Tries to get the first common ancestor of two visuals.
FindControl<T>(string) T
Finds the named control in the scope of the specified control.
FindDataTemplate(object, IDataTemplate?) IDataTemplate?
Find a data template that matches a piece of data.
FindDescendantOfType<T>(bool) T
Finds first descendant of given type.
FindLogicalAncestorOfType<T>(bool) T
Finds first ancestor of given type.
FindLogicalDescendantOfType<T>(bool) T
Finds first descendant of given type.
FindNameScope() INameScope
FindResource(object) object?
Finds the specified resource by searching up the logical tree and then global styles.
Get<T>(string) T
Gets a named element from an INameScope or throws if no element of the requested name was found.
GetBindingObservable(AvaloniaProperty) IObservable<BindingValue<object>>
Gets an observable for a AvaloniaProperty.
GetBindingObservable<T>(AvaloniaProperty<T>) IObservable<BindingValue<T>>
Gets an observable for a AvaloniaProperty.
GetBindingSubject(AvaloniaProperty, BindingPriority) ISubject<BindingValue<object>>
Gets a subject for a AvaloniaProperty.
GetBindingSubject<T>(AvaloniaProperty<T>, BindingPriority) ISubject<BindingValue<T>>
Gets a subject for a AvaloniaProperty.
GetDiagnostic(AvaloniaProperty) AvaloniaPropertyValue
Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject.
GetInputElementsAt(Point) IEnumerable<IInputElement>
Returns the active input elements at a point on an IInputElement.
GetLogicalAncestors() IEnumerable<ILogical>
Enumerates the ancestors of an ILogical in the logical tree.
GetLogicalChildren() IEnumerable<ILogical>
Enumerates the children of an ILogical in the logical tree.
GetLogicalDescendants() IEnumerable<ILogical>
Enumerates the descendants of an ILogical in the logical tree.
GetLogicalParent() ILogical
Gets the logical parent of an ILogical.
GetLogicalParent<T>() T
Gets the logical parent of an ILogical.
GetLogicalSiblings() IEnumerable<ILogical>
Enumerates the siblings of an ILogical in the logical tree.
GetObservable(AvaloniaProperty) IObservable<object>
Gets an observable for a AvaloniaProperty.
GetObservable<T>(AvaloniaProperty<T>) IObservable<T>
Gets an observable for a AvaloniaProperty.
GetObservable<TEventArgs>(RoutedEvent<TEventArgs>, RoutingStrategies, bool) IObservable<TEventArgs>
Gets an observable for a RoutedEvent<TEventArgs>.
GetPropertyChangedObservable(AvaloniaProperty) IObservable<AvaloniaPropertyChangedEventArgs>
Gets an observable that listens for property changed events for an AvaloniaProperty.
GetResourceObservable(object, Func<object?, object?>?) IObservable<object?>
GetSelfAndLogicalAncestors() IEnumerable<ILogical>
Enumerates an ILogical and its ancestors in the logical tree.
GetSelfAndLogicalDescendants() IEnumerable<ILogical>
Enumerates an ILogical and its descendants in the logical tree.
GetSelfAndVisualAncestors() IEnumerable<IVisual>
Enumerates an IVisual and its ancestors in the visual tree.
GetSelfAndVisualDescendants() IEnumerable<IVisual>
Enumerates an IVisual and its descendants in the visual tree.
GetStyleDiagnostics() StyleDiagnostics
Gets a style diagnostics for a StyledElement.
GetSubject(AvaloniaProperty, BindingPriority) ISubject<object>
Gets a subject for a AvaloniaProperty.
GetSubject<T>(AvaloniaProperty<T>, BindingPriority) ISubject<T>
Gets a subject for a AvaloniaProperty.
GetTemplateChildren() IEnumerable<IControl>
GetVisualAncestors() IEnumerable<IVisual>
Enumerates the ancestors of an IVisual in the visual tree.
GetVisualAt(Point) IVisual
Gets the first visual in the visual tree whose bounds contain a point.
GetVisualAt(Point, Func<IVisual, bool>) IVisual
Gets the first visual in the visual tree whose bounds contain a point.
GetVisualChildren() IEnumerable<IVisual>
Enumerates the children of an IVisual in the visual tree.
GetVisualDescendants() IEnumerable<IVisual>
Enumerates the descendants of an IVisual in the visual tree.
GetVisualParent() IVisual
Gets the visual parent of an IVisual.
GetVisualParent<T>() T
Gets the visual parent of an IVisual.
GetVisualRoot() IRenderRoot
Gets the root visual for an IVisual.
GetVisualsAt(Point) IEnumerable<IVisual>
Enumerates the visible visuals in the visual tree whose bounds contain a point.
GetVisualsAt(Point, Func<IVisual, bool>) IEnumerable<IVisual>
Enumerates the visuals in the visual tree whose bounds contain a point.
HitTestCustom(Point) bool
InputHitTest(Point) IInputElement?
Returns the topmost active input element at a point on an IInputElement.
InputHitTest(Point, Func<IVisual, bool>) IInputElement?
Returns the topmost active input element at a point on an IInputElement.
IsLogicalAncestorOf(ILogical) bool
Tests whether an ILogical is an ancestor of another logical.
IsVisualAncestorOf(IVisual) bool
Tests whether an IVisual is an ancestor of another visual.
PointToClient(PixelPoint) Point
Converts a point from screen to client coordinates.
PointToScreen(Point) PixelPoint
Converts a point from client to screen coordinates.
RegisterInNameScope<AutoCompleteBox>(INameScope) T
TransformToVisual(IVisual) Matrix?
Returns a transform that transforms the visual's coordinates into the coordinates of the specified to.
TranslatePoint(Point, IVisual) Point?
Translates a point relative to this visual to coordinates that are relative to the specified visual.
TryFindResource(object, object?) bool
Tries to the specified resource by searching up the logical tree and then global styles.