Class SfAIAssistView

Represents the assist view component used to display assist items and suggestions in the application.

Inheritance
System.Object
SfAIAssistView
Namespace: Syncfusion.Maui.AIAssistView
Assembly: Syncfusion.Maui.AIAssistView.dll
Syntax
public class SfAIAssistView : TemplatedView, IParentThemeElement, IThemeElement
Remarks

The SfAIAssistView class provides a user interface element for displaying and managing assist items, including features such as suggestion lists and profile information.

Constructors

SfAIAssistView()

Initializes a new instance of the SfAIAssistView class.

Declaration
public SfAIAssistView()

Fields

AllowTextSelectionProperty

Identifies the AllowTextSelection bindable property.

Declaration
public static readonly BindableProperty AllowTextSelectionProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

AssistItemsProperty

Identifies the AssistItems bindable property.

Declaration
public static readonly BindableProperty AssistItemsProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

CardTappedCommandProperty

Identifies the CardTappedCommand bindable property.

Declaration
public static readonly BindableProperty CardTappedCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

CurrentUserProperty

Identifies the CurrentUser bindable property.

Declaration
public static readonly BindableProperty CurrentUserProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

EditorViewTemplateProperty

Identifies the EditorViewTemplate bindable property.

Declaration
public static readonly BindableProperty EditorViewTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

EmptyViewProperty

Identifies the EmptyView bindable property.

Declaration
public static readonly BindableProperty EmptyViewProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

EmptyViewTemplateProperty

Identifies the EmptyViewTemplate bindable property.

Declaration
public static readonly BindableProperty EmptyViewTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

EnableStopRespondingProperty

Identifies the EnableStopResponding bindable property.

Declaration
public static readonly BindableProperty EnableStopRespondingProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

HeaderTemplateProperty

Identifies the HeaderTemplate bindable property.

Declaration
public static readonly BindableProperty HeaderTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

HeaderTextProperty

Identifies the HeaderText bindable property.

Declaration
public static readonly BindableProperty HeaderTextProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

ImageTappedCommandProperty

Identifies the ImageTappedCommand bindable property.

Declaration
public static readonly BindableProperty ImageTappedCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

InputTextProperty

Identifies the InputText bindable property.

Declaration
public static readonly BindableProperty InputTextProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

ItemCopyCommandProperty

Identifies the ItemCopyCommand bindable property.

Declaration
public static readonly BindableProperty ItemCopyCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

ItemLongPressedCommandProperty

Identifies the ItemLongPressedCommand bindable property.

Declaration
public static readonly BindableProperty ItemLongPressedCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

ItemRatingChangedCommandProperty

Identifies the ItemRatingChangedCommand bindable property.

Declaration
public static readonly BindableProperty ItemRatingChangedCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

ItemRetryCommandProperty

Identifies the ItemRetryCommand bindable property.

Declaration
public static readonly BindableProperty ItemRetryCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

ItemsSourceConverterProperty

Identifies the ItemsSourceConverter Microsoft.Maui.Controls.BindableProperty.

Declaration
public static readonly BindableProperty ItemsSourceConverterProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

ItemsSourceProperty

Identifies the ItemsSource Microsoft.Maui.Controls.BindableProperty.

Declaration
public static readonly BindableProperty ItemsSourceProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

ItemTappedCommandProperty

Identifies the ItemTappedCommand bindable property.

Declaration
public static readonly BindableProperty ItemTappedCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

RequestButtonTemplateProperty

Identifies the RequestButtonTemplate bindable property.

Declaration
public static readonly BindableProperty RequestButtonTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

RequestCommandProperty

Identifies the RequestCommand bindable property.

Declaration
public static readonly BindableProperty RequestCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

RequestItemTemplateProperty

Identifies the RequestItemTemplate bindable property.

Declaration
public static readonly BindableProperty RequestItemTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

ResponseItemTemplateProperty

Identifies the ResponseItemTemplate bindable property.

Declaration
public static readonly BindableProperty ResponseItemTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

ResponseSuggestionTemplateProperty

Identifies the ResponseSuggestionTemplate binable property.

Declaration
public static readonly BindableProperty ResponseSuggestionTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

ShowHeaderProperty

Identifies the ShowHeader bindable property.

Declaration
public static readonly BindableProperty ShowHeaderProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

ShowResponseLoaderProperty

Identifies the ShowResponseLoader bindable property.

Declaration
public static readonly BindableProperty ShowResponseLoaderProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

StopRespondingCommandProperty

Identifies the StopRespondingCommand bindable property.

Declaration
public static readonly BindableProperty StopRespondingCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

StopRespondingTemplateProperty

Identifies the StopRespondingTemplate bindable property.

Declaration
public static readonly BindableProperty StopRespondingTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

StopRespondingTextProperty

Identifies the StopRespondingText bindable property.

Declaration
public static readonly BindableProperty StopRespondingTextProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

SuggestionItemSelectedCommandProperty

Identifies the SuggestionItemSelectedCommand bindable property.

Declaration
public static readonly BindableProperty SuggestionItemSelectedCommandProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

SuggestionsProperty

Identifies the Suggestions bindable property.

Declaration
public static readonly BindableProperty SuggestionsProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty

SuggestionTemplateProperty

Identifies the SuggestionTemplate bindable property.

Declaration
public static readonly BindableProperty SuggestionTemplateProperty
Field Value
Type
Microsoft.Maui.Controls.BindableProperty
Remarks

This bindable property is read-only.

Properties

AllowTextSelection

Gets or sets a value indicating whether the text selection is enabled for response and request texts.

Declaration
public bool AllowTextSelection { get; set; }
Property Value
Type
System.Boolean

AssistItems

Gets or sets the collection of assist items to be displayed in the SfAIAssistView.

Declaration
public IList<IAssistItem> AssistItems { get; set; }
Property Value
Type
System.Collections.Generic.IList<IAssistItem>

CardTappedCommand

Gets or sets the System.Windows.Input.ICommand that is executed when an AssistCardItem is tapped.

Declaration
public ICommand CardTappedCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand

CurrentUser

Gets or sets the Profile details associated with the SfAIAssistView.

Declaration
public Profile CurrentUser { get; set; }
Property Value
Type
Profile

EditorViewTemplate

Gets or sets the template used to define the editor view of the SfAIAssistView.

Declaration
public DataTemplate EditorViewTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

EmptyView

Gets or sets the content or view that will be displayed when there are no items in SfAIAssistView.

Declaration
public object EmptyView { get; set; }
Property Value
Type
System.Object

EmptyViewTemplate

Gets or sets the template used to define the empty view of the SfAIAssistView.

Declaration
public DataTemplate EmptyViewTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

EnableStopResponding

Gets or sets a value indicating whether the StopResponding view is displayed.

Declaration
public bool EnableStopResponding { get; set; }
Property Value
Type Description
System.Boolean

true to display the StopResponding view; otherwise, false.

HeaderTemplate

Gets or sets the template used to define the header view of the SfAIAssistView.

Declaration
public DataTemplate HeaderTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate
See Also

HeaderText

Gets or sets the header text displayed at the top of the SfAIAssistView.

Declaration
public string HeaderText { get; set; }
Property Value
Type
System.String
See Also

ImageTappedCommand

Gets or sets the System.Windows.Input.ICommand that is executed when an AssistImageItem is tapped.

Declaration
public ICommand ImageTappedCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand

InputText

Gets or sets the text of the editor in the SfAIAssistView.

Declaration
public string InputText { get; set; }
Property Value
Type
System.String

ItemCopyCommand

Gets or sets the System.Windows.Input.ICommand that is executed when the copy icon is clicked in a response AssistItem.

Declaration
public ICommand ItemCopyCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand

ItemLongPressedCommand

Gets or sets the System.Windows.Input.ICommand that is executed when an AssistItem is long pressed.

Declaration
public ICommand ItemLongPressedCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand
See Also

ItemRatingChangedCommand

Gets or sets the System.Windows.Input.ICommand that is executed when the like or dislike icon is clicked in a response AssistItem.

Declaration
public ICommand ItemRatingChangedCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand

ItemRetryCommand

Gets or sets the System.Windows.Input.ICommand that is executed when the retry icon is clicked in a response AssistItem.

Declaration
public ICommand ItemRetryCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand

ItemsSource

Gets or sets the items collection for the assistview. Each item in the collection will be converted to assist item and added to AssistItems.

Declaration
public IEnumerable ItemsSource { get; set; }
Property Value
Type
System.Collections.IEnumerable

ItemsSourceConverter

Gets or sets the converter used to convert data objects to assist items and vice versa.

Declaration
public IAssistItemConverter ItemsSourceConverter { get; set; }
Property Value
Type
IAssistItemConverter

ItemTappedCommand

Gets or sets the System.Windows.Input.ICommand that is executed when an AssistItem is tapped.

Declaration
public ICommand ItemTappedCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand
See Also

RequestButtonTemplate

Gets or sets the template used to define the send button view of the SfAIAssistView.

Declaration
public DataTemplate RequestButtonTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

RequestCommand

Gets or sets the System.Windows.Input.ICommand that is executed when a request is initiated.

Declaration
public ICommand RequestCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand

RequestItemTemplate

Gets or sets the data template used for displaying request IAssistItem in the SfAIAssistView.

Declaration
public DataTemplate RequestItemTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

ResponseItemTemplate

Gets or sets the data template used for displaying response IAssistItem in the SfAIAssistView.

Declaration
public DataTemplate ResponseItemTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

ResponseSuggestionTemplate

Gets or sets the template used to define the Assist item suggestion view of the SfAIAssistView.

Declaration
public DataTemplate ResponseSuggestionTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

ShowHeader

Gets or sets a value indicating whether the header view should be displayed in the SfAIAssistView.

Declaration
public bool ShowHeader { get; set; }
Property Value
Type
System.Boolean
See Also

ShowResponseLoader

Gets or sets a value indicating whether the Shimmer view is displayed.

Declaration
public bool ShowResponseLoader { get; set; }
Property Value
Type Description
System.Boolean

true to display the Shimmer view; otherwise, false.

StopRespondingCommand

Gets or sets the command to be executed when Stop Responding view is clicked.

Declaration
public ICommand StopRespondingCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand
Remarks

This command can be used to handle user actions to stop an ongoing response.

StopRespondingTemplate

Gets or sets the template used to define the Stopresponding view of the SfAIAssistView.

Declaration
public DataTemplate StopRespondingTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

StopRespondingText

Gets or sets the text displayed in the stop responding view.

Declaration
public string StopRespondingText { get; set; }
Property Value
Type
System.String
See Also

SuggestionItemSelectedCommand

Gets or sets the System.Windows.Input.ICommand that is executed when an AssistSuggestion item is selected.

Declaration
public ICommand SuggestionItemSelectedCommand { get; set; }
Property Value
Type
System.Windows.Input.ICommand

Suggestions

Gets or sets the collection of suggestions to be shown in header template.

Declaration
public IList<ISuggestion> Suggestions { get; set; }
Property Value
Type
System.Collections.Generic.IList<ISuggestion>

SuggestionTemplate

Gets or sets the template for common suggestions.

Declaration
public DataTemplate SuggestionTemplate { get; set; }
Property Value
Type
Microsoft.Maui.Controls.DataTemplate

Methods

CreateAssistChat()

Creates a AssistViewChat instance that can be used for customizing Chat view functionalities.

Declaration
protected virtual AssistViewChat CreateAssistChat()
Returns
Type Description
AssistViewChat

Returns the AssistViewChat instance.

Events

CardTapped

Occurs when an card item is tapped in the SfAIAssistView.

Declaration
public event EventHandler<CardTappedEventArgs> CardTapped
Event Type
Type
System.EventHandler<CardTappedEventArgs>

ImageTapped

Occurs when an image is tapped in the SfAIAssistView.

Declaration
public event EventHandler<ImageTappedEventArgs> ImageTapped
Event Type
Type
System.EventHandler<ImageTappedEventArgs>

ItemLongPressed

Occurs when an AssistItem is long pressed in the SfAIAssistView.

Declaration
public event EventHandler<ItemLongPressedEventArgs> ItemLongPressed
Event Type
Type
System.EventHandler<ItemLongPressedEventArgs>

ItemTapped

Occurs when an AssistItem is tapped in the SfAIAssistView.

Declaration
public event EventHandler<ItemTappedEventArgs> ItemTapped
Event Type
Type
System.EventHandler<ItemTappedEventArgs>

Request

Occurs when a request is initiated in the SfAIAssistView.

Declaration
public event EventHandler<RequestEventArgs> Request
Event Type
Type
System.EventHandler<RequestEventArgs>

StopResponding

Occurs when the Stop Responding view is clicked.

Declaration
public event EventHandler<EventArgs> StopResponding
Event Type
Type
System.EventHandler<System.EventArgs>
Remarks

This event can be used to handle user actions to stop an ongoing response.

SuggestionItemSelected

Occurs when a suggestion item is selected in the SfAIAssistView.

Declaration
public event EventHandler<SuggestionItemSelectedEventArgs> SuggestionItemSelected
Event Type
Type
System.EventHandler<SuggestionItemSelectedEventArgs>