alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download

    Show / Hide Table of Contents

    Class SfSmartPdfViewer

    Initializes a new instance of the SfSmartPdfViewer class and sets up the default configuration required for PDF viewing, navigation, form interaction, and Smart AI-powered features.

    Inheritance
    System.Object
    SfView
    SfPdfViewer
    SfSmartPdfViewer
    Implements
    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<Microsoft.Maui.IView>
    System.Collections.Generic.ICollection<Microsoft.Maui.IView>
    System.Collections.Generic.IEnumerable<Microsoft.Maui.IView>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Inherited Members
    SfPdfViewer.AddAnnotation(Annotation)
    SfPdfViewer.AddPageRedactionMarks(List<Int32>)
    SfPdfViewer.AddRedactionMark(RedactionMark)
    SfPdfViewer.AllowDoubleTapZoom
    SfPdfViewer.AllowDoubleTapZoomProperty
    SfPdfViewer.AllowEditFormFields
    SfPdfViewer.AllowEditFormFieldsProperty
    SfPdfViewer.AnnotationAdded
    SfPdfViewer.AnnotationDeselected
    SfPdfViewer.AnnotationEdited
    SfPdfViewer.AnnotationMode
    SfPdfViewer.AnnotationModeProperty
    SfPdfViewer.AnnotationRemoved
    SfPdfViewer.Annotations
    SfPdfViewer.AnnotationSelected
    SfPdfViewer.AnnotationSettings
    SfPdfViewer.AnnotationsLoaded
    SfPdfViewer.Bookmark(Int32, String)
    SfPdfViewer.ClearFormData(Int32)
    SfPdfViewer.ClientRectangle
    SfPdfViewer.ConvertClientPointToPagePoint(Point, Int32)
    SfPdfViewer.ConvertPagePointToClientPoint(Point, Int32)
    SfPdfViewer.ConvertPagePointToScrollPoint(Point, Int32)
    SfPdfViewer.CustomBookmarks
    SfPdfViewer.CustomStampModalViewAppearing
    SfPdfViewer.CustomStampModalViewDisappearing
    SfPdfViewer.DeselectAnnotation(Annotation)
    SfPdfViewer.DigitalSignatureModalViewAppearing
    SfPdfViewer.DigitalSignatureModalViewDisappearing
    SfPdfViewer.DigitalSignatureSettings
    SfPdfViewer.DocumentLoaded
    SfPdfViewer.DocumentLoadFailed
    SfPdfViewer.DocumentOutline
    SfPdfViewer.DocumentSigned
    SfPdfViewer.DocumentSource
    SfPdfViewer.DocumentSourceProperty
    SfPdfViewer.DocumentUnloaded
    SfPdfViewer.EnableDocumentLinkNavigation
    SfPdfViewer.EnableDocumentLinkNavigationProperty
    SfPdfViewer.EnableHyperlinkNavigation
    SfPdfViewer.EnableHyperlinkNavigationProperty
    SfPdfViewer.EnableLiquidGlassEffect
    SfPdfViewer.EnableLiquidGlassEffectProperty
    SfPdfViewer.EnablePageNavigationDialog
    SfPdfViewer.EnableTextSelection
    SfPdfViewer.EnableTextSelectionProperty
    SfPdfViewer.ExportAnnotations(Stream, AnnotationDataFormat, List<Annotation>)
    SfPdfViewer.ExportAnnotationsAsync(Stream, AnnotationDataFormat, List<Annotation>, CancellationToken)
    SfPdfViewer.ExportFormData(Stream, DataFormat)
    SfPdfViewer.ExportFormDataAsync(Stream, DataFormat, CancellationToken)
    SfPdfViewer.ExtentHeight
    SfPdfViewer.ExtentHeightProperty
    SfPdfViewer.ExtentWidth
    SfPdfViewer.ExtentWidthProperty
    SfPdfViewer.FormFieldFocusChanged
    SfPdfViewer.FormFields
    SfPdfViewer.FormFieldValueChanged
    SfPdfViewer.FreeTextModalViewAppearing
    SfPdfViewer.FreeTextModalViewDisappearing
    SfPdfViewer.GetPageNumberFromClientPoint(Point)
    SfPdfViewer.GoToBookmark(Bookmark)
    SfPdfViewer.GoToFirstPage()
    SfPdfViewer.GoToFirstPageCommand
    SfPdfViewer.GoToLastPage()
    SfPdfViewer.GoToLastPageCommand
    SfPdfViewer.GoToNextPage()
    SfPdfViewer.GoToNextPageCommand
    SfPdfViewer.GoToOutlineElement(OutlineElement)
    SfPdfViewer.GoToPage(Int32)
    SfPdfViewer.GoToPageCommand
    SfPdfViewer.GoToPreviousPage()
    SfPdfViewer.GoToPreviousPageCommand
    SfPdfViewer.HorizontalOffset
    SfPdfViewer.HorizontalOffsetProperty
    SfPdfViewer.HyperlinkClicked
    SfPdfViewer.ImportAnnotations(Stream, AnnotationDataFormat)
    SfPdfViewer.ImportAnnotationsAsync(Stream, AnnotationDataFormat, CancellationToken)
    SfPdfViewer.ImportFormData(Stream, DataFormat, Boolean)
    SfPdfViewer.ImportFormDataAsync(Stream, DataFormat, Boolean, CancellationToken)
    SfPdfViewer.IsCommentsPanelVisible
    SfPdfViewer.IsCommentsPanelVisibleProperty
    SfPdfViewer.IsDocumentModified
    SfPdfViewer.IsDocumentModifiedProperty
    SfPdfViewer.IsOutlineViewVisible
    SfPdfViewer.IsOutlineViewVisibleProperty
    SfPdfViewer.IsThumbnailViewVisible
    SfPdfViewer.IsThumbnailViewVisibleProperty
    SfPdfViewer.LoadDocument(Byte[], String, Nullable<FlattenOptions>)
    SfPdfViewer.LoadDocument(Stream, String, Nullable<FlattenOptions>)
    SfPdfViewer.LoadDocumentAsync(Byte[], String, Nullable<FlattenOptions>, CancellationTokenSource)
    SfPdfViewer.LoadDocumentAsync(Stream, String, Nullable<FlattenOptions>, CancellationTokenSource)
    SfPdfViewer.LoadDocumentCommand
    SfPdfViewer.MaxZoomFactor
    SfPdfViewer.MaxZoomFactorProperty
    SfPdfViewer.MinZoomFactor
    SfPdfViewer.MinZoomFactorProperty
    SfPdfViewer.OnSizeAllocated(Double, Double)
    SfPdfViewer.OverscanCount
    SfPdfViewer.OverscanCountProperty
    SfPdfViewer.PageCount
    SfPdfViewer.PageCountProperty
    SfPdfViewer.PageLayoutMode
    SfPdfViewer.PageLayoutModeProperty
    SfPdfViewer.PageNumber
    SfPdfViewer.PageNumberProperty
    SfPdfViewer.PasswordRequested
    SfPdfViewer.PersistZoomOnPageChange
    SfPdfViewer.PrintDocument()
    SfPdfViewer.PrintDocumentCommand
    SfPdfViewer.PrintDocumentCompleted
    SfPdfViewer.PrintSettings
    SfPdfViewer.RedactAsync(CancellationToken)
    SfPdfViewer.RedactionMarks
    SfPdfViewer.RedactionMode
    SfPdfViewer.RedactionSettings
    SfPdfViewer.RedoCommand
    SfPdfViewer.RemoveAllAnnotations()
    SfPdfViewer.RemoveAllAnnotationsCommand
    SfPdfViewer.RemoveAllRedactionMarks()
    SfPdfViewer.RemoveAnnotation(Annotation)
    SfPdfViewer.RemoveRedactionMark(RedactionMark)
    SfPdfViewer.SaveDocument(Stream)
    SfPdfViewer.SaveDocumentAsync(Stream, CancellationToken)
    SfPdfViewer.SaveDocumentCommand
    SfPdfViewer.ScrollToOffset(Double, Double)
    SfPdfViewer.ScrollToOffsetCommand
    SfPdfViewer.SearchTextAsync(String, TextSearchOptions, CancellationTokenSource)
    SfPdfViewer.SearchTextCommand
    SfPdfViewer.SelectAnnotation(Annotation)
    SfPdfViewer.SelectedRedactionMark
    SfPdfViewer.ShowScrollHead
    SfPdfViewer.ShowScrollHeadProperty
    SfPdfViewer.ShowToolbars
    SfPdfViewer.ShowToolbarsProperty
    SfPdfViewer.SignAsync(SigningOptions)
    SfPdfViewer.SignatureCreated
    SfPdfViewer.SignatureModalViewAppearing
    SfPdfViewer.SignatureModalViewDisappearing
    SfPdfViewer.SignatureValidated
    SfPdfViewer.SigningFailed
    SfPdfViewer.StickyNoteModalViewAppearing
    SfPdfViewer.StickyNoteModalViewDisappearing
    SfPdfViewer.Tapped
    SfPdfViewer.TextSearchProgress
    SfPdfViewer.TextSearchSettings
    SfPdfViewer.TextSearchSettingsProperty
    SfPdfViewer.TextSelectionChanged
    SfPdfViewer.TextSelectionSettings
    SfPdfViewer.TextSelectionSettingsProperty
    SfPdfViewer.Toolbars
    SfPdfViewer.UndoCommand
    SfPdfViewer.UnloadDocument()
    SfPdfViewer.UnloadDocumentAsync()
    SfPdfViewer.ValidateSignaturesAsync()
    SfPdfViewer.VerticalOffset
    SfPdfViewer.VerticalOffsetProperty
    SfPdfViewer.ZoomFactor
    SfPdfViewer.ZoomFactorProperty
    SfPdfViewer.ZoomMode
    SfPdfViewer.ZoomModeProperty
    SfView.ArrangeContent(Rect)
    SfView.ArrangeOverride(Rect)
    SfView.Children
    SfView.ClipToBounds
    SfView.GetSemanticsNodesCore(Double, Double)
    SfView.IDrawableLayout.DrawingOrder
    SfView.IDrawableLayout.InvalidateDrawable()
    SfView.MeasureContent(Double, Double)
    SfView.MeasureOverride(Double, Double)
    SfView.OnBindingContextChanged()
    SfView.OnDraw(ICanvas, RectF)
    SfView.OnHandlerChanged()
    SfView.Padding
    SfView.PaddingProperty
    Namespace: Syncfusion.Maui.SmartPdfViewer
    Assembly: Syncfusion.Maui.SmartPdfViewer.dll
    Syntax
    public class SfSmartPdfViewer : SfPdfViewer, IDrawableLayout, IDrawable, IAbsoluteLayout, ILayout, IView, IElement, ITransform, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IVisualTreeElement, ISemanticsProvider, ITouchListener, IThemeElement

    Constructors

    SfSmartPdfViewer()

    Initializes a new instance of the SfSmartPdfViewer class and sets up the default configuration required for PDF viewing, navigation, form interaction, and Smart AI-powered features.

    Declaration
    public SfSmartPdfViewer()

    Fields

    AssistViewSettingsProperty

    Backing store for AssistViewSettings property.

    Declaration
    public static readonly BindableProperty AssistViewSettingsProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    IsAIAssistViewVisibleProperty

    Backing store for IsAIAssistViewVisible.

    Declaration
    public static readonly BindableProperty IsAIAssistViewVisibleProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    IsSmartRedactViewVisibleProperty

    Backing store for IsSmartRedactViewVisible.

    Declaration
    public static readonly BindableProperty IsSmartRedactViewVisibleProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SmartFillSettingsProperty

    Backing store for SmartFillSettings property.

    Declaration
    public static readonly BindableProperty SmartFillSettingsProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SmartRedactSettingsProperty

    Backing store for SmartRedactSettings property.

    Declaration
    public static readonly BindableProperty SmartRedactSettingsProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    Properties

    AssistViewSettings

    Initializes the Assist View settings and configures the default properties, behaviors, and resources required for Assist View functionality.

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

    IsAIAssistViewVisible

    Gets or sets a value indicating whether the AI Assist View panel is visible in the Smart PDF Viewer.

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

    When set to true, the Assist View panel is displayed, allowing users to interact with AI-powered document assistance features such as document summaries, question answering, and contextual document analysis. When set to false, the Assist View panel is hidden from view. This property controls only the visibility of the Assist View panel and does not disable the underlying Assist View functionality or settings.

    IsSmartRedactViewVisible

    Gets or sets a value indicating whether the Smart Redaction panel is visible in the Smart PDF Viewer.

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

    When set to true, the Smart Redaction panel is displayed and users can access AI-assisted redaction tools directly from the viewer interface. When set to false, the Smart Redaction panel is hidden from view. This property controls only the visibility of the panel and does not affect the Smart Redaction feature availability or configuration.

    SmartFillSettings

    Initializes a new instance of the SmartFillSettings class and configures the default settings required for the Smart Fill feature.

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

    SmartRedactSettings

    Initializes a new instance of the SmartRedactSettings class and configures the default settings required for Smart Redaction functionality.

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

    Methods

    ApplySmartFillAsync(String, CancellationToken)

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

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

    Specifies the custom text input used by the AI to identify and populate matching form fields in the loaded PDF document.

    System.Threading.CancellationToken cancellationToken

    Specifies a token that can be used to cancel the Smart Fill operation.

    Returns
    Type
    System.Threading.Tasks.Task
    Remarks

    The operation can be cancelled while it is in progress.

    ApplySmartFillAsync(CancellationToken)

    Initiates the Smart Fill process using the extracted form field names and the current clipboard data.

    Declaration
    public Task ApplySmartFillAsync(CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.Threading.CancellationToken cancellationToken

    Specifies a token that can be used to cancel the Smart Fill operation.

    Returns
    Type
    System.Threading.Tasks.Task
    Remarks

    When executed, this method uses AI to analyze the clipboard content and map the extracted values to the corresponding form fields in the loaded PDF document. The operation can be cancelled while it is in progress.

    Dispose()

    Disposes the Smart PDF Viewer and its associated resources and dependencies.

    Declaration
    public void Dispose()

    GetPrompts()

    Returns the list of prompts available in the Assist View.

    Declaration
    public IReadOnlyList<AssistItem> GetPrompts()
    Returns
    Type Description
    System.Collections.Generic.IReadOnlyList<AssistItem>

    A list of prompts available in the Assist View.

    Implements

    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<>
    System.Collections.Generic.ICollection<>
    System.Collections.Generic.IEnumerable<>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved