Class PdfViewerScrollSettings

Represents the settings related to scrolling in the PDF viewer component in Blazor applications.

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

This class handles the configuration of scroll-related properties, such as the delay for page requests while scrolling. It ensures that the settings are initialized and updated correctly during component lifecycle events.

Examples

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

Constructors

PdfViewerScrollSettings()

Declaration
public PdfViewerScrollSettings()

Properties

ChildContent

Gets or sets the child content to be rendered inside the scroll settings component.

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

DelayPageRequestTimeOnScroll

Increase or decrease the render pdf page request delay on scrolling action and it's unit is milli seconds.

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

jsProperty

The JS interop property name used internally.

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

mainParent

Reference to the parent base component in the hierarchy.

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()

Performs async initialization and sets up state and JS namespace.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Applies parameter changes and updates child properties when needed.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements