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

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

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.

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.

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.

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

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

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

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

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.

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.

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

ToolbarHeightProperty

Identifies the ToolbarHeight bindable property.

Declaration

public static readonly BindableProperty ToolbarHeightProperty

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>

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>

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

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

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.

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

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

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

ShowHeader

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

ShowHeader

HeaderTemplate

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

ItemTappedCommand

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

ItemTapped

ItemLongPressedCommand

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

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

EditorViewTemplate

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.

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

ActionButtons

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

HeaderText

HeaderTemplate

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.

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.

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

EnableStopResponding

StopRespondingTemplate

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

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

ToolbarHeight

Gets or sets the height of the header Toolbar.

Declaration

public string ToolbarHeight { get; set; }

Property Value

Type
System.String

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()

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>

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>