Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfViewerFreeTextSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PdfViewerFreeTextSettings

    Inheritance
    System.Object
    SfBaseComponent
    PdfViewerAnnotationSettings
    PdfViewerFreeTextSettings
    Implements
    System.IDisposable
    Inherited Members
    PdfViewerAnnotationSettings.GetJSNamespace()
    PdfViewerAnnotationSettings.mainParent
    PdfViewerAnnotationSettings.jsProperty
    PdfViewerAnnotationSettings.ChildContent
    PdfViewerAnnotationSettings.Author
    PdfViewerAnnotationSettings.CustomData
    PdfViewerAnnotationSettings.IsLock
    PdfViewerAnnotationSettings.SkipDownload
    PdfViewerAnnotationSettings.SkipPrint
    PdfViewerAnnotationSettings.MaxHeight
    PdfViewerAnnotationSettings.MaxWidth
    PdfViewerAnnotationSettings.MinHeight
    PdfViewerAnnotationSettings.MinWidth
    PdfViewerAnnotationSettings.IsPrint
    PdfViewerAnnotationSettings.AllowedInteractions
    SfBaseComponent.OnAfterRenderAsync(Boolean)
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    Namespace: Syncfusion.Blazor.PdfViewer
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class PdfViewerFreeTextSettings : PdfViewerAnnotationSettings, IDisposable

    Constructors

    PdfViewerFreeTextSettings()

    Declaration
    public PdfViewerFreeTextSettings()

    Properties

    AllowEditTextOnly

    If it is set as true, then we can't move , resize the freetext annotations in the PDF Viewer. Just we can modify the existing text content. Otherwise along with modifying text we can resize, move the existing text content.By default it is false.

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

    AnnotationSelectorSettings

    Defines the annotaton selector settings for the freetext annotation.

    Declaration
    public PdfViewerAnnotationSelectorSettings AnnotationSelectorSettings { get; set; }
    Property Value
    Type Description
    PdfViewerAnnotationSelectorSettings

    BorderColor

    Defines the border color for free text or label text for shape and measurement annotation. By default it is "#ffffff00".

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

    BorderStyle

    Defines the border style for free text or label text for shape and measurement annotation. By default it is "solid".

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

    BorderThickness

    Defines the border width for free text or label text for shape and measurement annotation. By default it is "1".

    Declaration
    public int BorderThickness { get; set; }
    Property Value
    Type Description
    System.Int32

    DefaultText

    Defines the fill color for free text or label text for shape and measurement annotation. By default it is "Type Here".

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

    FillColor

    Defines the fill color for free text or label text for shape and measurement annotation. By default it is "#ffffff00".

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

    FontColor

    Defines the font color for free text or label text for shape and measurement annotation. By default it is "#000".

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

    FontFamily

    Defines the font family for free text or label text for shape and measurement annotation. By default it is "Helvetica".

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

    FontSize

    Defines the font size for free text or label text for shape and measurement annotation. By default it is "16".

    Declaration
    public double FontSize { get; set; }
    Property Value
    Type Description
    System.Double

    FontStyle

    Defines the font style for free text or label text for shape and measurement annotation. By default it is "None".

    Declaration
    public FontStyle FontStyle { get; set; }
    Property Value
    Type Description
    FontStyle

    Height

    Defines the height for free text or label text for shape and measurement annotation. By default it is "24.6".

    Declaration
    public double Height { get; set; }
    Property Value
    Type Description
    System.Double

    JsNamespace

    Declaration
    protected override string JsNamespace { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    PdfViewerAnnotationSettings.JsNamespace

    JsProperty

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

    MainParent

    Declaration
    protected SfBaseComponent MainParent { get; set; }
    Property Value
    Type Description
    SfBaseComponent

    Opacity

    Defines the opacity for free text or label text for shape and measurement annotation. By default it is "1".

    Declaration
    public double Opacity { get; set; }
    Property Value
    Type Description
    System.Double

    SfTagIndex

    Declaration
    protected override int SfTagIndex { get; set; }
    Property Value
    Type Description
    System.Int32
    Overrides
    PdfViewerAnnotationSettings.SfTagIndex

    TextAlignment

    Defines the text alignment for free text or label text for shape and measurement annotation. By default it is "Left".

    Declaration
    public TextAlignment TextAlignment { get; set; }
    Property Value
    Type Description
    TextAlignment

    Width

    Defines the width for free text or label text for shape and measurement annotation. By default it is "151".

    Declaration
    public int Width { get; set; }
    Property Value
    Type Description
    System.Int32

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder
    Overrides
    PdfViewerAnnotationSettings.BuildRenderTree(RenderTreeBuilder)

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    PdfViewerAnnotationSettings.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    PdfViewerAnnotationSettings.OnParametersSetAsync()

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved