Class PdfViewerAnnotationSelectorSettings

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

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
PdfViewerAnnotationSelectorSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class PdfViewerAnnotationSelectorSettings : SfBaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

This class provides functionality to manage and initialize the settings related to the annotation selector, such as resizer location, shape, border properties, and selector line styles. These settings are initialized asynchronously when the component is initialized, and the properties are updated when parameters change.

Examples

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

Constructors

PdfViewerAnnotationSelectorSettings()

Declaration
public PdfViewerAnnotationSelectorSettings()

Properties

ChildContent

Gets or sets the child content to render within this settings component.

Declaration
[Parameter]
[JsonIgnore]
public RenderFragment ChildContent { get; set; }
Property Value
Type
RenderFragment

ResizerBorderColor

Defines the annotation resizer border color. By default it is black.

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

ResizerCursorType

Defines the annotation resizer Type. By default it is null.

Declaration
[Parameter]
[JsonPropertyName("resizerCursorType")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public CursorType? ResizerCursorType { get; set; }
Property Value
Type
CursorType?

ResizerFillColor

Defines the annotation resizer fill color.

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

ResizerLocation

Defines the location for the resizer of the annotation. It is used to customize the resizer location of the annotation.

Declaration
[Parameter]
[JsonPropertyName("resizerLocation")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public AnnotationResizerLocation ResizerLocation { get; set; }
Property Value
Type
AnnotationResizerLocation

ResizerShape

Defines the shape of the resizer. By default it is Square. Different shapes of resizer are circle and square.

Declaration
[Parameter]
[JsonPropertyName("resizerShape")]
public AnnotationResizerShape ResizerShape { get; set; }
Property Value
Type
AnnotationResizerShape

ResizerSize

Defines the size of the resizer used for annotations.

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

SelectionBorderColor

Defines the selection border color for the annotation. By default it is empty. It is used to customize the selection border color for the annotation.

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

SelectionBorderThickness

Defines the selection border thickness for the annotation. By default it is 1. It is used to customize the selection border thickness for the annotation. It's range varies from 1 to 10.

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

SelectorLineDashArray

Defines the selector line dash array. By default it is empty.

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

jsProperty

Gets or sets the computed JS property name for interop.

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

mainParent

Gets or sets the main parent component reference.

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
Overrides

OnInitializedAsync()

Initializes component state and references during component initialization.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Updates internal state based on parameter changes and notifies property updates.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements