Documentation

Class RadChat

A component that visualizes chat conversation between two or more participants. Has a built-in mechanism for displaying time-pickers, action-cards, and other things that bot services commonly use. Has a built-in TypingIndicator to let the user know if othe participants in the chat are currently writing.

Inheritance
System.Object
RadContentView
RadChat
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadChat : RadContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout, IItemConverter<ChatItem>

Constructors

RadChat()

Initializes a new instance of the RadChat class.

Declaration
public RadChat()

Fields

ActualScrollMediatorModeProperty

Identifies the ActualScrollMediator property.

Declaration
public static readonly BindableProperty ActualScrollMediatorModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ActualSendMessageCommandProperty

Identifies the ActualSendMessageCommand property.

Declaration
public static readonly BindableProperty ActualSendMessageCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

AuthorProperty

Identifies the Author property.

Declaration
public static readonly BindableProperty AuthorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

AutoScrollModeProperty

Identifies the AutoScrollMode property.

Declaration
public static readonly BindableProperty AutoScrollModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

BackgroundColorProperty

Identifies the BackgroundColor property.

Declaration
public static readonly BindableProperty BackgroundColorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

InputAreaBackgroundColorProperty

Identifies the InputAreaBackgroundColor property.

Declaration
public static readonly BindableProperty InputAreaBackgroundColorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemConverterProperty

Identifies the ItemConverter property.

Declaration
public static readonly BindableProperty ItemConverterProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemsSourceProperty

Identifies the ItemsSource property.

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

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector property.

Declaration
public static readonly BindableProperty ItemTemplateSelectorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

MessageProperty

Identifies the Message property.

Declaration
public static readonly BindableProperty MessageProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

PickerProperty

Identifies the Picker property.

Declaration
public static readonly BindableProperty PickerProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SendMessageButtonImageProperty

Identifies the SendMessageButtonImage property.

Declaration
public static readonly BindableProperty SendMessageButtonImageProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SendMessageCommandProperty

Identifies the SendMessageCommand property.

Declaration
public static readonly BindableProperty SendMessageCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

TypingIndicatorProperty

Identifies the TypingIndicator property.

Declaration
public static readonly BindableProperty TypingIndicatorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

ActualScrollMediator

Gets or sets the actual ScrollMediator used by the chat to mediate the scrolling functionality.

Declaration
public ScrollMediator ActualScrollMediator { get; }
Property Value
ScrollMediator

ActualSendMessageCommand

Gets the actual send command that is executed when sending a message. This command will execute the custom SendMessageCommand.

Declaration
public ICommand ActualSendMessageCommand { get; }
Property Value
System.Windows.Input.ICommand

Author

Gets or sets the current author of outgoing messages in the chat.

Declaration
public Author Author { get; set; }
Property Value
Author

AutoScrollMode

Gets or sets the mode which defines the automatic scrolling behavior of the RadChatListView when a message is sent or received.

Declaration
public AutoScrollMode AutoScrollMode { get; set; }
Property Value
AutoScrollMode

BackgroundColor

Declaration
public Color BackgroundColor { get; set; }
Property Value
Microsoft.Maui.Graphics.Color

InputAreaBackgroundColor

Gets or sets the background color of the area that the input elements (entry and button) are reside.

Declaration
public Color InputAreaBackgroundColor { get; set; }
Property Value
Microsoft.Maui.Graphics.Color

ItemConverter

Gets or sets the converter that performs the conversion between data and chat items.

Declaration
public IChatItemConverter ItemConverter { get; set; }
Property Value
IChatItemConverter

Items

Gets the collection of chat items.

Declaration
public IList<ChatItem> Items { get; }
Property Value
System.Collections.Generic.IList<ChatItem>

ItemsSource

Gets or sets the items source from which chat items are generated.

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

ItemTemplateSelector

Gets or sets the template selector for visualizing chat items.

Declaration
public DataTemplateSelector ItemTemplateSelector { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplateSelector

Message

Gets or sets the message that is typed in the chat entry.

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

Picker

Gets or sets the inline picker of the chat.

Declaration
public View Picker { get; set; }
Property Value
Microsoft.Maui.Controls.View

SendMessageButtonImage

Gets or sets the image for the send message button.

Declaration
public ImageSource SendMessageButtonImage { get; set; }
Property Value
Microsoft.Maui.Controls.ImageSource

SendMessageCommand

Gets or sets the custom command that will be executed when sending a message (when the Send message button is pressed or Enter is pressed).

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

TypingIndicator

Gets or sets the typing indicator displayed when another author is typing.

Declaration
public View TypingIndicator { get; set; }
Property Value
Microsoft.Maui.Controls.View

Methods

FocusEntry()

Attemps to set focus to the entry element.

Declaration
public bool FocusEntry()
Returns
System.Boolean

true if the keyboard focus was set to the entry element; false if the call to this method did not force a focus change.

OnApplyTemplate()

Declaration
protected override void OnApplyTemplate()

OnBindingContextChanged()

Declaration
protected override void OnBindingContextChanged()
Overrides

OnPropertyChanged(String)

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

ScrollTo(Int32)

Scrolls to the item at the provided index.

Declaration
public void ScrollTo(int index)
Parameters
System.Int32 index

The index of the item to scroll to.

Events

SendMessage

Raised when a message is sent from the chat by the current author (by clicking the send messsage button or pressing Enter).

Declaration
public event EventHandler SendMessage
Event Type
System.EventHandler

Extension Methods