Class InlineAIAssist
Inheritance
Namespace: Syncfusion.EJ2.InteractiveChat
Assembly: Syncfusion.EJ2.dll
Syntax
public class InlineAIAssist : EJTagHelper
Constructors
InlineAIAssist()
Declaration
public InlineAIAssist()
Properties
Close
Triggers when the popup or inline response area is closed or hidden. Occurs on cancel, Escape key, outside click, or after response insertion.
Declaration
public string Close { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CommandSettings
Specifies the configuration for available AI commands and suggestions. Specifies options such as enabling/disabling commands and customizing suggestion behavior.
Declaration
public InlineAIAssistCommandSettings CommandSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| InlineAIAssistCommandSettings | The default value is null |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
| Type |
|---|
| Syncfusion.EJ2.MvcTemplate<System.Object> |
Created
Event triggers when the component is created.
Declaration
public string Created { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CssClass
Specifies one or more custom CSS class names for the root element of the component. Specifies multiple classes as a space-separated list.
Declaration
public string CssClass { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
EditorTemplate
Specifies a custom template (string or function) for rendering the prompt input area. Specifies a string template or a function that returns the editor UI markup.
Declaration
public string EditorTemplate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableRtl
Specifies whether right-to-left (RTL) text direction is enabled for the component. Specifies true to render UI elements and text in RTL layout.
Declaration
public bool EnableRtl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableStreaming
Specifies whether the prompt response need to be added through streaming in the component. By default the response is not streamed and default value is false
Declaration
public bool EnableStreaming { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
| Type |
|---|
| System.Object |
InlineToolbarSettings
Specifies the configuration for the toolbar displayed in the inline prompt input. Specifies buttons, shortcuts, and behaviors available while composing the prompt.
Declaration
public InlineAIAssistInlineToolbarSettings InlineToolbarSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| InlineAIAssistInlineToolbarSettings | The default value is null |
Locale
Specifies the locale code used for UI text localization. Specifies culture codes such as 'en-US' or 'ta-IN'.
Declaration
public string Locale { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "en-US" |
Open
Triggers when the popup or inline response area becomes visible. Use this event to set focus, measure layout, or run analytics.
Declaration
public string Open { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Placeholder
Specifies the placeholder text displayed when the prompt input is empty. Specifies helper text to guide the user on what to ask or generate.
Declaration
public string Placeholder { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "Ask or generate AI content.." |
PopupHeight
Specifies the height of the popup container. Specifies a value in CSS units (px, %, rem, vh, etc.) or a number in pixels.
Declaration
public string PopupHeight { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "auto" |
PopupWidth
Specifies the width of the popup container. Specifies a value in CSS units (px, %, rem, vw, etc.) or a number in pixels.
Declaration
public string PopupWidth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "400px" |
Prompt
Specifies the current text value of the prompt input field. Specifies the content that will be used to generate the AI response.
Declaration
public string Prompt { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
PromptRequest
Triggers when the user submits a prompt by pressing Enter or clicking Generate. Use this event to perform the AI request, update UI, or cancel the default processing.
Declaration
public string PromptRequest { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Prompts
Specifies the collection of prompts and their corresponding responses. Specifies an array of PromptModel objects used to render the history.
Declaration
public object Prompts { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
RelateTo
Specifies the element relative to which the InlineAIAssist popup is positioned. Accepts a CSS selector string (e.g., '#id' or '.class') or an HTMLElement.
Declaration
public string RelateTo { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
ResponseMode
Specifies how the AI response is displayed. 'Inline' renders at the caret position; 'Popup' shows above the prompt.
Declaration
public ResponseMode ResponseMode { get; set; }
Property Value
| Type | Description |
|---|---|
| ResponseMode | The default value is ResponseMode.Popup |
ResponseSettings
Specifies the configuration for the toolbar displayed with the generated response. Specifies buttons, actions, and behaviors applied to the response area.
Declaration
public InlineAIAssistResponseSettings ResponseSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| InlineAIAssistResponseSettings | The default value is null |
ResponseTemplate
Specifies a custom template (string or function) for rendering AI-generated response content. Specifies that a function receives a ResponseTemplateContext and returns markup or text.
Declaration
public string ResponseTemplate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
Target
Specifies the element or CSS selector where the InlineAIAssist will be appended. Accepts either a CSS selector string (e.g., '.container' or '#id') or an HTMLElement. Defaults to document.body.
Declaration
public string Target { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is "body" |
ZIndex
Specifies the z-index value applied to the popup or overlay layer. Specifies a higher value to ensure the component appears above surrounding UI.
Declaration
public double ZIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 1000 |