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.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:

cs-api-definition

public class RadChat : RadContentView, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Inheritance: objectRadContentViewRadChat

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadContentViewITransformIView

Inherited Members RadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnHandlerChanged()

Constructors

RadChat()

Initializes a new instance of the RadChat class.

Declaration

cs-api-definition

public RadChat()

Fields

ActualScrollMediatorModeProperty

Identifies the ActualScrollMediator property.

Declaration

cs-api-definition

public static readonly BindableProperty ActualScrollMediatorModeProperty

Field Value

BindableProperty

ActualSendMessageCommandProperty

Identifies the ActualSendMessageCommand property.

Declaration

cs-api-definition

public static readonly BindableProperty ActualSendMessageCommandProperty

Field Value

BindableProperty

AuthorProperty

Identifies the Author property.

Declaration

cs-api-definition

public static readonly BindableProperty AuthorProperty

Field Value

BindableProperty

AutoScrollModeProperty

Identifies the AutoScrollMode property.

Declaration

cs-api-definition

public static readonly BindableProperty AutoScrollModeProperty

Field Value

BindableProperty

BackgroundColorProperty

Identifies the BackgroundColor property.

Declaration

cs-api-definition

public static readonly BindableProperty BackgroundColorProperty

Field Value

BindableProperty

InputAreaBackgroundColorProperty

Identifies the InputAreaBackgroundColor property.

Declaration

cs-api-definition

public static readonly BindableProperty InputAreaBackgroundColorProperty

Field Value

BindableProperty

ItemConverterProperty

Identifies the ItemConverter property.

Declaration

cs-api-definition

public static readonly BindableProperty ItemConverterProperty

Field Value

BindableProperty

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector property.

Declaration

cs-api-definition

public static readonly BindableProperty ItemTemplateSelectorProperty

Field Value

BindableProperty

ItemsSourceProperty

Identifies the ItemsSource property.

Declaration

cs-api-definition

public static readonly BindableProperty ItemsSourceProperty

Field Value

BindableProperty

MessageProperty

Identifies the Message property.

Declaration

cs-api-definition

public static readonly BindableProperty MessageProperty

Field Value

BindableProperty

PickerProperty

Identifies the Picker property.

Declaration

cs-api-definition

public static readonly BindableProperty PickerProperty

Field Value

BindableProperty

SendMessageButtonImageProperty

Identifies the SendMessageButtonImage property.

Declaration

cs-api-definition

public static readonly BindableProperty SendMessageButtonImageProperty

Field Value

BindableProperty

SendMessageCommandProperty

Identifies the SendMessageCommand property.

Declaration

cs-api-definition

public static readonly BindableProperty SendMessageCommandProperty

Field Value

BindableProperty

TypingIndicatorProperty

Identifies the TypingIndicator property.

Declaration

cs-api-definition

public static readonly BindableProperty TypingIndicatorProperty

Field Value

BindableProperty

Properties

ActualScrollMediator

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

Declaration

cs-api-definition

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

cs-api-definition

public ICommand ActualSendMessageCommand { get; }

Property Value

ICommand

Author

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

Declaration

cs-api-definition

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

cs-api-definition

public AutoScrollMode AutoScrollMode { get; set; }

Property Value

AutoScrollMode

BackgroundColor

Declaration

cs-api-definition

public Color BackgroundColor { get; set; }

Property Value

Color

InputAreaBackgroundColor

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

Declaration

cs-api-definition

public Color InputAreaBackgroundColor { get; set; }

Property Value

Color

ItemConverter

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

Declaration

cs-api-definition

public IChatItemConverter ItemConverter { get; set; }

Property Value

IChatItemConverter

ItemTemplateSelector

Gets or sets the template selector for visualizing chat items.

Declaration

cs-api-definition

public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

DataTemplateSelector

Items

Gets the collection of chat items.

Declaration

cs-api-definition

public IList<ChatItem> Items { get; }

Property Value

IList<ChatItem>

ItemsSource

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

Declaration

cs-api-definition

public IEnumerable ItemsSource { get; set; }

Property Value

IEnumerable

Message

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

Declaration

cs-api-definition

public object Message { get; set; }

Property Value

object

Picker

Gets or sets the inline picker of the chat.

Declaration

cs-api-definition

public View Picker { get; set; }

Property Value

View

SendMessageButtonImage

Gets or sets the image for the send message button.

Declaration

cs-api-definition

public ImageSource SendMessageButtonImage { get; set; }

Property Value

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). The parameter of this command is of type object and the value is the same as the Message property.

Declaration

cs-api-definition

public ICommand SendMessageCommand { get; set; }

Property Value

ICommand

TypingIndicator

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

Declaration

cs-api-definition

public View TypingIndicator { get; set; }

Property Value

View

Methods

FocusEntry()

Attempts to set focus to the entry element.

Declaration

cs-api-definition

public bool FocusEntry()

Returns

bool

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

cs-api-definition

protected override void OnApplyTemplate()

OnBindingContextChanged()

Called when the binding context changes.

Declaration

cs-api-definition

protected override void OnBindingContextChanged()

Overrides RadContentView.OnBindingContextChanged()

OnPropertyChanged(string)

Declaration

cs-api-definition

protected override void OnPropertyChanged(string propertyName = null)

Parameters

propertyName

string

ScrollTo(int)

Scrolls to the item at the provided index.

Declaration

cs-api-definition

public void ScrollTo(int index)

Parameters

index

int

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

cs-api-definition

public event EventHandler SendMessage

Event Value

EventHandler

ClassRadChat

Class
RadChat