Class PdfViewerAnnotationSettings

Represents the annotation settings for a PDF viewer component in Blazor applications.

Inheritance
System.Object
PdfViewerAnnotationSettings
PdfViewerFreeTextSettings
PdfViewerShapeSettings
PdfViewerStickyNotesSettings
PdfViewerTextMarkupSettings
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class PdfViewerAnnotationSettings : SfBaseComponent
Remarks

This class provides functionality to manage and initialize annotation settings for a PDF viewer, such as author details, custom data, interaction settings, and restrictions on download or printing. It ensures that the settings are initialized and updated whenever parameters are set.

Examples

Below is an example of how to use PdfViewerAnnotationSettings in a Blazor component:





@code {
   private object customData = "{'customerID':'0001'}";
   private List<AllowedInteraction> allowedInterations = new List<AllowedInteraction> { AllowedInteraction.Resize };
}

Constructors

PdfViewerAnnotationSettings()

Declaration
public PdfViewerAnnotationSettings()

Properties

AllowedInteractions

Gets or sets the allowed interactions for the locked area annotations. IsLock can be configured using area settings.

Declaration
public List<AllowedInteraction> AllowedInteractions { get; set; }
Property Value
Type
System.Collections.Generic.List<AllowedInteraction>

Author

Specifies the author's name to add annotation or review the PDF document. By default it is Guest.

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

ChildContent

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type
Microsoft.AspNetCore.Components.RenderFragment

CustomData

Specifies the user's defined information related to the annotations. By default it is null.

Declaration
public object CustomData { get; set; }
Property Value
Type
System.Object

IsLock

If it is set as true, can't interact with annotation. Otherwise can interact the annotations. By default it is false.

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

IsPrint

Gets or sets the value for the individual annotations are included or not in print actions.

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

JsNamespace

Declaration
protected virtual string JsNamespace { get; set; }
Property Value
Type
System.String

jsProperty

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

mainParent

Declaration
protected SfBaseComponent mainParent { get; set; }
Property Value
Type
SfBaseComponent

MaxHeight

Sets the maximum height of annotations. It prevents the height of the annotation becoming larger than the values provided in MaxHeight.By default it is 0.

Declaration
public int MaxHeight { get; set; }
Property Value
Type
System.Int32
Remarks

This property not applicable for Textmarkup and Sticky notes annotation.

MaxWidth

Sets the maximum width of annotations. It prevents the width of the annotation becoming larger than values provided in MaxWidth.By default it is 0.

Declaration
public int MaxWidth { get; set; }
Property Value
Type
System.Int32
Remarks

This property not applicable for Textmarkup and Sticky notes annotation.

MinHeight

Sets the minimum height of annotations. It prevents the height of the annotation becoming smaller than values provided in MinHeight.By default it is 0.

Declaration
public int MinHeight { get; set; }
Property Value
Type
System.Int32
Remarks

This property not applicable for Textmarkup and Sticky notes annotation.

MinWidth

Sets the minimum width of annotations. It prevents the width of the annotation becoming smaller than values provided in MinWidth.By default it is 0.

Declaration
public int MinWidth { get; set; }
Property Value
Type
System.Int32
Remarks

This property not applicable for Textmarkup and Sticky notes annotation.

SfTagIndex

Declaration
protected virtual int SfTagIndex { get; set; }
Property Value
Type
System.Int32

SkipDownload

If it is set as true, newly added annotations won't be included in downloaded file. By default it is false.

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

SkipPrint

If it is set as true, newly added annotations won't be included in printing. By default it is false.

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

GetJSNamespace()

Declaration
public string GetJSNamespace()
Returns
Type
System.String

OnInitializedAsync()

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

OnParametersSetAsync()

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