Class AssistView

Inheritance

AssistView

Implements

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.OnInitialized()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

OwningComponentBase.IsDisposed

OwningComponentBase.ScopedServices

Namespace: Syncfusion.Blazor.InteractiveChat

Assembly: Syncfusion.Blazor.dll

Syntax

public class AssistView : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

AssistView()

Declaration

public AssistView()

Properties

BannerTemplate

Gets or sets the template for the initial view of the SfAIAssistView component.

Declaration

[Parameter]
public RenderFragment BannerTemplate { get; set; }

Property Value

Type	Description
RenderFragment	A RenderFragment representing the template for the initial view. The default value is `null`.

Remarks

This template defines the initial content displayed when the SfAIAssistView component is rendered.

Examples

<SfAIAssistView>
    <ChildContent>
        <AssistViews>
            <AssistView Header="AI Generation">
                <BannerTemplate>
                    // Place your template item here
                </BannerTemplate>
            </AssistView>
        </AssistViews>
    </ChildContent>
</SfAIAssistView>

FooterTemplate

Gets or sets the template for the footer item of the assist view in the SfAIAssistView component.

Declaration

[Parameter]
public RenderFragment FooterTemplate { get; set; }

Property Value

Type	Description
RenderFragment	A RenderFragment representing the template for the footer item. The default is `null`.

Remarks

This property specifies the template used to render the footer item of the assist view in the SfAIAssistView component.

Examples

<SfAIAssistView>
    <ChildContent>
        <AssistViews>
            <AssistView Header="AI Generation">
                <FooterTemplate>
                    // Place your template item here
                </FooterTemplate>
            </AssistView>
        </AssistViews>
    </ChildContent>
</SfAIAssistView>

Header

Gets or sets the name of the assist view in the SfAIAssistView component.

Declaration

[Parameter]
public string Header { get; set; }

Property Value

Type	Description
string	The name displayed in the assist view. The default is `"AI Assist"`.

Remarks

This property specifies the name of the assist view in the SfAIAssistView component.

IconCss

Gets or sets the icon CSS for the assist view in the SfAIAssistView component.

Declaration

[Parameter]
public string IconCss { get; set; }

Property Value

Type	Description
string	The CSS class for the icon of assist view. The default is `String.Empty`.

Remarks

This property specifies the CSS class for the assist view icon used in the SfAIAssistView component.

PromptItemTemplate

Gets or sets the template for the prompt item in the SfAIAssistView component.

Declaration

[Parameter]
public RenderFragment<PromptItemTemplateContext> PromptItemTemplate { get; set; }

Property Value

Type	Description
RenderFragment<PromptItemTemplateContext>	A RenderFragment<TValue> representing the template for the prompt item. The default is `null`.

Remarks

This property specifies the template used to render the prompt item in the SfAIAssistView component.

Examples

<SfAIAssistView>
    <ChildContent>
        <AssistViews>
            <AssistView Header="AI Generation">
                <PromptItemTemplate>
                    <p>@context.Prompt</p>
                </PromptItemTemplate>
            </AssistView>
        </AssistViews>
    </ChildContent>
</SfAIAssistView>

PromptSuggestionItemTemplate

Gets or sets the template for the prompt suggestion item in the SfAIAssistView component.

Declaration

[Parameter]
public RenderFragment<PromptSuggestionItemTemplateContext> PromptSuggestionItemTemplate { get; set; }

Property Value

Type	Description
RenderFragment<PromptSuggestionItemTemplateContext>	A RenderFragment<TValue> representing the template for the prompt suggestion item. The default is `null`.

Remarks

This property specifies the template used to render the prompt suggestion item in the SfAIAssistView component.

Examples

<SfAIAssistView>
    <ChildContent>
        <AssistViews>
            <AssistView Header="AI Generation">
                <PromptSuggestionItemTemplate>
                     <p>@context.PromptSuggestion</p>
                </PromptSuggestionItemTemplate>
            </AssistView>
        </AssistViews>
    </ChildContent>
</SfAIAssistView>

ResponseItemTemplate

Gets or sets the template for the output response item in the SfAIAssistView component.

Declaration

[Parameter]
public RenderFragment<ResponseItemTemplateContext> ResponseItemTemplate { get; set; }

Property Value

Type	Description
RenderFragment<ResponseItemTemplateContext>	A RenderFragment<TValue> representing the template for the output response item. The default is `null`.

Remarks

This property specifies the template used to render the output response item in the SfAIAssistView component.

Examples

<SfAIAssistView>
    <ChildContent>
        <AssistViews>
            <AssistView Header="AI Generation">
                <OutputItemTemplate>
                     <p>@context.Response</p>
                </OutputItemTemplate>
            </AssistView>
        </AssistViews>
    </ChildContent>
</SfAIAssistView>

ShowClearButton

Gets or sets a value indicating whether the clear button is shown in the prompt text area field in the SfAIAssistView component.

Declaration

[Parameter]
public bool ShowClearButton { get; set; }

Property Value

Type	Description
bool	`true` shows the clear button, and `false` hides it. The default value is `false`.

Remarks

Use this property to control the visibility of the clear button shown in the prompt text area field in the SfAIAssistView component.

ViewTemplate

Gets or sets a template that defines the appearance of the assist view.

Declaration

[Parameter]
public RenderFragment ViewTemplate { get; set; }

Property Value

Type	Description
RenderFragment	A RenderFragment representing the template for the assist view. The default is `null`.

Remarks

This property specifies the template used to render the appearance of the AssistView component.

Examples

<SfAIAssistView>
    <ChildContent>
        <AssistViews>
            <AssistView Header="NoteBook">
                <ViewTemplate>
                    // Place your template item here
                </ViewTemplate>
            </AssistView>
        </AssistViews>
    </ChildContent>
</SfAIAssistView>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

OwningComponentBase.Dispose(bool)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
Task

Overrides

ComponentBase.OnInitializedAsync()

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable