Class SfAIAssistView

Represents a chat control designed to display AI Assist conversation

Inheritance
System.Object
BaseControl
SfAIAssistView
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Inherited Members
Namespace: Syncfusion.WinForms.AIAssistView
Assembly: Syncfusion.SfAIAssistView.WinForms.dll
Syntax
public class SfAIAssistView : BaseControl, IThemeProvider, IVisualStyle, INotifyPropertyChanged, IDisposable

Constructors

SfAIAssistView()

Initializes a new instance of the SfAIAssistView class.

Declaration
public SfAIAssistView()

Properties

BaseThemeName

Gets or sets the BaseThemeName of the control.

Declaration
protected string BaseThemeName { get; set; }
Property Value
Type
System.String

CanApplyTheme

Gets or sets a value indicating whether the theme can be applied to the control.

Declaration
public bool CanApplyTheme { get; set; }
Property Value
Type
System.Boolean

ForeColor

Gets or sets the foreground color of the control.

Declaration
public override Color ForeColor { get; }
Property Value
Type
System.Drawing.Color

Messages

Gets or sets the collection of the messages

Declaration
public object Messages { get; set; }
Property Value
Type
System.Object

ShowTypingIndicator

Gets or sets a value indicating whether the typing indicator should be displayed at the bottom of the chat control to notify when a user is typing.

Declaration
public bool ShowTypingIndicator { get; set; }
Property Value
Type
System.Boolean

Style

Gets or sets the style for the SfAIAssistView control.

Declaration
public AssistViewStyle Style { get; set; }
Property Value
Type
AssistViewStyle

Suggestions

Gets or sets the collection of suggestion items.

Declaration
public object Suggestions { get; set; }
Property Value
Type
System.Object

ThemeName

Gets or sets the theme name of the SfAIAssistView control.

Declaration
public string ThemeName { get; set; }
Property Value
Type Description
System.String

The default value is null.
Remarks

The theme will be applied only when the particular theme for this control has included the Themes assembly.

TypingIndicator

Gets or sets the indicator that notifies when a user is typing.

Declaration
public TypingIndicator TypingIndicator { get; set; }
Property Value
Type
TypingIndicator

User

Gets or sets the current author of a message.

Declaration
public Author User { get; set; }
Property Value
Type
Author

VisualTheme

Gets or sets the visualTheme of the control, which holds the ThemeName applied from SkinManager

Declaration
protected string VisualTheme { get; set; }
Property Value
Type
System.String

Methods

Dispose(Boolean)

Method to dispose all the Events and control

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

GetControlName(String)

Gets the name of the control.

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName

The default name of the control.
Returns
Type Description
System.String

The string representing the control name.
Overrides

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

The ThemeName of the Control
Overrides

SetBannerView(String, String, Image, BannerStyle)

Sets the banner view in the SfAIAssistView with title, subtitle, icon, and optional style.

Declaration
public void SetBannerView(string title, string subTitle, Image icon, BannerStyle style = null)
Parameters
Type Name Description
System.String title

The title text for the banner.
System.String subTitle

The subtitle text for the banner.
System.Drawing.Image icon

The image icon for the banner.
BannerStyle style

The optional style configuration for the banner.

SetBotView(Object, Control)

Assign a custom control to represent a specific bot message model.

Declaration
public void SetBotView(object messageModel, Control customControl)
Parameters
Type Name Description
System.Object messageModel

The message data model associated with the custom control.
System.Windows.Forms.Control customControl

The custom control to be displayed for the bot message.

SetUserView(Object, Control)

Assign a custom control to represent a specific user message model.

Declaration
public void SetUserView(object messageModel, Control customControl)
Parameters
Type Name Description
System.Object messageModel

The message data model associated with the custom control.
System.Windows.Forms.Control customControl

The custom control to be displayed for the User message.

Events

PromptRequest

Occurs when a prompt is submitted by the user in the SfAIAssistView control.

Declaration
public event EventHandler<PromptRequestEventArgs> PromptRequest
Event Type
Type
System.EventHandler<PromptRequestEventArgs>

PropertyChanged

Represents the method that will handle the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type
System.ComponentModel.PropertyChangedEventHandler

SuggestionSelected

Occurs when the suggestion item is selected in the SfAIAssistView control.

Declaration
public event EventHandler<SuggestionSelectedEventArgs> SuggestionSelected
Event Type
Type
System.EventHandler<SuggestionSelectedEventArgs>

Explicit Interface Implementations

IVisualStyle.VisualTheme

Gets or sets the VisualTheme of the SfListView control.

Declaration
string IVisualStyle.VisualTheme { get; set; }
Returns
Type
System.String

IThemeProvider.BaseThemeName

Gets the base theme name used for theme calculations.

Declaration
string IThemeProvider.BaseThemeName { get; set; }
Returns
Type
System.String

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable