Class PdfViewerShapeSettings

Represents the attributes of shape annotation settings.

Inheritance
object
PdfViewerAnnotationSettings
PdfViewerShapeSettings
PdfViewerAreaSettings
PdfViewerCircleSettings
PdfViewerHandwrittenSignatureSettings
PdfViewerLineSettings
PdfViewerPerimeterSettings
PdfViewerPolygonSettings
PdfViewerRadiusSettings
PdfViewerRectangleSettings
PdfViewerRedactionSettings
PdfViewerVolumeSettings
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public abstract class PdfViewerShapeSettings : PdfViewerAnnotationSettings

Constructors

PdfViewerShapeSettings()

Declaration
protected PdfViewerShapeSettings()

Properties

AnnotationSelectorSettings

Defines the annotaton selector settings for the annotation.

Declaration
[Parameter]
[JsonPropertyName("annotationSelectorSettings")]
public PdfViewerAnnotationSelectorSettings AnnotationSelectorSettings { get; set; }
Property Value
Type
PdfViewerAnnotationSelectorSettings

BorderDashArray

Defines the border dash array. By default it is .

Declaration
[Parameter]
[JsonPropertyName("borderDashArray")]
public int[] BorderDashArray { get; set; }
Property Value
Type
int[]

FillColor

specifies the fill color of the annotation.

Declaration
[Parameter]
[JsonPropertyName("fillColor")]
public string FillColor { get; set; }
Property Value
Type
string

JsNamespace

Gets or sets the JavaScript interop namespace for this component.

Declaration
protected override string JsNamespace { get; set; }
Property Value
Type
string
Overrides

JsProperty

Gets or sets the JS interop property name used internally.

Declaration
protected virtual string JsProperty { get; set; }
Property Value
Type
string

MainParent

Gets or sets the parent base component reference.

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

Opacity

Defines the opacity for the shape annotations. By default it is 1. It's range varies 0 to 1.

Declaration
[Parameter]
[JsonPropertyName("opacity")]
public double Opacity { get; set; }
Property Value
Type
double

SfTagIndex

Gets or sets tag index used to compose the JS namespace within the parent hierarchy.

Declaration
protected override int SfTagIndex { get; set; }
Property Value
Type
int
Overrides

StrokeColor

Defines the stroke color of the shape annotations. By default it is "".

Declaration
[Parameter]
[JsonPropertyName("strokeColor")]
public string StrokeColor { get; set; }
Property Value
Type
string

Thickness

Defines the thickness of the shape annotations. By default it is 1. It's range varies 1 to 10.

Declaration
[Parameter]
[JsonPropertyName("thickness")]
public int Thickness { get; set; }
Property Value
Type
int

Methods

OnInitializedAsync()

Performs asynchronous initialization for the component.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A task that represents the asynchronous initialization operation.
Overrides

OnParametersSetAsync()

Applies parameter changes and updates child properties when needed.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A task that represents the asynchronous parameter-set operation.
Overrides