Class PdfViewerMeasurementSettings

Represents the settings for measurements in the PDF viewer component in Blazor applications.

Inheritance

object

PdfViewerMeasurementSettings

Namespace: Syncfusion.Blazor.SfPdfViewer

Assembly: Syncfusion.Blazor.SfPdfViewer.dll

Syntax

public class PdfViewerMeasurementSettings : SfBaseComponent

Remarks

This class manages the configuration for measurement-related properties, such as the conversion unit, depth, display unit, and scale ratio. It ensures that the settings are properly initialized and updated whenever parameters are set or changed.

Examples

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

Constructors

PdfViewerMeasurementSettings()

Declaration

public PdfViewerMeasurementSettings()

Properties

ChildContent

Declaration

[Parameter]
[JsonIgnore]
public RenderFragment ChildContent { get; set; }

Property Value

Type
RenderFragment

ConversionUnit

Defines the unit for measuring annotation. By default it is "in".

Declaration

[Parameter]
[JsonPropertyName("conversionUnit")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public CalibrationUnit ConversionUnit { get; set; }

Property Value

Type
CalibrationUnit

Depth

Defines the value for depth. By default it is 96.

Declaration

[Parameter]
[JsonPropertyName("depth")]
public int Depth { get; set; }

Property Value

Type
int

DisplayUnit

Defines the display unit for measuring annotation. By default it is "inch".

Declaration

[Parameter]
[JsonPropertyName("displayUnit")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public CalibrationUnit DisplayUnit { get; set; }

Property Value

Type
CalibrationUnit

ScaleRatio

Defines the scale ratio for measuring annotation. By default it is "1". It will be multiplied the actual value of measurement and this multiplied value only displayed in UI.

Declaration

[Parameter]
[JsonPropertyName("scaleRatio")]
public double ScaleRatio { get; set; }

Property Value

Type
double

jsProperty

Declaration

protected string jsProperty { get; set; }

Property Value

Type
string

mainParent

Declaration

protected SfBaseComponent mainParent { get; set; }

Property Value

Type
SfBaseComponent

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
Task

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
Task