Class

RadChatElement

Initializes a new instance of the RadChatElement class with default settings and event wire-up for chat functionality.

Declaration

public RadChatElement()

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.

Declaration

public virtual Author Author { get; set; }

Property Value

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

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.

Declaration

public SizeF AvatarSize { get; set; }

Property Value

Gets or sets the chat factory instance used for creating chat-related data items and elements, providing extensibility for custom chat component creation.

Declaration

public ChatFactory ChatFactory { get; set; }

Property Value

Gets the message that is currently being edited, or null if not in edit mode.

Declaration

public ChatMessage EditMessage { get; }

Property Value

Gets the edit preview element that is shown above the input text box when editing a message.

Declaration

public ChatEditPreviewElement EditPreviewElement { get; }

Property Value

Gets or sets a value indicating whether the reply functionality is enabled. When disabled, the Reply button and context menu item are hidden and StartReply(ChatMessage) is a no-op.

Declaration

public bool EnableReplies { get; set; }

Property Value

Gets the input text box element where users type their messages, providing text entry capabilities with support for keyboard shortcuts and clipboard operations.

Declaration

public RadTextBoxElement InputTextBox { get; }

Property Value

Gets a value indicating whether the chat is currently in edit mode.

Declaration

public bool IsEditMode { get; }

Property Value

Gets or sets a value indicating whether the hosted prompt input displays its more-actions button.

Declaration

public bool IsMoreButtonVisible { get; set; }

Property Value

Gets a value indicating whether the chat is currently replying to multiple messages.

Declaration

public bool IsMultiReplyMode { get; }

Property Value

Gets a value indicating whether an overlay is currently displayed, covering the entire chat interface for modal interactions.

Declaration

public bool IsOverlayShown { get; protected set; }

Property Value

Gets a value indicating whether a popup overlay is currently displayed, appearing above the chat interface without completely blocking the conversation view.

Declaration

public bool IsPopupOverlayShown { get; protected set; }

Property Value

Gets a value indicating whether the chat is currently in reply mode.

Declaration

public bool IsReplyMode { get; }

Property Value

Gets or sets a value indicating whether the hosted prompt input displays its speech-to-text button.

Declaration

public bool IsSpeechToTextButtonVisible { get; set; }

Property Value

Gets or sets the maximum number of messages that can be replied to at once.

Declaration

public int MaxReplyMessages { get; set; }

Property Value

Gets or sets the maximum number of visible attachment rows shown by the hosted prompt input before its attachment area becomes scrollable.

Declaration

public int MaxVisibleAttachments { get; set; }

Property Value

Gets the messages view element that contains, displays, and manages all chat messages with scrolling capabilities and message virtualization support.

Declaration

public ChatMessagesViewElement MessagesViewElement { get; }

Property Value

Gets the overlay element used for displaying modal content that covers the entire chat interface for important user interactions and confirmations.

Declaration

public LightVisualElement OverlayElement { get; }

Property Value

Gets the overlay popup element used for displaying popup-style content that appears above the chat interface without completely blocking the underlying conversation.

Declaration

public LightVisualElement OverlayPopupElement { get; }

Property Value

Gets the prompt input element that provides comprehensive input functionality including text entry, attached files, speech-to-text, and send capabilities.

Declaration

public RadPromptInputElement PromptInputElement { get; }

Property Value

Gets the reply preview element that is shown above the input text box when replying to a message.

Declaration

public ChatReplyPreviewElement ReplyPreviewElement { get; }

Property Value

Gets the message that is currently being replied to, or null if not in reply mode. Returns the first message if replying to multiple messages.

Declaration

public ChatMessage ReplyToMessage { get; }

Property Value

Gets the messages that are currently being replied to.

Declaration

public IReadOnlyList<ChatMessage> ReplyToMessages { get; }

Property Value

Gets the send button element that enables users to submit their typed messages to the chat conversation with visual feedback and interaction support.

Declaration

public ChatSendButtonElement SendButtonElement { get; }

Property Value

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

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.

Declaration

public bool ShowMessagesOnOneSide { get; set; }

Property Value

Gets the show toolbar button element that provides toggle functionality for the chat toolbar visibility, allowing users to access extended features on demand.

Declaration

public ChatShowToolbarElement ShowToolbarButtonElement { get; }

Property Value

Gets the suggested actions element that displays and manages quick action buttons for streamlined user interactions and response shortcuts.

Declaration

public ChatSuggestedActionsElement SuggestedActionsElement { get; }

Property Value

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.

Declaration

public TimeSpan TimeSeparatorInterval { get; set; }

Property Value

Gets the toolbar element that contains action buttons, controls, and extended functionality options for enhanced chat user interactions.

Declaration

public ChatToolbarElement ToolbarElement { get; }

Property Value

Adds a new message to the chat conversation, supporting various message types and automatically handling scrolling, suggested actions, and overlay display based on the message type.

Declaration

public virtual void AddMessage(ChatMessage message)

Parameters

Cancels the current edit operation, clearing the input text box.

Declaration

public virtual void CancelEdit()

Cancels the current reply operation, hiding the reply preview.

Declaration

public virtual void CancelReply()

Creates the child elements that make up the chat interface, including the stack layout, messages view, input controls, toolbar, and overlay elements.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates and configures the edit preview element that is shown above the input text box when editing a message.

Declaration

protected virtual ChatEditPreviewElement CreateEditPreviewElement()

Returns

Creates and configures the messages view element that contains and displays all chat messages with automatic sizing capabilities.

Declaration

protected virtual ChatMessagesViewElement CreateMessagesListView()

Returns

Creates and configures the overlay popup element that displays popup-style overlays for modal interactions and user prompts.

Declaration

protected virtual OverlayPopupElement CreateOverlayPopupElement()

Returns

Creates and configures the prompt input element that provides comprehensive input functionality including text entry, attached files, speech-to-text, and send capabilities.

Declaration

protected virtual RadPromptInputElement CreatePromptInputElement()

Returns

Creates and configures the reply preview element that is shown above the input text box when replying to a message.

Declaration

protected virtual ChatReplyPreviewElement CreateReplyPreviewElement()

Returns

Creates and configures the show toolbar button element that toggles the visibility of the chat toolbar containing action buttons and controls.

Declaration

protected virtual ChatShowToolbarElement CreateShowToolbarButton()

Returns

Creates and configures the main stack layout element that organizes all chat components vertically with proper sizing and orientation settings.

Declaration

protected virtual StackLayoutElement CreateStackLayoutElement()

Returns

Creates and configures the suggested actions element that displays quick action buttons for user interaction and response shortcuts.

Declaration

protected virtual ChatSuggestedActionsElement CreateSuggestedActionsElement()

Returns

Creates and configures the toolbar element that contains action buttons and controls for extended chat functionality and user interactions.

Declaration

protected virtual ChatToolbarElement CreateToolbarElement()

Returns

Creates and configures the typing indicator element that displays visual feedback when users or other participants are actively typing messages.

Declaration

protected virtual LightVisualElement CreateTypingIndicatorElement()

Returns

Deletes the specified message from the chat conversation.

Declaration

public virtual bool DeleteMessage(ChatMessage message)

Parameters

Returns

Disposes managed resources and unwires event handlers to ensure proper cleanup when the chat element is destroyed.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Hides any overlays that are currently displayed by the chat control, restoring normal chat functionality and returning focus to the input text box.

Declaration

public virtual void HideOverlay()

Hides the typing indicator, removing the visual feedback about users typing and clearing any associated text or animation.

Declaration

public virtual void HideTypingIndicator()

Raises the AttachmentActionRequested event and, if the event is not handled, executes the default behavior for the requested AttachmentAction.

Declaration

protected virtual void OnAttachmentActionRequested(AttachmentActionEventArgs e)

Parameters

Raises the CardActionClicked event when a user clicks on a card action, providing event arguments with the action details and source card information.

Declaration

protected virtual void OnCardActionClicked(object sender, CardActionEventArgs e)

Parameters

Raises the Copy event using the specified event data.

Declaration

protected virtual void OnCopy(CopyEventArgs e)

Parameters

Remarks

Raises the EditCancelled event when the user cancels editing a message.

Declaration

protected virtual void OnEditCancelled(EventArgs e)

Parameters

Raises the EditStarted event when the user starts editing a message.

Declaration

protected virtual void OnEditStarted(ReplyEventArgs e)

Parameters

Handles key down events in the input text box, processing Enter key to send messages, Shift+Enter for new lines, and Ctrl+V paste operations for images from the clipboard.

Declaration

protected virtual void OnInputTextBoxKeyDown(object sender, KeyEventArgs e)

Parameters

Raises the ItemFormatting event when a chat item element is being prepared for display, allowing custom formatting and styling of message elements.

Declaration

protected virtual void OnItemFormatting(ChatItemElementEventArgs e)

Parameters

Raises the MessageDeleted event when a message has been deleted.

Declaration

protected virtual void OnMessageDeleted(MessageDeletedEventArgs e)

Parameters

Raises the MessageEdited event when a message has been edited.

Declaration

protected virtual void OnMessageEdited(MessageEditedEventArgs e)

Parameters

Handles the SendMessage event from the PromptInputElement, submitting user messages when text or attached files are provided.

Declaration

protected virtual void OnPromptInputSendMessage(object sender, PromptInputSendMessageEventArgs e)

Parameters

Handles property change events by invalidating the fill cache and invoking the base class property change handler.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the RegenerateResponse event using the specified event data.

Declaration

protected virtual void OnRegenerateResponse(RegenerateResponseEventArgs e)

Parameters

Remarks

Raises the ReplyBubbleClicked event when a reply bubble is clicked.

Declaration

protected virtual void OnReplyBubbleClicked(ReplyBubbleClickedEventArgs e)

Parameters

Raises the ReplyCancelled event when the user cancels replying to a message.

Declaration

protected virtual void OnReplyCancelled(EventArgs e)

Parameters

Raises the ReplyStarted event when the user starts replying to messages.

Declaration

protected virtual void OnReplyStarted(ReplyEventArgs e)

Parameters

Raises the SendMessage event when a user action triggers message sending, providing event arguments with the message details.

Declaration

protected virtual void OnSendMessage(SendMessageEventArgs e)

Parameters

Handles click events on the show toolbar button element, toggling the visibility of the chat toolbar to provide access to extended functionality.

Declaration

protected virtual void OnShowToolbarButtonElementClick(object sender, EventArgs e)

Parameters

Raises the SuggestedActionClicked event when a user clicks on a suggested action, providing event arguments with the action details.

Declaration

protected virtual void OnSuggestedActionClicked(SuggestedActionEventArgs e)

Parameters

Raises the TimeSeparatorAdding event when a message is being added, allowing custom logic to determine time separator insertion.

Declaration

protected virtual void OnTimeSeparatorAdding(TimeSeparatorEventArgs e)

Parameters

Raises the ToolbarActionClicked event when a user clicks on a toolbar action, providing event arguments with the action details.

Declaration

protected virtual void OnToolbarActionClick(ToolbarActionEventArgs e)

Parameters

Raises the UserVoted event using the specified event data.

Declaration

protected virtual void OnUserVoted(UserVotedEventArgs e)

Parameters

Remarks

Raises the VisualItemCreating event to allow customization or handling when a visual item is being created.

Declaration

protected virtual void OnVisualItemCreating(VisualItemCreatingEventArgs e)

Parameters

Remarks

Performs post-paint operations for child elements, including custom border painting to enhance the visual appearance of the chat interface.

Declaration

protected override void PostPaintChildren(IGraphics graphics, Rectangle clipRectangle, float angle, SizeF scale)

Parameters

Overrides RadElement.PostPaintChildren(IGraphics, Rectangle, float, SizeF)

Handles mouse wheel events to provide smooth scrolling functionality within the chat messages area, automatically calculating and applying appropriate scroll values.

Declaration

public virtual void ProcessMouseWheel(MouseEventArgs e)

Parameters

Removes a message from the current reply.

Declaration

public virtual void RemoveFromReply(ChatMessage message)

Parameters

Displays the specified overlay message in the chat interface, supporting both modal overlays that block the input and popup overlays that appear above the conversation.

Declaration

public virtual void ShowOverlay(ChatOverlayMessage message)

Parameters

Displays a typing indicator for the specified authors, providing visual feedback to users about who is currently composing messages in the chat conversation.

Declaration

public virtual void ShowTypingIndicator(params Author[] authors)

Parameters

Starts edit mode for the specified message, loading the message text into the input text box.

Declaration

public virtual void StartEdit(ChatMessage message)

Parameters

Starts reply mode for the specified message. If is true and already replying, the message is added to the reply list. If is false, the existing reply is replaced. The maximum number of reply messages is controlled by MaxReplyMessages.

Declaration

public virtual bool StartReply(ChatMessage message)

Parameters

Returns

Submits the current user message from the input text box, handling validation, message creation, and event firing based on the auto-add user messages setting.

Declaration

protected virtual void SubmitUserMessage()

Unwires event handlers to prevent memory leaks and ensure proper cleanup when the chat element is disposed or destroyed.

Declaration

protected virtual void UnwireEvents()

Wires up event handlers for chat functionality including input text box interactions, button clicks, and localization provider changes.

Declaration

protected virtual void WireEvents()

Occurs after the prompt input attached files collection changes (file added or removed, from the built-in dialog or programmatically). Forwarded from AttachedFilesChanged.

Declaration

public event EventHandler AttachedFilesChanged

Event Value

Occurs when the user invokes an attachment action (Download, Download All, or Share) on a chat message. Set Handled to true in the handler to suppress the default behavior provided by the chat (such as showing the save dialog or opening the share UI).

Declaration

public event EventHandler<AttachmentActionEventArgs> AttachmentActionRequested

Event Value

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 CardActionClicked

Event Value

Occurs when a copy operation is initiated or completed.

Declaration

public event EventHandler<CopyEventArgs> Copy

Event Value

Remarks

Occurs when the user cancels editing a message.

Declaration

public event EventHandler EditCancelled

Event Value

Occurs when the user starts editing a message.

Declaration

public event ReplyEventHandler EditStarted

Event Value

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 ItemFormatting

Event Value

Occurs when a message has been deleted.

Declaration

public event MessageDeletedEventHandler MessageDeleted

Event Value

Occurs when a message has been edited.

Declaration

public event MessageEditedEventHandler MessageEdited

Event Value

Occurs when a response needs to be regenerated, allowing subscribers to handle or modify the regeneration process.

Declaration

public event EventHandler<RegenerateResponseEventArgs> RegenerateResponse

Event Value

Remarks

Occurs when a reply bubble is clicked, allowing navigation to the message being replied to.

Declaration

public event ReplyBubbleClickedEventHandler ReplyBubbleClicked

Event Value

Occurs when the user cancels replying to a message.

Declaration

public event EventHandler ReplyCancelled

Event Value

Occurs when the user starts replying to one or more messages. The IsMultiReply property indicates if multiple messages are being replied to.

Declaration

public event ReplyEventHandler ReplyStarted

Event Value

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 SendMessage

Event Value

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 SuggestedActionClicked

Event Value

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 TimeSeparatorAdding

Event Value

Occurs when the user clicks on a toolbar action element, providing access to chat-level functionality and administrative operations.

Declaration

public event ToolbarActionEventHandler ToolbarActionClicked

Event Value

Occurs when a user submits a vote.

Declaration

public event EventHandler<UserVotedEventArgs> UserVoted

Event Value

Remarks

Occurs when a new visual item is being created, allowing customization of its initialization or appearance.

Declaration

public event EventHandler<VisualItemCreatingEventArgs> VisualItemCreating

Event Value

Remarks