Class PdfViewerCommentPanelSettings

Represents the settings for the comment panel in a PDF viewer component in Blazor applications.

Inheritance

object

PdfViewerCommentPanelSettings

Namespace: Syncfusion.Blazor.SfPdfViewer

Assembly: Syncfusion.Blazor.SfPdfViewer.dll

Syntax

public class PdfViewerCommentPanelSettings : SfBaseComponent

Remarks

This class provides functionality to manage and initialize the settings related to the comment panel in the PDF viewer, such as enabling multiline support and customizing the date-time format for the comment timestamps. These settings are initialized asynchronously during the component lifecycle, and they are updated whenever parameters change.

Examples

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

Constructors

PdfViewerCommentPanelSettings()

Declaration

public PdfViewerCommentPanelSettings()

Properties

ChildContent

Declaration

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

Property Value

Type
RenderFragment

DateTimeFormat

Allows the customization of dates within the comment panel.

Declaration

[Parameter]
public string DateTimeFormat { get; set; }

Property Value

Type
string

JsNamespace

Declaration

protected virtual string JsNamespace { get; set; }

Property Value

Type
string

Multiline

Enable or disable the use of multiline text boxes in the comment panel. By default it is false.

Declaration

[Parameter]
public bool Multiline { get; set; }

Property Value

Type
bool

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