menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfSmartPdfViewer - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfSmartPdfViewer

    The SmartPdfViewer is an AI-powered control that extends the Syncfusion.Blazor.SfPdfViewer. It allows for seamless interaction with PDF documents by incorporating AI-assisted functionalities.

    Inheritance
    System.Object
    PdfViewerBase
    SfPdfViewer2
    SfSmartPdfViewer
    Inherited Members
    PdfViewerBase.AddAnnotationAsync(PdfAnnotation)
    PdfViewerBase.AddAnnotationAsync(PdfAnnotation, DynamicStampItem)
    PdfViewerBase.AddAnnotationAsync(PdfAnnotation, SignStampItem)
    PdfViewerBase.AddAnnotationAsync(PdfAnnotation, StandardBusinessStampItem)
    PdfViewerBase.AddAnnotationsAsync(List<PdfAnnotation>)
    PdfViewerBase.AddAriaLabelValueWithID(String, String)
    PdfViewerBase.AddFormFieldsAsync(List<FormFieldInfo>)
    PdfViewerBase.AddPageRedactionsAsync(List<Int32>)
    PdfViewerBase.AjaxRequestSettings
    PdfViewerBase.AnnotationSettings
    PdfViewerBase.AreaSettings
    PdfViewerBase.ArrowSettings
    PdfViewerBase.CancelTextSearchAsync()
    PdfViewerBase.CanRedo
    PdfViewerBase.CanRedoChanged
    PdfViewerBase.CanUndo
    PdfViewerBase.CanUndoChanged
    PdfViewerBase.ChildContent
    PdfViewerBase.CircleSettings
    PdfViewerBase.ClearSelectionAsync()
    PdfViewerBase.ClearTextSelectionAsync()
    PdfViewerBase.CommandManager
    PdfViewerBase.CommentPanelSettings
    PdfViewerBase.CommentPanelVisible
    PdfViewerBase.CommentPanelVisibleChanged
    PdfViewerBase.ContextMenuSettings
    PdfViewerBase.CssClass
    PdfViewerBase.CurrentPageNumber
    PdfViewerBase.CurrentPageNumberChanged
    PdfViewerBase.CurrentPageNumberExpression
    PdfViewerBase.CustomFonts
    PdfViewerBase.CustomStampSettings
    PdfViewerBase.DeleteAnnotationAsync()
    PdfViewerBase.DeleteAnnotationAsync(PdfAnnotation)
    PdfViewerBase.DeleteAnnotationAsync(String)
    PdfViewerBase.DeleteAnnotationsAsync()
    PdfViewerBase.DeleteAnnotationsAsync(List<PdfAnnotation>)
    PdfViewerBase.DeleteAnnotationsAsync(List<String>)
    PdfViewerBase.DeleteFormFieldsAsync(Boolean)
    PdfViewerBase.DeleteFormFieldsAsync(List<FormFieldInfo>)
    PdfViewerBase.DeleteFormFieldsAsync(List<String>)
    PdfViewerBase.Dispose(Boolean)
    PdfViewerBase.DistanceSettings
    PdfViewerBase.DocumentPath
    PdfViewerBase.DownloadAsync()
    PdfViewerBase.DownloadFileName
    PdfViewerBase.EditAnnotationAsync(PdfAnnotation)
    PdfViewerBase.EnableAnnotation
    PdfViewerBase.EnableAnnotationToolbar
    PdfViewerBase.EnableAutoComplete
    PdfViewerBase.EnableBookmarkPanel
    PdfViewerBase.EnableChunkMessages
    PdfViewerBase.EnableCommentPanel
    PdfViewerBase.EnableDesktopMode
    PdfViewerBase.EnableDownload
    PdfViewerBase.EnableErrorDialog
    PdfViewerBase.EnableFormDesigner
    PdfViewerBase.EnableFormFields
    PdfViewerBase.EnableFormFieldsValidation
    PdfViewerBase.EnableFreeText
    PdfViewerBase.EnableHandwrittenSignature
    PdfViewerBase.EnableHyperlink
    PdfViewerBase.EnableImportAnnotationMeasurement
    PdfViewerBase.EnableInkAnnotation
    PdfViewerBase.EnableMagnification
    PdfViewerBase.EnableMeasureAnnotation
    PdfViewerBase.EnableNavigation
    PdfViewerBase.EnableNavigationPanel
    PdfViewerBase.EnableNavigationToolbar
    PdfViewerBase.EnablePinchZoom
    PdfViewerBase.EnablePrint
    PdfViewerBase.EnablePrintRotation
    PdfViewerBase.EnableRtl
    PdfViewerBase.EnableShapeAnnotation
    PdfViewerBase.EnableShapeLabel
    PdfViewerBase.EnableStampAnnotations
    PdfViewerBase.EnableStickyNotesAnnotation
    PdfViewerBase.EnableTextMarkupAnnotation
    PdfViewerBase.EnableTextSearch
    PdfViewerBase.EnableTextSelection
    PdfViewerBase.EnableThumbnailPanel
    PdfViewerBase.EnableToolbar
    PdfViewerBase.EnableToolbarItemsAsync(List<ToolbarItem>, Boolean)
    PdfViewerBase.EnableZoomOptimization
    PdfViewerBase.ExportAnnotationAsStreamAsync(AnnotationDataFormat)
    PdfViewerBase.ExportAnnotationAsync(AnnotationDataFormat)
    PdfViewerBase.ExportAnnotationFileName
    PdfViewerBase.ExportAnnotationsAsObjectAsync()
    PdfViewerBase.ExportFormFieldsAsObjectAsync()
    PdfViewerBase.ExportFormFieldsAsync(FormFieldDataFormat)
    PdfViewerBase.ExportFormFieldsAsync(String)
    PdfViewerBase.FallbackFontCollection
    PdfViewerBase.FitToHeightAsync()
    PdfViewerBase.FitToPageAsync()
    PdfViewerBase.FitToWidthAsync()
    PdfViewerBase.FontFamilies
    PdfViewerBase.FreeTextSettings
    PdfViewerBase.GetAnnotationsAsync()
    PdfViewerBase.GetAriaLabelValue(String)
    PdfViewerBase.GetAriaLabelValue(String, Boolean)
    PdfViewerBase.GetAriaLabelValue(String, String)
    PdfViewerBase.GetBookmarksAsync()
    PdfViewerBase.GetDocumentAsync()
    PdfViewerBase.GetFormFieldsAsync()
    PdfViewerBase.GetJSNamespace()
    PdfViewerBase.GetMainComponentPlatform()
    PdfViewerBase.GetPageCountAsync()
    PdfViewerBase.GetZoomPercentageAsync()
    PdfViewerBase.GoToBookmarkAsync(Int32, Double)
    PdfViewerBase.GoToFirstPageAsync()
    PdfViewerBase.GoToLastPageAsync()
    PdfViewerBase.GoToNextPageAsync()
    PdfViewerBase.GoToPageAsync(Int32)
    PdfViewerBase.GoToPreviousPageAsync()
    PdfViewerBase.HandwrittenSignatureSettings
    PdfViewerBase.Height
    PdfViewerBase.HighlightSettings
    PdfViewerBase.HyperlinkOpenState
    PdfViewerBase.ID
    PdfViewerBase.ImportAnnotationAsync(Object, AnnotationDataFormat)
    PdfViewerBase.ImportAnnotationAsync(Stream, AnnotationDataFormat)
    PdfViewerBase.ImportFormFieldsAsync(Dictionary<String, String>)
    PdfViewerBase.ImportFormFieldsAsync(Stream, FormFieldDataFormat)
    PdfViewerBase.InkAnnotationSettings
    PdfViewerBase.InteractionMode
    PdfViewerBase.IsAnnotationToolbarVisible
    PdfViewerBase.IsDesignerMode
    PdfViewerBase.IsDesignerModeChanged
    PdfViewerBase.IsDocumentEdited
    PdfViewerBase.IsExtractText
    PdfViewerBase.IsFormFieldDocument
    PdfViewerBase.IsMainLicenseComponent()
    PdfViewerBase.IsSignatureEditable
    PdfViewerBase.IsThumbnailPanelOpen
    PdfViewerBase.jsRuntime
    PdfViewerBase.LineSettings
    PdfViewerBase.LoadAsync(Byte[], String)
    PdfViewerBase.LoadAsync(Stream, String)
    PdfViewerBase.LoadAsync(String, String)
    PdfViewerBase.Locale
    PdfViewerBase.MaxZoomValue
    PdfViewerBase.MeasurementSettings
    PdfViewerBase.MinZoomValue
    PdfViewerBase.nameSpace
    PdfViewerBase.NavigationToolbarSettings
    PdfViewerBase.OnHybridInitialized()
    PdfViewerBase.OnInitializedAsync()
    PdfViewerBase.OpenThumbnailPaneAsync()
    PdfViewerBase.OverscanCount
    PdfViewerBase.PageCount
    PdfViewerBase.PageCountChanged
    PdfViewerBase.PageCountExpression
    PdfViewerBase.PerimeterSettings
    PdfViewerBase.PolygonSettings
    PdfViewerBase.PrintAsync()
    PdfViewerBase.PrintMode
    PdfViewerBase.PrintScaleFactor
    PdfViewerBase.RadiusSettings
    PdfViewerBase.RectangleSettings
    PdfViewerBase.RedactAsync()
    PdfViewerBase.RedoAsync()
    PdfViewerBase.RestrictZoomRequest
    PdfViewerBase.RetrieveFormFieldsAsync()
    PdfViewerBase.RetryCount
    PdfViewerBase.SaveAsync(String)
    PdfViewerBase.ScrollSettings
    PdfViewerBase.SearchNextAsync()
    PdfViewerBase.SearchPreviousAsync()
    PdfViewerBase.SearchTextAsync(String, Boolean)
    PdfViewerBase.SelectAnnotationAsync(PdfAnnotation)
    PdfViewerBase.SelectAnnotationAsync(String)
    PdfViewerBase.SelectFormFieldAsync(FormFieldInfo)
    PdfViewerBase.SelectFormFieldAsync(String)
    PdfViewerBase.SelectTextRegionAsync(Int32, List<Bound>)
    PdfViewerBase.ServerActionSettings
    PdfViewerBase.SetAnnotationModeAsync(AnnotationType)
    PdfViewerBase.SetAnnotationModeAsync(AnnotationType, Nullable<DynamicStampItem>, Nullable<SignStampItem>, Nullable<StandardBusinessStampItem>)
    PdfViewerBase.SetFormDrawingModeAsync(Nullable<FormFieldType>)
    PdfViewerBase.ShapeLabelSettings
    PdfViewerBase.ShouldRender()
    PdfViewerBase.ShowAnnotationToolbar(Boolean)
    PdfViewerBase.ShowDigitalSignatureAppearance
    PdfViewerBase.ShowNavigationToolbarAsync(Boolean)
    PdfViewerBase.ShowRedactionToolbar(Boolean)
    PdfViewerBase.ShowToolbarAsync(Boolean)
    PdfViewerBase.ShowToolbarItemsAsync(List<ToolbarItem>, Boolean)
    PdfViewerBase.SquigglySettings
    PdfViewerBase.StampSettings
    PdfViewerBase.StickyNotesSettings
    PdfViewerBase.StrikethroughSettings
    PdfViewerBase.TextSearchColorSettings
    PdfViewerBase.TileRenderingSettings
    PdfViewerBase.ToggleItemByIndex(Int32)
    PdfViewerBase.ToolbarSettings
    PdfViewerBase.UnderlineSettings
    PdfViewerBase.UndoAsync()
    PdfViewerBase.UnloadAsync()
    PdfViewerBase.UpdateChildProperties(String, Object)
    PdfViewerBase.UpdateFormFieldsAsync(FormField)
    PdfViewerBase.UpdateFormFieldsAsync(List<FormFieldInfo>)
    PdfViewerBase.UpdateMeasurementSettingsAsync()
    PdfViewerBase.UpdateViewerContainerAsync()
    PdfViewerBase.VolumeSettings
    PdfViewerBase.Width
    PdfViewerBase.ZoomAsync(Int32)
    PdfViewerBase.ZoomInAsync()
    PdfViewerBase.ZoomMode
    PdfViewerBase.ZoomOutAsync()
    PdfViewerBase.ZoomValue
    PdfViewerBase.ZoomValueChanged
    PdfViewerBase.ZoomValueExpression
    SfPdfViewer2.BuildRenderTree(RenderTreeBuilder)
    SfPdfViewer2.jsProperty
    Namespace: Syncfusion.Blazor.SmartPdfViewer
    Assembly: Syncfusion.Blazor.SmartPdfViewer.dll
    Syntax
    public class SfSmartPdfViewer : SfPdfViewer2
    Examples
    <SfSmartPdfViewer Height="100%" width="100%">
    </SfSmartPdfViewer>

    Constructors

    SfSmartPdfViewer()

    Declaration
    public SfSmartPdfViewer()

    Methods

    ApplySmartFillAsync()

    Initiates the Smart Fill process using extracted form field names and the current clipboard data. When executed, this method uses AI to analyze the clipboard content and map it to named form fields within the loaded PDF.

    Declaration
    public Task ApplySmartFillAsync()
    Returns
    Type
    System.Threading.Tasks.Task
    Remarks

    The ApplySmartFillAsync() method requires that form fields have valid names; AI cannot populate fields without identifiers. The clipboard data is parsed and mapped via AI to corresponding fields, minimizing manual entry and improving accuracy.

    Examples

    The following example shows how to apply Smart Fill for open forms with clipboard content:

    <SfSmartPdfViewer @ref="smartPdfViewer">
        <SmartFillSettings />
    </SfSmartPdfViewer>
    
    @code {
        public async void SmartFormFill()
        {
            await smartPdfViewer.ApplySmartFillAsync();
        }
    }

    ApplySmartFillAsync(String)

    Initiates the Smart Fill process using the specified string data instead of clipboard content.

    Declaration
    public Task ApplySmartFillAsync(string data)
    Parameters
    Type Name Description
    System.String data

    The custom data (string value) to be used by the AI for mapping values to form fields during the Smart Fill process.

    Returns
    Type
    System.Threading.Tasks.Task
    Remarks

    This overload of ApplySmartFillAsync(string data) gives developers or users full control over the data source for form filling, supporting custom, user-provided, or application-integrated content. Form fields without proper names cannot be automatically populated, as the AI workflow requires unique keys for mapping values correctly.

    Examples

    The following example demonstrates how to invoke Smart Fill with your own data:

    <SfSmartPdfViewer @ref="smartPdfViewer" >
        <SmartFillSettings />
    </SfSmartPdfViewer>
    
    @code {
        public async void SmartFormFill()
        {
            await smartPdfViewer.ApplySmartFillAsync("FirstName: Alice; LastName: Smith; Email: [email protected];");
        }
    }

    Dispose()

    Dispose the Smart PDF Viewer and it's dependencies.

    Declaration
    public override void Dispose()
    Overrides
    PdfViewerBase.Dispose()

    GetPrompts()

    Gets or sets a value indicating whether the response toolbar icons are shown.

    Declaration
    public List<AssistViewPrompt> GetPrompts()
    Returns
    Type Description
    System.Collections.Generic.List<AssistViewPrompt>

    true if response toolbar icons should be displayed; otherwise, false.

    Examples
    <SfSmartPdfViewer @ref="settings">
    </SfSmartPdfViewer>
    
    @code {
        private List<AssistViewPrompt> prompts = new List<AssistViewPrompt>();
    
        protected override void OnAfterRender(bool firstRender)
        {
            prompts = settings.GetPrompts();
        }
    }

    OnAfterRenderAsync(Boolean)

    Handles the after render event of the component to perform actions after the component has rendered.

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender

    Indicates the first render

    Returns
    Type
    System.Threading.Tasks.Task
    Overrides
    PdfViewerBase.OnAfterRenderAsync(Boolean)

    OnInitialized()

    Occurs when the control is being initialized

    Declaration
    protected override void OnInitialized()

    OnParametersSetAsync()

    Updates the component when parameters are set. It is used to detect changes in the component parameters and handle any necessary updates or actions.

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type
    System.Threading.Tasks.Task
    Overrides
    PdfViewerBase.OnParametersSetAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved