FAComboBox
Namespace: FluentAvalonia.UI.Controls
Represents a selection control that combines a non-editable text box and a drop-down list box that allows users to select an item from a list.
C#
public class FAComboBox : HeaderedSelectingItemsControl
Xaml
<ui:FAComboBox />
Required Template Parts
| Name | Control Type |
|---|---|
| Popup | Popup |
| EditableText | TextBox |
| DropDownOverlay | ComboBox |
Pseudoclasses
:selected, :focus, :pressed, :editable, :dropdownopen, :popupAbove, :header, :empty, :singleitem, :disabled, :focus, :focus-visible, :focus-within, :pointerover
Examples and Usage Notes
None yet.
API
Note: Inherited members are not shown
Properties
| HorizontalContentAlignment | Gets or sets the `Avalonia.Layout.HorizontalAlignment` of the content in the ComboBox |
| HorizontalContentAlignmentProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.HorizontalContentAlignment` property |
| IsDropDownOpen | Gets or sets whether this ComboBox's dropdown is open |
| IsDropDownOpenProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.IsDropDownOpen` property |
| IsEditable | Gets or sets whether this ComboBox is editable |
| IsEditableProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.IsEditable` property |
| IsSelectionBoxHighlighted | Gets whether the SelectionBox is hightlighted |
| IsSelectionBoxHighlightedProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.IsSelectionBoxHighlighted` property |
| MaxDropDownHeight | Gets or sets the maximum allowed height of the dropdown |
| MaxDropDownHeightProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.MaxDropDownHeight` property |
| PlaceholderForeground | Gets or sets a brush that describes the color of placeholder text. |
| PlaceholderForegroundProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.PlaceholderForeground` property |
| PlaceholderText | Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation. |
| PlaceholderTextProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.PlaceholderText` property |
| SelectionBoxItem | Gets the item shown whne the ComboBox is closed |
| SelectionBoxItemProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.SelectionBoxItem` property |
| SelectionBoxItemTemplate | Gets the template applied to the selection box content. |
| SelectionBoxItemTemplateProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.SelectionBoxItemTemplate` property |
| SelectionChangedTrigger | Gets or sets a value that indicates what action causes a SelectionChanged event to occur. |
| SelectionChangedTriggerProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.SelectionChangedTrigger` property |
| Text | Gets or sets the text in the ComboBox. |
| TextBoxTheme | Gets or sets the `Avalonia.Styling.ControlTheme` used for the TextBox part of the ComboBox |
| TextBoxThemeProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.TextBoxTheme` property |
| TextProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.Text` property |
| VerticalContentAlignment | Gets or sets the `Avalonia.Layout.VerticalAlignment` of the content in the ComboBox |
| VerticalContentAlignmentProperty | Defines the `FluentAvalonia.UI.Controls.FAComboBox.VerticalContentAlignment` property |
Events
| DropDownClosed | Occurs when the drop-down portion of the ComboBox closes. |
| DropDownOpened | Occurs when the drop-down portion of the ComboBox opens. |
| TextSubmitted | Occurs when the user submits some text that does not correspond to an item in the ComboBox dropdown list. |
Methods
Related Enums/Classes
FAComboBoxSelectionChangedTrigger
| Committed | A change event occurs when the user commits a selection in the ComboBox |
| Always | A change event occurs each time the user navigates to a new selection in the ComboBox |
FAComboBoxTextSubmittedEventArgs
| Handled | Gets or sets whether the TextSubmitted event was handled or not. If **true**, the framework will not automatically update the selected item of the ComboBox to the new value. |
| Text | Gets the custom text value entered by the user |