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 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 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 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 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

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 input text box element where users type their messages, complete with localized placeholder text and proper sizing.

Declaration

protected virtual RadTextBoxElement CreateInputTextBox()

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 send button element that allows users to submit their typed messages to the chat conversation.

Declaration

protected virtual ChatSendButtonElement CreateSendButton()

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

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 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

Handles key down events in the input text box, processing Enter key submissions 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

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

Handles click events on the send button element, submitting user messages when the input text box contains non-whitespace content.

Declaration

protected virtual void OnSendButtonElementClick(object sender, EventArgs 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

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

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 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 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 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 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