AutoCompleteBox Class
Definition
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.
public class AutoCompleteBox
Constructors
| Name | Description |
|---|---|
| AutoCompleteBox | Initializes a new instance of the Avalonia.Controls.AutoCompleteBox class. |
AutoCompleteBox Constructor
Initializes a new instance of the Avalonia.Controls.AutoCompleteBox class.
public AutoCompleteBox()
Methods
| Name | Description |
|---|---|
| PopulateComplete | Notifies the Avalonia.Controls.AutoCompleteBox that the Avalonia.Controls.AutoCompleteBox.Items property has been set and the data can be filtered to provide possible matches in the drop-down. |
| 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. |
PopulateComplete Method
Notifies the Avalonia.Controls.AutoCompleteBox that the Avalonia.Controls.AutoCompleteBox.Items property has been set and the data can be filtered to provide possible matches in the drop-down.
public void PopulateComplete()
Remarks
Call this method when you are providing custom population of the drop-down portion of the AutoCompleteBox, to signal the control that you are done with the population process. Typically, you use PopulateComplete when the population process is a long-running process and you want to cancel built-in filtering of the ItemsSource items. In this case, you can handle the Populated event and set PopulatingEventArgs.Cancel to true. When the long-running process has completed you call PopulateComplete to indicate the drop-down is populated.
Properties
| Name | Description |
|---|---|
| AsyncPopulator | No summary available. |
| CaretIndex | Gets or sets the caret index |
| ClearSelectionOnLostFocus | Gets or sets a value that determines whether the Avalonia.Controls.AutoCompleteBox clears its selection after it loses focus. |
| FilterMode | 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. |
| 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 |
| IsDropDownOpen | Gets or sets a value indicating whether the drop-down portion of the control is open. |
| IsTextCompletionEnabled | Gets or sets a value indicating whether the first possible match found during the filtering process will be displayed automatically in the text box. |
| ItemFilter | 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. |
| ItemSelector | 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 | Gets or sets the Avalonia.DataTemplate used to display each item in the drop-down portion of the control. |
| ItemsSource | Gets or sets a collection that is used to generate the items for the drop-down portion of the Avalonia.Controls.AutoCompleteBox control. |
| MaxDropDownHeight | Gets or sets the maximum height of the drop-down portion of the Avalonia.Controls.AutoCompleteBox control. |
| MaxLength | Gets or sets the maximum number of characters that the Avalonia.Controls.AutoCompleteBox can accept. This constraint only applies for manually entered (user-inputted) text. |
| MinimumPopulateDelay | Gets or sets the minimum delay, after text is typed in the text box before the Avalonia.Controls.AutoCompleteBox control populates the list of possible matches in the drop-down. |
| MinimumPrefixLength | Gets or sets the minimum number of characters required to be entered in the text box before the Avalonia.Controls.AutoCompleteBox displays possible matches. |
| 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 text is not yet set. |
| SearchText | Gets the text that is used to filter items in the Avalonia.Controls.AutoCompleteBox.ItemsSource item collection. |
| SelectedItem | Gets or sets the selected item in the drop-down. |
| Text | Gets or sets the text in the text box portion of the Avalonia.Controls.AutoCompleteBox control. |
| TextFilter | 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 | 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. |
| ValueMemberBinding | Gets or sets the Avalonia.Data.BindingBase that is used to get the values for display in the text portion of the Avalonia.Controls.AutoCompleteBox control. |
| Watermark | Gets or sets the placeholder or descriptive text that is displayed even if the text 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. |
AsyncPopulator Property
public Func<string, System.Threading.CancellationToken, System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>>> AsyncPopulator { get; set; }
CaretIndex Property
Gets or sets the caret index
public int CaretIndex { get; set; }
ClearSelectionOnLostFocus Property
Gets or sets a value that determines whether the Avalonia.Controls.AutoCompleteBox clears its selection after it loses focus.
public bool ClearSelectionOnLostFocus { get; set; }
FilterMode Property
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.
public Avalonia.Controls.AutoCompleteFilterMode FilterMode { get; set; }
Value
One of the Avalonia.Controls.AutoCompleteFilterMode values The default is Avalonia.Controls.AutoCompleteFilterMode.StartsWith.
Remarks
Use the FilterMode property to specify how possible matches are filtered. For example, possible matches can be filtered in a predefined or custom way. The search mode is automatically set to Custom if you set the ItemFilter property.
Exceptions
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; }
IsDropDownOpen Property
Gets or sets a value indicating whether the drop-down portion of the control is open.
public bool IsDropDownOpen { get; set; }
Value
True if the drop-down is open; otherwise, false. The default is false.
IsTextCompletionEnabled Property
Gets or sets a value indicating whether the first possible match found during the filtering process will be displayed automatically in the text box.
public bool IsTextCompletionEnabled { get; set; }
Value
True if the first possible match found will be displayed automatically in the text box; otherwise, false. The default is false.
ItemFilter Property
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.
public Avalonia.Controls.AutoCompleteFilterPredicate<T><object> ItemFilter { get; set; }
Value
The custom method that uses the user-entered text to filter the items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource property. The default is null.
Remarks
The filter mode is automatically set to Custom if you set the ItemFilter property.
ItemSelector Property
Gets or sets the custom method that combines the user-entered text and one of the items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource.
public Avalonia.Controls.AutoCompleteSelector<T><object> ItemSelector { get; set; }
Value
The custom method that combines the user-entered text and one of the items specified by the Avalonia.Controls.AutoCompleteBox.ItemsSource.
ItemTemplate Property
Gets or sets the Avalonia.DataTemplate used to display each item in the drop-down portion of the control.
public Avalonia.Controls.Templates.IDataTemplate ItemTemplate { get; set; }
Value
The Avalonia.DataTemplate used to display each item in the drop-down. The default is null.
Remarks
You use the ItemTemplate property to specify the visualization of the data objects in the drop-down portion of the AutoCompleteBox control. If your AutoCompleteBox is bound to a collection and you do not provide specific display instructions by using a DataTemplate, the resulting UI of each item is a string representation of each object in the underlying collection.
ItemsSource Property
Gets or sets a collection that is used to generate the items for the drop-down portion of the Avalonia.Controls.AutoCompleteBox control.
public System.Collections.IEnumerable ItemsSource { get; set; }
Value
The collection that is used to generate the items of the drop-down portion of the Avalonia.Controls.AutoCompleteBox control.
MaxDropDownHeight Property
Gets or sets the maximum height of the drop-down portion of the Avalonia.Controls.AutoCompleteBox control.
public double MaxDropDownHeight { get; set; }
Value
The maximum height of the drop-down portion of the Avalonia.Controls.AutoCompleteBox control. The default is double.PositiveInfinity.
Exceptions
MaxLength Property
Gets or sets the maximum number of characters that the Avalonia.Controls.AutoCompleteBox can accept. This constraint only applies for manually entered (user-inputted) text.
public int MaxLength { get; set; }
MinimumPopulateDelay Property
Gets or sets the minimum delay, after text is typed in the text box before the Avalonia.Controls.AutoCompleteBox control populates the list of possible matches in the drop-down.
public TimeSpan MinimumPopulateDelay { get; set; }
Value
The minimum delay, after text is typed in the text box, but before the Avalonia.Controls.AutoCompleteBox populates the list of possible matches in the drop-down. The default is 0.
MinimumPrefixLength Property
Gets or sets the minimum number of characters required to be entered in the text box before the Avalonia.Controls.AutoCompleteBox displays possible matches.
public int MinimumPrefixLength { get; set; }
Value
The minimum number of characters to be entered in the text box before the Avalonia.Controls.AutoCompleteBox displays possible matches. The default is 1.
Remarks
If you set MinimumPrefixLength to -1, the AutoCompleteBox will not provide possible matches. There is no maximum value, but setting MinimumPrefixLength to value that is too large will prevent the AutoCompleteBox from providing possible matches as well.
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 text is not yet set.
public string PlaceholderText { get; set; }
SearchText Property
Gets the text that is used to filter items in the Avalonia.Controls.AutoCompleteBox.ItemsSource item collection.
public string SearchText { get; set; }
Value
The text that is used to filter items in the Avalonia.Controls.AutoCompleteBox.ItemsSource item collection.
Remarks
The SearchText value is typically the same as the Text property, but is set after the TextChanged event occurs and before the Populating event.
SelectedItem Property
Gets or sets the selected item in the drop-down.
public object SelectedItem { get; set; }
Value
The selected item in the drop-down.
Remarks
If the IsTextCompletionEnabled property is true and text typed by the user matches an item in the ItemsSource collection, which is then displayed in the text box, the SelectedItem property will be a null reference.
Text Property
Gets or sets the text in the text box portion of the Avalonia.Controls.AutoCompleteBox control.
public string Text { get; set; }
Value
The text in the text box portion of the Avalonia.Controls.AutoCompleteBox control.
TextFilter Property
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.
public Avalonia.Controls.AutoCompleteFilterPredicate<T><string> TextFilter { get; set; }
Value
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.
Remarks
The search mode is automatically set to Custom if you set the TextFilter property.
TextSelector Property
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.
public Avalonia.Controls.AutoCompleteSelector<T><string> TextSelector { get; set; }
Value
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.
ValueMemberBinding Property
Gets or sets the Avalonia.Data.BindingBase that is used to get the values for display in the text portion of the Avalonia.Controls.AutoCompleteBox control.
public Avalonia.Data.BindingBase ValueMemberBinding { get; set; }
Value
The Avalonia.Data.BindingBase object used when binding to a collection property.
Watermark Property
Gets or sets the placeholder or descriptive text that is displayed even if the text 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
AsyncPopulatorProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.AsyncPopulator property.
public Avalonia.StyledProperty<Func<string,System.Threading.CancellationToken,System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<object>>>> AsyncPopulatorProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.AsyncPopulator property.
CaretIndexProperty Field
Defines see Avalonia.Controls.TextBox.CaretIndex property.
public Avalonia.StyledProperty<int> CaretIndexProperty
ClearSelectionOnLostFocusProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.ClearSelectionOnLostFocus property
public Avalonia.StyledProperty<bool> ClearSelectionOnLostFocusProperty
FilterModeProperty Field
Gets the identifier for the Avalonia.Controls.AutoCompleteBox.FilterMode property.
public Avalonia.StyledProperty<Avalonia.Controls.AutoCompleteFilterMode> FilterModeProperty
InnerLeftContentProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.InnerLeftContent property
public Avalonia.StyledProperty<object> InnerLeftContentProperty
InnerRightContentProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.InnerRightContent property
public Avalonia.StyledProperty<object> InnerRightContentProperty
IsDropDownOpenProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property.
public Avalonia.StyledProperty<bool> IsDropDownOpenProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property.
IsTextCompletionEnabledProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.IsTextCompletionEnabled property.
public Avalonia.StyledProperty<bool> IsTextCompletionEnabledProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.IsTextCompletionEnabled property.
ItemFilterProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.ItemFilter property.
public Avalonia.StyledProperty<Avalonia.Controls.AutoCompleteFilterPredicate<T><object>> ItemFilterProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.ItemFilter property.
ItemSelectorProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.ItemSelector property.
public Avalonia.StyledProperty<Avalonia.Controls.AutoCompleteSelector<T><object>> ItemSelectorProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.ItemSelector property.
ItemTemplateProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.ItemTemplate property.
public Avalonia.StyledProperty<Avalonia.Controls.Templates.IDataTemplate> ItemTemplateProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.ItemTemplate property.
ItemsSourceProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.ItemsSource property.
public Avalonia.StyledProperty<System.Collections.IEnumerable> ItemsSourceProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.ItemsSource property.
MaxDropDownHeightProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.MaxDropDownHeight property.
public Avalonia.StyledProperty<double> MaxDropDownHeightProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.MaxDropDownHeight property.
MaxLengthProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.MaxLength property
public Avalonia.StyledProperty<int> MaxLengthProperty
MinimumPopulateDelayProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.MinimumPopulateDelay property.
public Avalonia.StyledProperty<TimeSpan> MinimumPopulateDelayProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.MinimumPopulateDelay property.
MinimumPrefixLengthProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.MinimumPrefixLength property.
public Avalonia.StyledProperty<int> MinimumPrefixLengthProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.MinimumPrefixLength property.
PlaceholderForegroundProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.PlaceholderForeground property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> PlaceholderForegroundProperty
PlaceholderTextProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.PlaceholderText property.
public Avalonia.StyledProperty<string> PlaceholderTextProperty
SearchTextProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.SearchText property.
public Avalonia.DirectProperty<Avalonia.Controls.AutoCompleteBox, string> SearchTextProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.SearchText property.
SelectedItemProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.SelectedItem property.
public Avalonia.StyledProperty<object> SelectedItemProperty
Value
The identifier the Avalonia.Controls.AutoCompleteBox.SelectedItem property.
SelectionChangedEvent Field
public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.SelectionChangedEventArgs> SelectionChangedEvent
TextChangedEvent Field
Defines the Avalonia.Controls.AutoCompleteBox.TextChanged event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.TextChangedEventArgs> TextChangedEvent
TextFilterProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.TextFilter property.
public Avalonia.StyledProperty<Avalonia.Controls.AutoCompleteFilterPredicate<T><string>> TextFilterProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.TextFilter property.
TextProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.Text property.
public Avalonia.StyledProperty<string> TextProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.Text property.
TextSelectorProperty Field
Identifies the Avalonia.Controls.AutoCompleteBox.TextSelector property.
public Avalonia.StyledProperty<Avalonia.Controls.AutoCompleteSelector<T><string>> TextSelectorProperty
Value
The identifier for the Avalonia.Controls.AutoCompleteBox.TextSelector property.
ValueMemberBindingProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.ValueMemberBinding property.
public Avalonia.StyledProperty<Avalonia.Data.BindingBase> ValueMemberBindingProperty
WatermarkForegroundProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.WatermarkForeground property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> WatermarkForegroundProperty
WatermarkProperty Field
Defines the Avalonia.Controls.AutoCompleteBox.Watermark property.
public Avalonia.StyledProperty<string> WatermarkProperty
Events
| Name | Description |
|---|---|
| DropDownClosed | Occurs when the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property was changed from true to false and the drop-down is open. |
| DropDownClosing | Occurs when the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property is changing from true to false. |
| DropDownOpened | Occurs when the value of the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property has changed from false to true and the drop-down is open. |
| DropDownOpening | Occurs when the value of the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property is changing from false to true. |
| Populated | Occurs when the Avalonia.Controls.AutoCompleteBox has populated the drop-down with possible matches based on the Avalonia.Controls.AutoCompleteBox.Text property. |
| Populating | Occurs when the Avalonia.Controls.AutoCompleteBox is populating the drop-down with possible matches based on the Avalonia.Controls.AutoCompleteBox.Text property. |
| SelectionChanged | Occurs when the selected item in the drop-down portion of the Avalonia.Controls.AutoCompleteBox has changed. |
| TextChanged | Occurs asynchronously when the text in the Avalonia.Controls.AutoCompleteBox.TextBox portion of the Avalonia.Controls.AutoCompleteBox changes. |
| 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 a double-tap gesture occurs on the control. 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 a hold gesture occurs on the control. 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 a pinch gesture occurs on the control. Inherited from InputElement. |
| PinchEnded | Occurs when a pinch gesture ends on the control. 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 a touchpad magnify gesture occurs on the control. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when a touchpad rotate gesture occurs on the control. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when a touchpad swipe gesture occurs on the control. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PullGesture | Occurs when a pull gesture occurs on the control. Inherited from InputElement. |
| PullGestureEnded | Occurs when a pull gesture ends on the control. Inherited from InputElement. |
| RightTapped | Occurs when a right tap gesture occurs on the control. Inherited from InputElement. |
| ScrollGesture | Occurs when a scroll gesture occurs on the control. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture ends on the control. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs when a scroll gesture inertia starts on the control. Inherited from InputElement. |
| SwipeGesture | Occurs when a swipe gesture occurs on the control. Inherited from InputElement. |
| Tapped | Occurs when a tap gesture occurs on the control. 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. |
DropDownClosed Event
Occurs when the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property was changed from true to false and the drop-down is open.
public event EventHandler DropDownClosed
DropDownClosing Event
Occurs when the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property is changing from true to false.
public event EventHandler<System.ComponentModel.CancelEventArgs> DropDownClosing
DropDownOpened Event
Occurs when the value of the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property has changed from false to true and the drop-down is open.
public event EventHandler DropDownOpened
DropDownOpening Event
Occurs when the value of the Avalonia.Controls.AutoCompleteBox.IsDropDownOpen property is changing from false to true.
public event EventHandler<System.ComponentModel.CancelEventArgs> DropDownOpening
Populated Event
Occurs when the Avalonia.Controls.AutoCompleteBox has populated the drop-down with possible matches based on the Avalonia.Controls.AutoCompleteBox.Text property.
public event EventHandler<Avalonia.Controls.PopulatedEventArgs> Populated
Populating Event
Occurs when the Avalonia.Controls.AutoCompleteBox is populating the drop-down with possible matches based on the Avalonia.Controls.AutoCompleteBox.Text property.
public event EventHandler<Avalonia.Controls.PopulatingEventArgs> Populating
Remarks
If the event is canceled, by setting the PopulatingEventArgs.Cancel property to true, the AutoCompleteBox will not automatically populate the selection adapter contained in the drop-down. In this case, if you want possible matches to appear, you must provide the logic for populating the selection adapter.
SelectionChanged Event
Occurs when the selected item in the drop-down portion of the Avalonia.Controls.AutoCompleteBox has changed.
public event EventHandler<Avalonia.Controls.SelectionChangedEventArgs> SelectionChanged
TextChanged Event
Occurs asynchronously when the text in the Avalonia.Controls.AutoCompleteBox.TextBox portion of the Avalonia.Controls.AutoCompleteBox changes.
public event EventHandler<Avalonia.Controls.TextChangedEventArgs> TextChanged