Class

RadPromptInputElement

Initializes a new instance of the RadPromptInputElement class.

Declaration

public RadPromptInputElement()

Identifies the IsProcessing property.

Declaration

public static RadProperty IsProcessingProperty

Field Value

Gets or sets a value indicating whether the input box accepts the Return key to create new lines.

Declaration

public bool AcceptsReturn { get; set; }

Property Value

Gets the collection of files attached to the prompt. The collection is owned by the underlying PromptInputAttachedFilesElement; adding or removing items automatically updates the chip UI and the send-button state.

Declaration

[Browsable(false)]
public ObservableCollection<PromptInputAttachedFile> AttachedFiles { get; }

Property Value

Gets the attached files element.

Declaration

[Browsable(false)]
public PromptInputAttachedFilesElement AttachedFilesElement { get; }

Property Value

Gets the buttons panel element.

Declaration

[Browsable(false)]
public PromptInputButtonsPanelElement ButtonsPanelElement { get; }

Property Value

Gets or sets the text displayed inside the prompt-suggestions popup when both SuggestedPrompts and RecentPrompts are empty. When null or empty, the popup does not open when there are no suggestions. Forwarded to EmptyPromptSuggestionsText.

Declaration

public string EmptyPromptSuggestionsText { get; set; }

Property Value

Gets or sets a callback that resolves the icon shown next to an attached file. The callback receives the file name and returns a PromptInputFileIcon carrying a glyph character, a Image, or a RadSvgImage. Return null to fall back to the default extension-based glyph. Forwarded to FileIconProvider.

Declaration

[Browsable(false)]
public Func<string, PromptInputFileIcon> FileIconProvider { get; set; }

Property Value

Gets the input row dock layout panel.

Declaration

[Browsable(false)]
public DockLayoutPanel InputRow { get; }

Property Value

Gets the input text box element.

Declaration

[Browsable(false)]
public ChatInputTextBoxElement InputTextBox { get; }

Property Value

Gets or sets a value indicating whether the control is in a processing state. When true, clicking the send button raises CancelProcessing instead of SendMessage. The same state is currently also reused during speech-to-text listening.

Declaration

public bool IsProcessing { get; set; }

Property Value

Gets or sets the maximum number of visible lines in the input text box.

Declaration

public int MaxInputLines { get; set; }

Property Value

Gets or sets the list of actions shown in the "more" button popup. Forwarded to MoreButtonActions.

Declaration

[Browsable(false)]
public IList<PromptInputButtonAction> MoreButtonActions { get; set; }

Property Value

Gets or sets the prompt text that is displayed when the input text box is empty.

Declaration

public string NullText { get; set; }

Property Value

Gets or sets a value indicating whether the suggestions popup opens automatically when the input text box gains keyboard focus. Default is false.

Declaration

public bool OpenPromptSuggestionsOnFocus { get; set; }

Property Value

Gets or sets the list of recent prompts shown in the suggestions popup. Forwarded to RecentPrompts.

Declaration

[Browsable(false)]
public IList<string> RecentPrompts { get; set; }

Property Value

Gets or sets a value indicating whether the clear button is visible when text is present.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Gets or sets a value indicating whether the "more" button is visible.

Declaration

public bool ShowMoreButton { get; set; }

Property Value

Gets or sets a value indicating whether the prompt-suggestions button is visible. Forwarded to ShowPromptSuggestionsButton.

Declaration

public bool ShowPromptSuggestionsButton { get; set; }

Property Value

Gets or sets a value indicating whether the recent-prompts section is visible inside the suggestions popup.

Declaration

public bool ShowRecentPrompts { get; set; }

Property Value

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

Declaration

public bool ShowSpeechToTextButton { get; set; }

Property Value

Gets or sets a value indicating whether the suggested-prompts section is visible inside the suggestions popup.

Declaration

public bool ShowSuggestedPrompts { get; set; }

Property Value

Gets or sets the list of suggested prompts shown in the suggestions popup. Forwarded to SuggestedPrompts.

Declaration

[Browsable(false)]
public IList<string> SuggestedPrompts { get; set; }

Property Value

Opens the file attachment dialog for all file types. Forwarded to AttachFiles().

Declaration

public void AttachFiles()

Opens the file attachment dialog for image file types. Forwarded to AttachPhotos().

Declaration

public void AttachPhotos()

Creates the attached files element. Override to customize.

Declaration

protected virtual PromptInputAttachedFilesElement CreateAttachedFilesElement()

Returns

Creates the buttons panel element. Override to customize.

Declaration

protected virtual PromptInputButtonsPanelElement CreateButtonsPanelElement()

Returns

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates the input text box element. Override to customize.

Declaration

protected virtual ChatInputTextBoxElement CreateInputBox()

Returns

Creates the input row panel. Override to customize.

Declaration

protected virtual DockLayoutPanel CreateInputRow()

Returns

Creates the main stack layout element. Override to customize.

Declaration

protected virtual StackLayoutElement CreateStackLayoutElement()

Returns

Disposes of managed resources including cached images and SVG images when the element is being disposed.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Raises the CancelProcessing event.

Declaration

protected virtual void OnCancelProcessing(EventArgs args)

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 SendMessage event.

Declaration

protected virtual void OnSendMessage(PromptInputSendMessageEventArgs args)

Parameters

Raises the SendingMessage event.

Declaration

protected virtual void OnSendingMessage(PromptInputSendingMessageEventArgs args)

Parameters

Removes the specified file from the AttachedFiles collection. Raises AttachedFileRemoving beforehand (cancelable) and AttachedFileRemoved afterwards. Forwarded to RemoveAttachedFile(PromptInputAttachedFile).

Declaration

public void RemoveAttachedFile(PromptInputAttachedFile file)

Parameters

Occurs after an attached file has been removed from the AttachedFiles collection. Forwarded from AttachedFileRemoved.

Declaration

public event PromptInputAttachedFileRemovedEventHandler AttachedFileRemoved

Event Value

Occurs before an attached file is removed as a result of the user clicking the remove button on its chip. Set Cancel to true to keep the file in the AttachedFiles collection. Forwarded from AttachedFileRemoving.

Declaration

public event PromptInputAttachedFileRemovingEventHandler AttachedFileRemoving

Event Value

Occurs after the AttachedFiles 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 clicks the send button while the control is in a processing state.

Declaration

public event EventHandler CancelProcessing

Event Value

Occurs when a file dialog is about to open (Attach / Photo actions). Set Cancel to true to suppress the built-in OpenFileDialog and handle file selection externally; populate FileNames in that case to still produce attachments. Forwarded from DialogOpening.

Declaration

public event PromptInputDialogOpeningEventHandler DialogOpening

Event Value

Occurs when the user selects an item from the prompt suggestions popup. Forwarded from SuggestionSelected.

Declaration

public event PromptInputSuggestionSelectedEventHandler PromptSuggestionSelected

Event Value

Occurs when the user sends a message via the send button.

Declaration

public event PromptInputSendMessageEventHandler SendMessage

Event Value

Occurs before a message is sent. Set Cancel to true to prevent sending.

Declaration

public event PromptInputSendingMessageEventHandler SendingMessage

Event Value

Occurs before a suggestion is applied to the input text. Set Cancel to true to prevent the suggestion from being applied. Forwarded from SuggestionSelecting.

Declaration

public event PromptInputSuggestionSelectingEventHandler SuggestionSelecting

Event Value