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

ActionButtonIconProperty

Identifies the ActionButtonIcon bindable property.

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

ActionButtonPositionProperty

Identifies the ActionButtonPosition bindable property.

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

ActionButtonsProperty

Identifies the ActionButtons bindable property.

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

ActionButtonTypeProperty

Identifies the ActionButtonType bindable property. Defaults to AttachmentButton (breaking change: default shows attachment behavior).

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

AgentsProperty

Identifies the Agents> bindable property.

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

AllowEditorExpansionProperty

Identifies the AllowEditorExpansion bindable property.

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

AllowMultiplePickProperty

Identifies the AllowMultiplePick bindable property.

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

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

AssistProfileProperty

Identifies the AssistProfile bindable property.

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

This bindable property is read-only.

AttachmentItemTemplateProperty

Identifies the AttachmentItemTemplate bindable property.

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

AttachmentsProperty

Identifies the Attachments bindable property.

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

AttachmentTappedCommandProperty

Identifies the AttachmentTappedCommand bindable property.

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

This bindable property is read-only.

AutoScrollBehaviorProperty

Identifies the bindable property.

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

AutoSuggestionOverlayProperty

Bindable property that defines the AutoSuggestionOverlay used to configure and control the suggestion overlay behavior for the SfAIAssistView.

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

CanAutoScrollToBottomProperty

Identifies the CanAutoScrollToBottom bindable property.

Declaration
public static readonly BindableProperty CanAutoScrollToBottomProperty
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.

ContextPromptProperty

Identifies the ContextPrompt bindable property.

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

ConversationEmptyViewProperty

Identifies the bindable property.

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

ConversationHeaderTextProperty

Identifies the ConversationHeaderText bindable property.

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

ConversationItemsSourceProperty

Identifies the ConversationItemsSource bindable property.

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

ConversationItemTappedCommandProperty

Identifies the ConversationItemTappedCommand bindable property.

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

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.

DisclaimerTextProperty

Identifies the DisclaimerText bindable property.

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

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

EnableConversationHistoryProperty

Identifies the EnableConversationHistory bindable property.

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

EnableLiquidGlassEffectProperty

Identifies the EnableLiquidGlassEffect bindable property.

Declaration
public static readonly BindableProperty EnableLiquidGlassEffectProperty
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.

EnableTemporaryChatProperty

Identifies the EnableTemporaryChat bindable property.

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

EnableVoiceInputProperty

Identifies the EnableVoiceInput bindable property.

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

This bindable property determines whether the voice input (microphone) button is visible and functional in the input view.

FooterSuggestionsProperty

Identifies the Suggestions Microsoft.Maui.Controls.BindableProperty.

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

FooterSuggestionTemplateProperty

Identifies the FooterSuggestionTemplate bindable property.

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

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.

MaxAttachmentCountProperty

Identifies the MaxAttachmentCount bindable property.

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

PreventDuplicateAttachmentsProperty

Identifies the PreventDuplicateAttachments bindable property.

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

PromptPartsProperty

Identifies the PromptParts bindable property.

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

RequestButtonIconProperty

Identifies the RequestButtonIcon bindable property.

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

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.

RequestContextMenuItemTemplateProperty

Identifies the RequestContextMenuItemTemplate bindable property. This template is used specifically for request-item context menu entries (request popup).

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

RequestContextMenuPanelTemplateProperty

Identifies the RequestContextMenuPanelTemplate bindable property. This template is used specifically for the request-item context menu panel (request popup).

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

RequestContextMenuProperty

Identifies the RequestContextMenu bindable property. This collection is reserved for request-item-specific context menu actions.

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

RequestItemTemplateProperty

Identifies the RequestItemTemplate bindable property.

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

ResponseContextMenuItemTemplateProperty

Identifies the ResponseContextMenuItemTemplate bindable property.

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

ResponseContextMenuPanelTemplateProperty

Identifies the ResponseContextMenuPanelTemplate bindable property.

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

ResponseContextMenuProperty

Identifies the ResponseContextMenu Microsoft.Maui.Controls.BindableProperty.

Declaration
public static readonly BindableProperty ResponseContextMenuProperty
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

ScrollToBottomButtonTemplateProperty

Identifies the ScrollToBottomButtonTemplate bindable property. Specifies the Microsoft.Maui.Controls.DataTemplate used to customize the appearance of the scroll-to-bottom button in the SfChat control.

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

SelectedAgentProperty

Identifies the SelectedAgent bindable property.

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

SelectedAgentTemplateProperty

Identifies the SelectedAgentTemplate> bindable property.

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

ShowActionButtonsProperty

Identifies the ShowActionButtons bindable property.

Declaration
public static readonly BindableProperty ShowActionButtonsProperty
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.

ShowScrollToBottomButtonProperty

Identifies the ShowScrollToBottomButton bindable property. Determines whether the scroll-to-bottom button is visible in the SfAIAssistView control.

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

ShowSelectedAgentProperty

Identifies the ShowSelectedAgent> bindable property.

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

ShowTimeBreakProperty

Identifies the ShowTimeBreak bindable property. Determines whether time-break separators are displayed between messages from different dates.

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

ShowToolbarProperty

Identifies the ShowToolbar bindable property. Determines whether the header tool bar is visible in the SfAIAssistView control.

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

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.

StopRespondingIconProperty

Identifies the StopRespondingIcon bindable property.

Declaration
public static readonly BindableProperty StopRespondingIconProperty
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.

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.

SystemPromptProperty

Identifies the SystemPrompt bindable property.

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

TemporaryChatBannerTemplateProperty

Identifies the TemporaryChatBannerTemplate bindable property.

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

TemporaryChatBannerTextProperty

Identifies the TemporaryChatBannerText bindable property.

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

TimeBreakTemplateProperty

Identifies the TimeBreakTemplate bindable property.

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

ToolbarHeightProperty

Identifies the ToolbarHeight bindable property.

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

ToolbarMenuOptionsProperty

Identifies the ToolbarMenuOptions bindable property. Represents the collection of menu options to display in the toolbar menu popup.

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

ToolbarTitleProperty

Identifies the ToolbarTitle bindable property.

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

Properties

ActionButtonIcon

Gets or sets the custom icon for the action button.

Declaration
public ImageSource ActionButtonIcon { get; set; }
Property Value
Type
Microsoft.Maui.Controls.ImageSource
Remarks

This property allows customization of the action button icon displayed in the input view. When set to null, the default icon is used.

ActionButtonPosition

Gets or sets the position of the action button in the input view.

Declaration
public ActionButtonPosition ActionButtonPosition { get; set; }
Property Value
Type
ActionButtonPosition
Remarks

This property determines where the action button is displayed relative to other input view controls. The default position is Start.

ActionButtons

Gets or sets the collection of action buttons to be shown in editor view.

Declaration
public ObservableCollection<ActionButton> ActionButtons { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<ActionButton>

ActionButtonType

Gets or sets the type of the action button displayed in the input view.

Declaration
public ActionButtonType ActionButtonType { get; set; }
Property Value
Type
ActionButtonType

Agents

Gets or sets the collection of available agents that users can select from.

Declaration
public IList<AssistAgent> Agents { get; set; }
Property Value
Type
System.Collections.Generic.IList<AssistAgent>
Remarks

This is an ObservableCollection that is automatically initialized in the constructor. Add AssistAgent instances to this collection to make them available for selection.

AllowEditorExpansion

Gets or sets a value indicating whether to enable full-screen editor mode.

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

true to enable full-screen editor, otherwise false. The default value is false.

AllowMultiplePick

Gets or sets a value indicating whether multiple files can be picked from the system file picker.

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

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>

AssistProfile

Gets or sets the Profile details associated with the SfAIAssistView.

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

AttachmentItemTemplate

Gets or sets the template used to render an attachment item in the input preview.

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

Attachments

Gets or sets the attachments selected in the input view.

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

AttachmentTappedCommand

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

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

AutoScrollBehavior

Gets or sets the scroll behavior for the assist view.

Declaration
public AssistViewScrollBehavior AutoScrollBehavior { get; set; }
Property Value
Type
AssistViewScrollBehavior
Remarks

Defaults to ScrollToLastResponse.

AutoSuggestionOverlay

Gets or sets the AutoSuggestionOverlay instance provided by host to customize inline autocomplete overlay appearance.

Declaration
public AutoSuggestionOverlay AutoSuggestionOverlay { get; set; }
Property Value
Type
AutoSuggestionOverlay

CanAutoScrollToBottom

Gets or sets a value indicating whether the view automatically scrolls to show new messages.

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

true if the view should automatically scroll to the bottom when new messages are added; otherwise, false. The default value is true.

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

ContextPrompt

Gets or sets the application context prompt that provides metadata for the current conversation.

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

The ContextPrompt represents application-specific context, workspace metadata, document state, or session information. It appears after the SystemPrompt in the composed prompt when an AI request is sent. This property is typically updated dynamically as the application context changes. This property supports data binding through the BindableProperty mechanism. The default value is null.

ConversationEmptyView

Gets or sets the Microsoft.Maui.Controls.DataTemplate for the empty state when no conversations exist.

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

This template is displayed when the conversation history is empty. If not specified, a default template with the message "Your conversation history will appear here" will be used.

ConversationFilterChangedCommand

Gets or sets the command that executes when conversation filters change.

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

This command is executed with a Syncfusion.Maui.AIAssistView.ConversationFilterChangedEventArgs parameter containing information about the current filter state and filtered item count.

ConversationFilterText

Gets or sets the text filter for searching conversations by title or content.

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

The text search is case-insensitive and matches against conversation titles and descriptions. The default value is System.String.Empty.

ConversationHeaderText

Gets or sets the header text displayed in the conversation drawer.

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

ConversationItemsSource

Gets or sets the Conversation collection.

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

ConversationItemTappedCommand

Gets or sets the command to triggers when AssistConversationItem is tapped.

Declaration
public ICommand ConversationItemTappedCommand { 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

DisclaimerText

Gets or sets the footer disclaimer text displayed in the SfAIAssistView.

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

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

EnableConversationHistory

Gets or sets a value indicating whether to display the conversation history or not.

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

EnableLiquidGlassEffect

Gets or sets a value indicating whether to enable liquid glass effect for assist view control.

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

true to enable liquid glass effect, otherwise false. The default value is false.

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.

EnableTemporaryChat

Gets or sets a value indicating whether the SfAIAssistView is in Temporary Chat mode.

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

EnableVoiceInput

Gets or sets a value indicating whether the voice input (microphone) button is enabled.

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

true to show the microphone button and enable voice input; otherwise, false.
Remarks

When enabled, users can tap the microphone button to initiate speech-to-text recognition. The underlying speech recognition behavior depends on the platform and its permissions.

FooterSuggestions

Gets or sets the list of items to be displayed as response to a user message. The suggestions will be displayed above the message typing/input area as part of the footer view.

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

FooterSuggestionTemplate

Gets or sets the template for editor suggestions.

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

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

MaxAttachmentCount

Gets or sets the maximum number of attachments allowed in the input view.

Declaration
public int MaxAttachmentCount { get; set; }
Property Value
Type
System.Int32

PreventDuplicateAttachments

Gets or sets a value indicating whether duplicate attachments should be prevented.

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

PromptParts

Gets or sets collection of prompt parts that are composed into the final prompt.

Declaration
public IList<AssistPromptPart> PromptParts { get; set; }
Property Value
Type
System.Collections.Generic.IList<AssistPromptPart>
Remarks

The PromptParts collection contains discrete prompt fragments that are added dynamically by the application. Each part can be individually enabled or disabled, and is sorted by its Order property. Only enabled parts (IsEnabled = true) with non-empty content are included in the composed prompt.

RequestButtonIcon

Gets or sets the image source for the request button icon.

Declaration
public ImageSource RequestButtonIcon { get; set; }
Property Value
Type Description
Microsoft.Maui.Controls.ImageSource

A Microsoft.Maui.Controls.ImageSource. The default is null, which uses the control’s built-in icon.
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

RequestContextMenu

Gets or sets the collection of action buttons used as a request-item context menu. Applications can pre-populate this collection in XAML to provide request-specific actions.

Declaration
public ObservableCollection<AssistContextMenuItem> RequestContextMenu { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<AssistContextMenuItem>

RequestContextMenuItemTemplate

Gets or sets the data template used to render context menu items specifically for request popups.

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

RequestContextMenuPanelTemplate

Gets or sets the panel template used to render the entire request context menu popup.

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

RequestEditor

Gets the editor control used for text input in the SfAIAssistView.

Declaration
public Editor RequestEditor { get; }
Property Value
Type Description
Microsoft.Maui.Controls.Editor

An Microsoft.Maui.Controls.Editor instance representing the text input control, or null if the control is not yet loaded.
Remarks

This property provides access to the underlying editor control, allowing for customization such as setting input scope, keyboard type, text prediction, and other editor-specific properties. The editor is available after the control is loaded.

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

ResponseContextMenu

Gets or sets the collection of context menu items to be displayed for response messages.

Declaration
public IList<AssistContextMenuItem> ResponseContextMenu { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<AssistContextMenuItem>

An System.Collections.Generic.IList<> of that defines the menu items for response context menus. The default value is null.

ResponseContextMenuItemTemplate

Gets or sets the global data template used to render context menu items.

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

This template is applied to all context menu items unless overridden by a per-item template. When set, this template controls how each menu item is displayed with its text, icon, and other properties.

ResponseContextMenuPanelTemplate

Gets or sets the template used to render the entire context menu panel.

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

This template provides complete control over the menu's layout, styling, and behavior. When set, this template overrides the default menu panel rendering. The template receives the context menu items as its binding context.

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

ScrollToBottomButtonTemplate

Gets or sets the template for customizing the scroll-to-bottom button.

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

The default value is null.

SelectedAgent

Gets or sets the currently active agent used for generating responses. When set, the agent's SystemPrompt and Temperature will be used for all subsequent requests.

Declaration
public AssistAgent SelectedAgent { get; set; }
Property Value
Type
AssistAgent
Remarks

The CurrentAgent property is bindable and supports two-way binding. When changed, the AgentChanged event is raised and if PersistAgentSelection is true, the selection is saved to local preferences.

SelectedAgentTemplate

Gets or sets a custom template for the agent selector UI.

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

If not specified, a default agent selector template will be used. The DataContext for this template will be the SfAIAssistView instance.

ShowActionButtons

Gets or sets a value indicating whether the action buttons should be displayed in the SfAIAssistView.

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

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.

ShowScrollToBottomButton

Gets or sets a value indicating whether the scroll-to-bottom button is enabled.

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

The default value is false.

ShowSelectedAgent

Gets or sets a value indicating whether the agent selector UI is displayed.

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

When true, displays a selector allowing users to switch between available agents. Default value is true.

ShowTimeBreak

Gets or sets a value indicating whether time-break separators are displayed between messages from different dates.

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

When set to true, the control automatically groups messages by date and inserts visual separators with smart date labels. The date labels follow a hierarchical format: "Today" for the current date, "Yesterday" for the previous date, day-of-week name (e.g., "Thursday") for messages within 7 days, and "dd MMM yyyy" format for older messages. The default value is false (separators are hidden).

Examples
<syncfusion:SfAIAssistView ShowTimeBreak="True" />

ShowToolbar

Gets or sets a value indicating whether the header Toolbar is enabled.

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

The default value is 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.

StopRespondingIcon

Gets or sets the font image source to display in the stop responding view.

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

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

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

SystemPrompt

Gets or sets the global system prompt that applies to all conversations in the SfAIAssistView.

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

The SystemPrompt represents global AI instructions, persona definitions, behavior rules, and safety guidelines. It appears first in the composed prompt when an AI request is sent. This property supports data binding through the BindableProperty mechanism. The default value is null.

TemporaryChatBannerTemplate

Gets or sets the custom template for the Temporary Chat banner.

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

TemporaryChatBannerText

Gets or sets the text displayed in the default Temporary Chat banner.

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

TimeBreakTemplate

Gets or sets the template used to display custom view in the time break area.

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

ToolbarHeight

Gets or sets the height of the header Toolbar.

Declaration
public double ToolbarHeight { get; set; }
Property Value
Type
System.Double

ToolbarMenuOptions

Gets or sets the collection of menu options to display in the toolbar menu popup.

Declaration
public IList<ActionButton> ToolbarMenuOptions { get; set; }
Property Value
Type
System.Collections.Generic.IList<ActionButton>
Remarks

This property provides a way to define custom menu items that appear when the toolbar menu button is tapped. The menu items are displayed in a popup anchored to the toolbar menu button.

ToolbarTitle

Gets or sets the width of the conversation history drawer.

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

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.

CreateConversationListView()

Creates a ConversationListView instance that can be used for customizing ListView functionalities.

Declaration
protected virtual ConversationListView CreateConversationListView()
Returns
Type Description
ConversationListView

Returns the ConversationListView instance.

OnBindingContextChanged()

Re-apply overlay BindingContext when the assist view's BindingContext changes.

Declaration
protected override void OnBindingContextChanged()

OnHandlerChanged()

Handles handler changes for SfAIAssistView This override is used to perform required initialization and cleanup when the native handler is created or changed, preventing potential memory leaks related to toast notifications.

Declaration
protected override void OnHandlerChanged()

OnPropertyChanged(String)

Handles the property changes for SfAIAssistView.

Declaration
protected override void OnPropertyChanged(string propertyName = null)
Parameters
Type Name Description
System.String propertyName

Represents the property changed event arguments.

Events

AttachmentTapped

Occurs when an attachment is tapped in the SfAIAssistView.

Declaration
public event EventHandler<AttachmentTappedEventArgs> AttachmentTapped
Event Type
Type
System.EventHandler<AttachmentTappedEventArgs>

CardTapped

Occurs when an card item is tapped in the SfAIAssistView.

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

ChatModeChanged

Occurs after the SfAIAssistView has transitioned to a different chat mode.

Declaration
public event EventHandler<ChatModeChangedEventArgs> ChatModeChanged
Event Type
Type
System.EventHandler<ChatModeChangedEventArgs>
Remarks

This event is raised after the chat mode change has been applied successfully.

ChatModeChanging

Occurs before the SfAIAssistView transitions between different chat modes.

Declaration
public event EventHandler<ChatModeChangingEventArgs> ChatModeChanging
Event Type
Type
System.EventHandler<ChatModeChangingEventArgs>
Remarks

This event is raised before the chat mode change is applied, allowing subscribers to cancel the mode change by setting System.ComponentModel.CancelEventArgs.Cancel to true.

ContextMenuOpening

Occurs when a context menu is about to be opened on any surface (Header, Request, or Response).

Declaration
public event EventHandler<ContextMenuOpeningEventArgs> ContextMenuOpening
Event Type
Type
System.EventHandler<ContextMenuOpeningEventArgs>
Remarks

This event fires before the context menu is rendered, allowing developers to customize menu items, modify the target information, or cancel the menu opening by setting to true.

ConversationItemTapped

Occurs when a conversation item is about to be selected from the conversation history.

Declaration
public event EventHandler<ConversationItemTappedEventArgs> ConversationItemTapped
Event Type
Type
System.EventHandler<ConversationItemTappedEventArgs>
Remarks

This event is raised before a conversation item is loaded, allowing subscribers to handle or cancel the selection by setting Handled to true.

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>

PromptComposing

Occurs before an AI request is sent, providing access to the fully composed prompt.

Declaration
public event EventHandler<PromptComposingEventArgs> PromptComposing
Event Type
Type
System.EventHandler<PromptComposingEventArgs>
Remarks

This event is raised after all prompt sources (SystemPrompt, ContextPrompt, PromptParts, and User input) have been merged into a single composed prompt. It allows subscribers to inspect the final prompt and the enabled prompt parts that compose it. The event args provide a read-only view of the composed prompt for logging, validation, or monitoring purposes.

Request

Occurs when a request is initiated in the SfAIAssistView.

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

Scrolled

Occurs when the view is scrolled.

Declaration
public event EventHandler<ScrolledEventArgs> Scrolled
Event Type
Type
System.EventHandler<ScrolledEventArgs>
Remarks

This event provides information about the current scroll state, including whether the view has reached the top or bottom of the conversation.

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>

ToastOpening

Occurs when a toast notification is about to be displayed.

Declaration
public event EventHandler<ToastNotificationEventArgs> ToastOpening
Event Type
Type
System.EventHandler<ToastNotificationEventArgs>
Remarks

This event is raised before a toast notification is shown, allowing subscribers to suppress the toast display by setting to true. This provides a mechanism to filter or control which toast notifications are actually displayed to the user.