Class AutoSuggestionOverlay

Represents the configuration and state model for the AutoSuggestion overlay UI component.

Inheritance

System.Object

AutoSuggestionOverlay

Namespace: Syncfusion.Maui.AIAssistView

Assembly: Syncfusion.Maui.AIAssistView.dll

Syntax

public class AutoSuggestionOverlay : BindableObject

Constructors

AutoSuggestionOverlay()

Declaration

public AutoSuggestionOverlay()

Fields

AllowGroupingProperty

Identifies the AllowGrouping bindable property that determines whether suggestions are grouped by category.

Declaration

public static readonly BindableProperty AllowGroupingProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

AutoSuggestionsProperty

Gets or sets the collection of suggestion items displayed in the overlay.

Declaration

public static readonly BindableProperty AutoSuggestionsProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

AutoSuggestionTemplateProperty

Gets or sets the Microsoft.Maui.Controls.DataTemplate used to visually represent each suggestion item within the overlay list.

Declaration

public static readonly BindableProperty AutoSuggestionTemplateProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

CancelRequestProperty

Gets or sets a value indicating whether selecting a suggestion should automatically submit the chosen value.

Declaration

public static readonly BindableProperty CancelRequestProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

GroupHeaderTemplateProperty

Identifies the GroupHeaderTemplate bindable property that specifies the template used to render group headers.

Declaration

public static readonly BindableProperty GroupHeaderTemplateProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

IsOpenProperty

Identifies the IsOpen bindable property. Default is closed (false) and two-way so the control can notify host viewmodels.

Declaration

public static readonly BindableProperty IsOpenProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

ItemSelectedCommandProperty

Identifies the ItemSelectedCommand bindable property.

Declaration

public static readonly BindableProperty ItemSelectedCommandProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

MinimumPrefixCharactersProperty

Gets or sets the minimum number of characters the user must type before suggestions are requested and displayed.

Declaration

public static readonly BindableProperty MinimumPrefixCharactersProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

SuggestionOpenDelayProperty

Gets or sets the debounce time, in milliseconds, applied before triggering a suggestion query.

Declaration

public static readonly BindableProperty SuggestionOpenDelayProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Properties

AllowGrouping

Gets or sets a value indicating whether suggestions in the overlay are grouped by category.The default value is false.

Declaration

public bool AllowGrouping { get; set; }

Property Value

Type
System.Boolean

AutoSuggestions

Gets or sets the collection of inline suggestion items to be displayed.

Declaration

public IList<ISuggestion> AutoSuggestions { get; set; }

Property Value

Type
System.Collections.Generic.IList<ISuggestion>

AutoSuggestionTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate used to render each suggestion row.

Declaration

public DataTemplate AutoSuggestionTemplate { get; set; }

Property Value

Type
Microsoft.Maui.Controls.DataTemplate

CancelRequest

Gets or sets a value indicating whether selecting a suggestion should automatically submit the chosen value.

Declaration

public bool CancelRequest { get; set; }

Property Value

Type
System.Boolean

GroupHeaderTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate used to render group headers when suggestions are grouped. If null, a default group header template is used.

Declaration

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

Type
Microsoft.Maui.Controls.DataTemplate

IsOpen

Gets a value indicating whether the suggestion overlay is currently open or in close state.

Declaration

public bool IsOpen { get; }

Property Value

Type
System.Boolean

ItemSelectedCommand

Gets or sets the command that will be executed when an item in the overlay is selected. The command parameter is the selected ISuggestion.

Declaration

public ICommand ItemSelectedCommand { get; set; }

Property Value

Type
System.Windows.Input.ICommand

MinimumPrefixCharacters

Gets or sets the minimum number of characters a user must type before suggestions are requested and displayed.

Declaration

public int MinimumPrefixCharacters { get; set; }

Property Value

Type
System.Int32

SuggestionOpenDelay

Gets or sets the suggestion open delay duration, in milliseconds, applied before triggering the suggestion query.

Declaration

public int SuggestionOpenDelay { get; set; }

Property Value

Type
System.Int32