Back to all docs
API Reference / Telerik.Windows.Controls / RadChat
New to Telerik UI for WPF? Start a free 30-day trial

RadChat

Class

RadChat is control that provides the look and feel of a chat application. It exposes API for managing and display of text and media messages.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.ConversationalUI.dll

Syntax:
C#
[TelerikToolboxCategory("ConversationalUI")]
public class RadChat : Control, IMessageReportSubscriber

Inheritance: objectRadChat

Derived Classes: PdfChat

Implements: IMessageReportSubscriber

Constructors

RadChat()

Initializes a new instance of the RadChat class.

C#
public RadChat()

Fields

AdditionalContentTemplateProperty

DependencyProperty

Identifies the AdditionalContentTemplateProperty dependency property.

C#
public static readonly DependencyProperty AdditionalContentTemplateProperty

AttachmentActionRequestedEvent

RoutedEvent

Identifies the event.

C#
public static readonly RoutedEvent AttachmentActionRequestedEvent

AutoIncludeTimeBreaksProperty

DependencyProperty

Identifies the AutoIncludeTimeBreaks dependency property.

C#
public static readonly DependencyProperty AutoIncludeTimeBreaksProperty

CanUserSelectMessageProperty

DependencyProperty

Identifies the CanUserSelectMessage dependency property.

C#
public static readonly DependencyProperty CanUserSelectMessageProperty

CurrentAuthorProperty

DependencyProperty

Identifies the CurrentAuthor dependency property.

C#
public static readonly DependencyProperty CurrentAuthorProperty

DataSourceProperty

DependencyProperty

Identifies the DataSource dependency property.

C#
public static readonly DependencyProperty DataSourceProperty

InputBoxTextProperty

DependencyProperty

Identifies the InputBoxText dependency property.

C#
public static readonly DependencyProperty InputBoxTextProperty

InputBoxWatermarkContentProperty

DependencyProperty

Identifies the InputBoxWatermarkContent dependency property.

C#
public static readonly DependencyProperty InputBoxWatermarkContentProperty

IsMoreButtonVisibleProperty

DependencyProperty

Identifies the IsMoreButtonVisible dependency property.

C#
public static readonly DependencyProperty IsMoreButtonVisibleProperty

IsSpeechToTextButtonVisibleProperty

DependencyProperty

Identifies the IsSpeechToTextButtonVisible dependency property.

C#
public static readonly DependencyProperty IsSpeechToTextButtonVisibleProperty

MaxVisibleAttachmentsProperty

DependencyProperty

Identifies the MaxVisibleAttachments dependency property.

C#
public static readonly DependencyProperty MaxVisibleAttachmentsProperty

MessageConverterProperty

DependencyProperty

Identifies the MessageConverter dependency property.

C#
public static readonly DependencyProperty MessageConverterProperty

MessageListTemplateSelectorProperty

DependencyProperty

Identifies the MessageListTemplateSelector dependency property.

C#
public static readonly DependencyProperty MessageListTemplateSelectorProperty

MessageOverlayTemplateSelectorProperty

DependencyProperty

Identifies the MessageOverlayTemplateSelector dependency property.

C#
public static readonly DependencyProperty MessageOverlayTemplateSelectorProperty

MessagePopupTemplateSelectorProperty

DependencyProperty

Identifies the MessagePopupTemplateSelector dependency property.

C#
public static readonly DependencyProperty MessagePopupTemplateSelectorProperty

RegenerateResponseEvent

RoutedEvent

Identifies the RegenerateResponse routed event.

C#
public static readonly RoutedEvent RegenerateResponseEvent
Remarks:

This event uses the bubbling routing strategy, allowing it to propagate from child to parent elements in the visual tree. It is typically used to signal that a response regeneration action has been requested.

ReportMessageResultEvent

RoutedEvent

Identifies the Event.

C#
public static readonly RoutedEvent ReportMessageResultEvent

SendButtonContentProperty

DependencyProperty

Identifies the SendButtonContent dependency property.

C#
public static readonly DependencyProperty SendButtonContentProperty

SendButtonContentTemplateProperty

DependencyProperty

Identifies the SendButtonContentTemplate dependency property.

C#
public static readonly DependencyProperty SendButtonContentTemplateProperty

SendCommandProperty

DependencyProperty

Identifies the SendCommand dependency property.

C#
public static readonly DependencyProperty SendCommandProperty

SendMessageEvent

RoutedEvent

Identifies the Event.

C#
public static readonly RoutedEvent SendMessageEvent

ShowOtherAuthorMessageBackgroundProperty

DependencyProperty

Identifies the ShowOtherAuthorMessageBackground dependency property.

C#
public static readonly DependencyProperty ShowOtherAuthorMessageBackgroundProperty

SuggestedActionReportedEvent

RoutedEvent

Identifies the Event.

C#
public static readonly RoutedEvent SuggestedActionReportedEvent

SuggestedActionsOrientationProperty

DependencyProperty

Identifies the SuggestedActionsOrientation dependency property.

C#
public static readonly DependencyProperty SuggestedActionsOrientationProperty

SuggestedActionsProperty

DependencyProperty

Identifies the SuggestedActions dependency property.

C#
public static readonly DependencyProperty SuggestedActionsProperty

SuggestedActionsVisibilityProperty

DependencyProperty

Identifies the SuggestedActionsVisibility dependency property.

C#
public static readonly DependencyProperty SuggestedActionsVisibilityProperty

TimeBreakFormatProperty

DependencyProperty

Identifies the TimeBreakFormat dependency property.

C#
public static readonly DependencyProperty TimeBreakFormatProperty

TimeBreakIntervalProperty

DependencyProperty

Identifies the TimeBreakInterval dependency property.

C#
public static readonly DependencyProperty TimeBreakIntervalProperty

TypingCommandProperty

DependencyProperty

Identifies the TypingCommand dependency property.

C#
public static readonly DependencyProperty TypingCommandProperty

TypingIndicatorIconProperty

DependencyProperty

Identifies the TypingIndicatorIcon dependency property.

C#
public static readonly DependencyProperty TypingIndicatorIconProperty

TypingIndicatorTextProperty

DependencyProperty

Identifies the TypingIndicatorText dependency property.

C#
public static readonly DependencyProperty TypingIndicatorTextProperty

TypingIndicatorVisibilityProperty

DependencyProperty

Identifies the TypingIndicatorVisibility dependency property.

C#
public static readonly DependencyProperty TypingIndicatorVisibilityProperty

UserVotedEvent

RoutedEvent

Identifies the event.

C#
public static readonly RoutedEvent UserVotedEvent

VerticalAvatarAlignmentProperty

DependencyProperty

Identifies the VerticalAvatarAlignment dependency property.

C#
public static readonly DependencyProperty VerticalAvatarAlignmentProperty

Properties

AdditionalContentTemplate

DataTemplate

Gets or sets the custom data template used to display suggestions in the suggestion list.

C#
public DataTemplate AdditionalContentTemplate { get; set; }

AutoIncludeTimeBreaks

Gets or sets value indicating whether TimeBreaks are automatically included.

C#
public bool AutoIncludeTimeBreaks { get; set; }

CanUserSelectMessage

Gets or sets value indicating whether users can select inline messages through the UI.

C#
public bool CanUserSelectMessage { get; set; }

CurrentAuthor

Gets or sets the current author.

C#
public Author CurrentAuthor { get; set; }

DataSource

Gets or sets a data source that will be used to generate messages in data-bound scenarios.

C#
public IEnumerable DataSource { get; set; }

InlineMessages

Gets the collection of inline messages.

C#
protected virtual IEnumerable<MessageBase> InlineMessages { get; }

InputBoxText

Gets or sets the input box text.

C#
public string InputBoxText { get; set; }

InputBoxWatermarkContent

Gets or sets the input box watermark content.

C#
public object InputBoxWatermarkContent { get; set; }

IsMoreButtonVisible

Gets or sets a value indicating whether the more button is visible in the prompt input.

C#
public bool IsMoreButtonVisible { get; set; }

IsSpeechToTextButtonVisible

Gets or sets a value indicating whether the speech-to-text button is visible in the prompt input.

C#
public bool IsSpeechToTextButtonVisible { get; set; }

LastMessage

Gets the last message.

C#
public virtual InlineViewModel LastMessage { get; }

LastMessageGroup

Gets the last message group.

C#
public virtual MessageGroupViewModel LastMessageGroup { get; }

MaxVisibleAttachments

Gets or sets the maximum number of attachments visible before the rest are collapsed behind an expand button.

C#
public int MaxVisibleAttachments { get; set; }

MessageConverter

Gets or sets an IMessageConverter that will be used for converting messages to DataSource type vice versa.

C#
public IMessageConverter MessageConverter { get; set; }

MessageGroups

Gets the collection of MessageGroups.

C#
public ObservableCollection<MessageGroupViewModel> MessageGroups { get; }

MessageListItems

Gets the collection of MessageListItems (MessageGroups and TimeBreaks).

C#
public ObservableCollection<MessageListItemViewModelBase> MessageListItems { get; }

MessageListTemplateSelector

Gets or sets the DataTemplate selector that is used for displaying messages in ChatMessageList.

C#
public MessageTemplateSelector MessageListTemplateSelector { get; set; }

MessageOverlayTemplateSelector

Gets or sets the DataTemplate selector that is used for displaying messages in ChatOverlay.

C#
public MessageTemplateSelector MessageOverlayTemplateSelector { get; set; }

MessagePopupTemplateSelector

Gets or sets the DataTemplate selector that is used for displaying messages in ChatPopupPlaceholder.

C#
public MessageTemplateSelector MessagePopupTemplateSelector { get; set; }

MessageReporter

Gets the MessageReporter control that processes result actions.

C#
public MessageReporter MessageReporter { get; }

Implements: IMessageReportSubscriber.MessageReporter

SendButtonContent

Gets or sets the content to display inside the send button of the prompt input. When set, this replaces the default send/stop glyph icons.

C#
public object SendButtonContent { get; set; }

SendButtonContentTemplate

DataTemplate

Gets or sets the data template used to display the SendButtonContent.

C#
public DataTemplate SendButtonContentTemplate { get; set; }

SendCommand

Gets or sets the command that is executed when a new message is typed in the UI and then sent.

C#
public ICommand SendCommand { get; set; }

ShowOtherAuthorMessageBackground

Gets or sets a value indicating whether the background of messages from other authors is visible.

C#
public bool ShowOtherAuthorMessageBackground { get; set; }

SuggestedActions

Gets or sets the list of suggested actions.

C#
public ObservableCollection<SuggestedAction> SuggestedActions { get; set; }

SuggestedActionsOrientation

Orientation

Gets or sets the orientation of suggested action panel.

C#
public Orientation SuggestedActionsOrientation { get; set; }

SuggestedActionsVisibility

Visibility

Gets or sets a value that indicates whether suggested action panel is visible or not.

C#
public Visibility SuggestedActionsVisibility { get; set; }

TimeBreakFormat

Gets or sets the DateTime string format that is used to display time breaks.

C#
public string TimeBreakFormat { get; set; }

TimeBreakInterval

Gets or sets the interval that should be use to automatically place time breaks.

C#
public TimeSpan? TimeBreakInterval { get; set; }

TypingCommand

Gets or sets the command that should be executed on typing.

C#
public ICommand TypingCommand { get; set; }

TypingIndicatorIcon

ImageSource

Gets or sets the icon of the typing indicator.

C#
public ImageSource TypingIndicatorIcon { get; set; }

TypingIndicatorText

Gets or sets the text of the typing indicator.

C#
public string TypingIndicatorText { get; set; }

TypingIndicatorVisibility

Visibility

Gets or sets a value that indicates whether the typing indicator is visible or not.

C#
public Visibility TypingIndicatorVisibility { get; set; }

VerticalAvatarAlignment

VerticalAlignment

Gets or sets the vertical alignment for Author's Avatar.

C#
public VerticalAlignment VerticalAvatarAlignment { get; set; }

Methods

AddMessage(Author, string)

Adds a new Message to RadChat.

C#
public virtual void AddMessage(Author author, string messageText)
Parameters:authorAuthormessageTextstring

AddMessage(MessageBase)

Adds a new Message to RadChat.

C#
public virtual void AddMessage(MessageBase message)
Parameters:messageMessageBase

AddTimeBreak(string)

Adds a time break with the given header.

C#
public virtual void AddTimeBreak(string header)
Parameters:headerstring

CloseOverlay()

Closes the overlay view and its content.

C#
public void CloseOverlay()

ClosePopup()

Closes the popup placeholder view and its content.

C#
public void ClosePopup()

ConvertItemToMessage(object)

Uses the given MessageConverter to convert data item to message.

C#
protected virtual MessageBase ConvertItemToMessage(object item)
Parameters:itemobjectReturns:

MessageBase

ConvertMessageToDataItem(MessageBase)

Uses the given MessageConverter to convert message to data object.

C#
protected virtual object ConvertMessageToDataItem(MessageBase message)
Parameters:messageMessageBaseReturns:

object

CreateMessageGroup(Author)

Creates a new message group for the given author.

C#
protected virtual MessageGroupViewModel CreateMessageGroup(Author author)
Parameters:authorAuthorReturns:

MessageGroupViewModel

GetMessageByIndex(int)

Returns the inline message by its index position.

C#
public virtual MessageBase GetMessageByIndex(int index)
Parameters:indexintReturns:

MessageBase

OnAddingTimeBreak(TimeBreakEventArgs)

Raises the AddingTimeBreak event.

C#
protected virtual void OnAddingTimeBreak(TimeBreakEventArgs timeBreakArgs)
Parameters:timeBreakArgsTimeBreakEventArgs

OnApplyTemplate()

C#
public override void OnApplyTemplate()

OnAttachmentActionRequested(AttachmentActionEventArgs)

Raises the AttachmentActionRequested event.

C#
protected virtual void OnAttachmentActionRequested(AttachmentActionEventArgs args)
Parameters:argsAttachmentActionEventArgs

The event arguments.

OnCreateAutomationPeer()

AutomationPeer

Returns an automation peer for this RadChat.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

OnInitialized(EventArgs)

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

OnRegenerateResponse(RegenerateResponseEventArgs)

Raises the RegenerateResponse event.

C#
protected virtual void OnRegenerateResponse(RegenerateResponseEventArgs args)
Parameters:argsRegenerateResponseEventArgs

The event arguments.

OnReportMessageResult(MessageResultEventArgs)

Raises the ReportMessageResult event.

C#
protected virtual void OnReportMessageResult(MessageResultEventArgs args)
Parameters:argsMessageResultEventArgs

OnSendMessage(SendMessageEventArgs)

Raises the SendMessage routed event.

C#
protected virtual void OnSendMessage(SendMessageEventArgs args)
Parameters:argsSendMessageEventArgs

OnSuggestedActionReported(SuggestedActionsEventArgs)

Raises the SuggestedActionReported event.

C#
protected virtual void OnSuggestedActionReported(SuggestedActionsEventArgs suggestedActionsArgs)
Parameters:suggestedActionsArgsSuggestedActionsEventArgs

OnUserVoted(UserVotedEventArgs)

Raises the UserVoted event.

C#
protected virtual void OnUserVoted(UserVotedEventArgs args)
Parameters:argsUserVotedEventArgs

The event arguments.

RebindDataSource()

Rebinds the RadChat, using the collection set as DataSource.

C#
protected virtual void RebindDataSource()

RemoveMessage(MessageBase)

Removes an existing inline message from RadChat.

C#
public virtual void RemoveMessage(MessageBase message)
Parameters:messageMessageBase

Implements: IMessageReportSubscriber.RemoveMessage(MessageBase)

ShowMessageInOverlay(MessageBase)

Adds a message as overlay content.

C#
protected void ShowMessageInOverlay(MessageBase message)
Parameters:messageMessageBase

ShowMessageInPopup(MessageBase)

Adds a message as popup content.

C#
protected void ShowMessageInPopup(MessageBase message)
Parameters:messageMessageBase

Events

AddingTimeBreak

Event is raised when time break is added.

C#
public event EventHandler<TimeBreakEventArgs> AddingTimeBreak

AttachmentActionRequested

Occurs when an attachment action (download, share) is requested.

C#
public event EventHandler<AttachmentActionEventArgs> AttachmentActionRequested

RegenerateResponse

Occurs when a response needs to be regenerated.

C#
public event EventHandler<RegenerateResponseEventArgs> RegenerateResponse
Remarks:

This event is triggered to signal that a response should be regenerated. Subscribers can handle this event to perform custom logic when a regeneration is required.

ReportMessageResult

Event is raised when response action reports result.

C#
public event EventHandler<MessageResultEventArgs> ReportMessageResult

SendMessage

Event is raised when a new message is typed and sent by the current author.

C#
public event EventHandler<SendMessageEventArgs> SendMessage

SuggestedActionReported

Event is raised when suggested action reports result.

C#
public event EventHandler<SuggestedActionsEventArgs> SuggestedActionReported

UserVoted

Occurs when a user votes (e.g., upvote or downvote) on a message.

C#
public event EventHandler<UserVotedEventArgs> UserVoted
In this article
DefinitionConstructorsRadChat()FieldsAdditionalContentTemplatePropertyAttachmentActionRequestedEventAutoIncludeTimeBreaksPropertyCanUserSelectMessagePropertyCurrentAuthorPropertyDataSourcePropertyInputBoxTextPropertyInputBoxWatermarkContentPropertyIsMoreButtonVisiblePropertyIsSpeechToTextButtonVisiblePropertyMaxVisibleAttachmentsPropertyMessageConverterPropertyMessageListTemplateSelectorPropertyMessageOverlayTemplateSelectorPropertyMessagePopupTemplateSelectorPropertyRegenerateResponseEventReportMessageResultEventSendButtonContentPropertySendButtonContentTemplatePropertySendCommandPropertySendMessageEventShowOtherAuthorMessageBackgroundPropertySuggestedActionReportedEventSuggestedActionsOrientationPropertySuggestedActionsPropertySuggestedActionsVisibilityPropertyTimeBreakFormatPropertyTimeBreakIntervalPropertyTypingCommandPropertyTypingIndicatorIconPropertyTypingIndicatorTextPropertyTypingIndicatorVisibilityPropertyUserVotedEventVerticalAvatarAlignmentPropertyPropertiesAdditionalContentTemplateAutoIncludeTimeBreaksCanUserSelectMessageCurrentAuthorDataSourceInlineMessagesInputBoxTextInputBoxWatermarkContentIsMoreButtonVisibleIsSpeechToTextButtonVisibleLastMessageLastMessageGroupMaxVisibleAttachmentsMessageConverterMessageGroupsMessageListItemsMessageListTemplateSelectorMessageOverlayTemplateSelectorMessagePopupTemplateSelectorMessageReporterSendButtonContentSendButtonContentTemplateSendCommandShowOtherAuthorMessageBackgroundSuggestedActionsSuggestedActionsOrientationSuggestedActionsVisibilityTimeBreakFormatTimeBreakIntervalTypingCommandTypingIndicatorIconTypingIndicatorTextTypingIndicatorVisibilityVerticalAvatarAlignmentMethodsAddMessage(Author, string)AddMessage(MessageBase)AddTimeBreak(string)CloseOverlay()ClosePopup()ConvertItemToMessage(object)ConvertMessageToDataItem(MessageBase)CreateMessageGroup(Author)GetMessageByIndex(int)OnAddingTimeBreak(TimeBreakEventArgs)OnApplyTemplate()OnAttachmentActionRequested(AttachmentActionEventArgs)OnCreateAutomationPeer()OnInitialized(EventArgs)OnRegenerateResponse(RegenerateResponseEventArgs)OnReportMessageResult(MessageResultEventArgs)OnSendMessage(SendMessageEventArgs)OnSuggestedActionReported(SuggestedActionsEventArgs)OnUserVoted(UserVotedEventArgs)RebindDataSource()RemoveMessage(MessageBase)ShowMessageInOverlay(MessageBase)ShowMessageInPopup(MessageBase)EventsAddingTimeBreakAttachmentActionRequestedRegenerateResponseReportMessageResultSendMessageSuggestedActionReportedUserVoted
Not finding the help you need?
Contact Support