Class PdfViewerTemplates

Gets or sets the template configurations for customizing the Assist view in the Smart PDF Viewer. This property allows developers to define custom UI templates for the prompt input toolbar, AI response toolbar, and banner section, enabling a more personalized and interactive user experience.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
PdfViewerTemplates
Implements
Inherited Members
Namespace: Syncfusion.Blazor.SmartPdfViewer
Assembly: Syncfusion.Blazor.SmartPdfViewer.dll
Syntax
public class PdfViewerTemplates : SfBaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

Use the PdfViewerTemplates property to tailor the layout and functionality of the Assist view’s toolbars and banner. By providing custom templates for the prompt, response, and banner sections, you can enhance usability, guide users effectively, and align the interface with your application's design requirements. The BannerTemplate is especially useful for displaying welcome messages, instructions, or branding elements.

Examples

The following example demonstrates how to define custom templates for the prompt, response, and banner sections in the Assist view of the PDF viewer component:

<SfSmartPdfViewer>
    <AssistViewSettings>
        <PdfViewerTemplates>
            <PromptTemplate>
                <PromptToolbar>
                    <PromptToolbarItem IconCss="e-icons e-assist-edit"></PromptToolbarItem>
                    <PromptToolbarItem IconCss="e-icons e-assist-copy"></PromptToolbarItem>
                </PromptToolbar>
            </PromptTemplate>
            <ResponseTemplate>
                <ResponseToolbar>
                    <ResponseToolbarItem IconCss="e-icons e-assist-like"></ResponseToolbarItem>
                    <ResponseToolbarItem IconCss="e-icons e-assist-dislike"></ResponseToolbarItem>
                </ResponseToolbar>
            </ResponseTemplate>
            <BannerTemplate>
                <div>
                   Hello! How can I assist you with your PDF today?
                </div>
            </BannerTemplate>
        </PdfViewerTemplates>
    </AssistViewSettings>
</SfSmartPdfViewer>

Constructors

PdfViewerTemplates()

Declaration
public PdfViewerTemplates()

Properties

BannerTemplate

Gets or sets the template for the banner displayed within the viewer.

Declaration
[Parameter]
public RenderFragment BannerTemplate { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment used to customize the banner.
Examples
<SfSmartPdfViewer>
  <AssistViewSettings>
   <PdfViewerTemplates>
            <BannerTemplate>
            @{
                <div>Welcome to Smart PDF Viewer!</div>
            }
            </BannerTemplate>
       </PdfViewerTemplates>
   </AssistViewSettings>
</SfSmartPdfViewer>

PromptTemplate

Gets or sets the template for the toolbar that appears within the prompt view of the viewer.

Declaration
[Parameter]
public RenderFragment PromptTemplate { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment used to customize the prompt toolbar UI.
Remarks

Use PromptToolbar property to customize the prompt toolbar UI.

Examples
<SfSmartPdfViewer>
    <AssistViewSettings>
         <PdfViewerTemplates PromptTemplate="@Prompt"></PdfViewerTemplates>
    </AssistViewSettings>
</SfSmartPdfViewer>

@code {
   private RenderFragment Prompt()
   {
        return __builder =>
        {
            <PromptToolbar>
                <PromptToolbarItem IconCss="e-icons e-assist-edit"></PromptToolbarItem>
                <PromptToolbarItem IconCss="e-icons e-assist-copy"></PromptToolbarItem>
            </PromptToolbar>;
        };
   }
}

ResponseTemplate

Gets or sets the template for the toolbar that appears in the response section of the viewer.

Declaration
[Parameter]
public RenderFragment ResponseTemplate { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment used to customize the response toolbar UI.
Remarks

Use ResponseToolbar property to customize the response toolbar UI.

Examples
<SfSmartPdfViewer>
    <AssistViewSettings>
	 <PdfViewerTemplates ResponseTemplate="@Response"></PdfViewerTemplates>
    </AssistViewSettings>
</SfSmartPdfViewer>

@code {
   private RenderFragment Response()
   {
       return __builder =>
       {
            <ResponseToolbar>
                <ResponseToolbarItem IconCss="e-icons e-assist-copy" /> 
            </ResponseToolbar>
       };
   }
}

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnParametersSet()

Called when the parameters are set for the component.

Declaration
protected override void OnParametersSet()
Overrides

Implements