Class PdfViewerAnnotationSettings

Inheritance

System.Object

BaseComponent

PdfViewerAnnotationSettings

PdfViewerFreeTextSettings

PdfViewerStickyNotesSettings

Implements

System.IDisposable

Inherited Members

BaseComponent.CreateJsAdaptor()

BaseComponent.OnAfterRenderAsync(Boolean)

BaseComponent.Dispose()

BaseComponent.Refresh()

BaseComponent.clearClientChanges(Boolean)

BaseComponent.InvokeSet<T>(String, String, Object[])

BaseComponent.InvokeGet<T>(String, String)

BaseComponent.WireObservableEvents(Object)

BaseComponent.getSerializedModel()

BaseComponent.getUpdateModel(Boolean)

BaseComponent.GetDataManager(Object, String)

BaseComponent.uniqueId

BaseComponent.jsRuntime

BaseComponent.EditContext

BaseComponent.nameSpace

BaseComponent.DotNetObjectRef

Namespace: Syncfusion.Blazor.PdfViewer

Assembly: Syncfusion.Blazor.dll

Syntax

public class PdfViewerAnnotationSettings : BaseComponent, IDisposable

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	Description
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	Description
System.String

ChildContent

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
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	Description
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	Description
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	Description
System.Boolean

JsNamespace

Declaration

protected virtual string JsNamespace { get; set; }

Property Value

Type	Description
System.String

jsProperty

Declaration

protected override string jsProperty { get; set; }

Property Value

Type	Description
System.String

Overrides

BaseComponent.jsProperty

mainParent

Declaration

protected override BaseComponent mainParent { get; set; }

Property Value

Type	Description
BaseComponent

Overrides

BaseComponent.mainParent

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	Description
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	Description
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	Description
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	Description
System.Int32

Remarks

This property not applicable for Textmarkup and Sticky notes annotation.

SfTagIndex

Declaration

protected virtual int SfTagIndex { get; set; }

Property Value

Type	Description
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	Description
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	Description
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	Description
System.String

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Implements

System.IDisposable