ClassRadChat
Represents a chat control that provides a comprehensive messaging interface with support for various message types, user interactions, overlays, and customizable appearance settings.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Data Controls")]
[Docking(DockingBehavior.Ask)]
public class RadChat : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadChat
Implements:
Inherited Members
Constructors
Properties
Author
Gets or sets the current author that represents the primary user of the chat interface, used for message attribution, alignment, styling, and automatic message creation when AutoAddUserMessages is enabled.
AutoAddUserMessages
Gets or sets a value indicating whether messages typed by the user in the input text box will automatically be added as ChatTextMessage instances to the chat conversation.
Declaration
public bool AutoAddUserMessages { get; set; }Property Value
true if user messages are automatically added to the chat; otherwise, false. The default value is true.
AvatarSize
Gets or sets the size of the avatar images displayed next to messages in the chat interface, controlling the visual dimensions of user profile pictures.
ChatElement
Gets the main chat element that contains all messaging functionality, visual elements, and user interaction capabilities.
Declaration
public RadChatElement ChatElement { get; }Property Value
The RadChatElement instance that provides the core chat functionality.
DefaultSize
Gets the default size for the chat control, providing appropriate dimensions for typical chat interface layouts.
ShowAvatars
Gets or sets a value indicating whether avatar images will be displayed in the chat window next to messages, providing visual identification of message authors.
Declaration
public bool ShowAvatars { get; set; }Property Value
true if avatar images are displayed next to messages; otherwise, false. The default value is true.
ShowMessagesOnOneSide
Gets or sets a value indicating whether messages will be displayed aligned to only one side of the chat window or distributed on both sides based on the message author, affecting the overall conversation layout and visual flow.
Declaration
public bool ShowMessagesOnOneSide { get; set; }Property Value
true if all messages are aligned to one side regardless of author; false if messages are aligned based on their authors. The default value is false.
TimeSeparatorInterval
Gets or sets the time interval between messages that will trigger the automatic addition of a time separator element to visually group messages by time periods in the conversation.
Methods
AddMessage(ChatMessage)
Adds a new message to the chat conversation, supporting various message types including text messages, suggested actions, media content, cards, and overlays.
Declaration
public void AddMessage(ChatMessage message)Parameters
message
The ChatMessage to be displayed in the chat conversation. Typical message types include ChatTextMessage, ChatSuggestedActionsMessage, ChatMediaMessage, ChatCardMessage, and ChatOverlayMessage.
CreateChatElement()
Creates and returns a new instance of the chat element that provides the core messaging functionality for the control.
Declaration
protected virtual RadChatElement CreateChatElement()Returns
A new RadChatElement instance configured for chat operations.
CreateChildItems(RadElement)
Creates child elements for the chat control, including the main chat element that handles messaging functionality.
Declaration
protected override void CreateChildItems(RadElement parent)Parameters
parent
The parent RadElement that will contain the child elements.
Overrides
HideOverlay()
Hides any overlays that are currently displayed by the chat control, returning the interface to its normal messaging state.
Declaration
public virtual void HideOverlay()OnGotFocus(EventArgs)
Handles the GotFocus event by automatically focusing the input text box, ensuring users can immediately start typing messages when the chat control receives focus.
OnMouseWheel(MouseEventArgs)
Handles mouse wheel events to provide smooth scrolling functionality within the chat messages area, automatically calculating and applying appropriate scroll values.
Declaration
protected override void OnMouseWheel(MouseEventArgs e)Parameters
e
A MouseEventArgs that contains the mouse wheel event data including delta values for scroll calculations.
Overrides
ShowOverlay(ChatOverlayMessage)
Displays the specified overlay message in the chat control, providing a modal-like interface for user interactions such as confirmations, prompts, or custom input forms.
Declaration
public virtual void ShowOverlay(ChatOverlayMessage message)Parameters
message
The ChatOverlayMessage that contains the overlay information and configuration to be displayed.
Events
CardActionClicked
Occurs when the user clicks on a card action element within a ChatCardMessage, enabling interactive card-based interfaces and rich content interactions.
Declaration
public event CardActionEventHandler CardActionClickedEvent Value
ItemFormatting
Occurs when the data item of a visual element is changed and the element is prepared for visualization, allowing customization of message appearance, styling, and layout properties.
Declaration
public event ChatItemElementEventHandler ItemFormattingEvent Value
SendMessage
Occurs when the user performs a message-sending action such as pressing the Enter key, clicking the Send message button, clicking on a suggested action, clicking on a card action, or confirming an overlay interaction.
Declaration
public event SendMessageEventHandler SendMessageEvent Value
SuggestedActionClicked
Occurs when the user clicks on a suggested action element within a ChatSuggestedActionsMessage, providing quick response options and streamlined user interactions.
Declaration
public event SuggestedActionEventHandler SuggestedActionClickedEvent Value
TimeSeparatorAdding
Occurs after a new message is added to the chat but before it is displayed, allowing customization of whether a time separator should be inserted before the currently added message based on timing and context.
Declaration
public event TimeSeparatorEventHandler TimeSeparatorAddingEvent Value
ToolbarActionClicked
Occurs when the user clicks on a toolbar action element, providing access to chat-level functionality and administrative operations.
Declaration
public event ToolbarActionEventHandler ToolbarActionClickedEvent Value