Class PdfViewerToolbarSettings

Represents the toolbar settings for the PDF Viewer component.

Inheritance
object
PdfViewerToolbarSettings
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class PdfViewerToolbarSettings : SfBaseComponent
Remarks

This class allows configuring toolbar visibility, tooltip behavior, and customizing toolbar items.

Examples

Example usage in a Blazor component:

Constructors

PdfViewerToolbarSettings()

Declaration
public PdfViewerToolbarSettings()

Properties

AnnotationToolbarItems

Provide option to customize the annotation toolbar of the PDF Viewer. PDF Viewer annotation toolbar will be rendered only options configured with this property.

Declaration
[Parameter]
[JsonPropertyName("annotationToolbarItems")]
public List<AnnotationToolbarItem> AnnotationToolbarItems { get; set; }
Property Value
Type
List<AnnotationToolbarItem>

ChildContent

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

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

CustomToolbarItems

Represents a class specifying properties for customize toolbar items.

Declaration
[Parameter]
[JsonIgnore]
public List<PdfToolbarItem> CustomToolbarItems { get; set; }
Property Value
Type
List<PdfToolbarItem>
Remarks

This class encapsulates the properties of Index and Template for Custom Toolbar Items. It can use instances of this class to define the order and appearance of Custom Items within the Toolbar.

FormDesignerToolbarItems

Gets or sets the toolbar items available in the form designer of the PDF Viewer.

Declaration
[Parameter]
[JsonPropertyName("formdesignerToolbarItems")]
public List<FormDesignerToolbarItem> FormDesignerToolbarItems { get; set; }
Property Value
Type Description
List<FormDesignerToolbarItem>

A list of FormDesignerToolbarItem representing the available toolbar items.
Remarks

This property allows customization of the form designer toolbar by specifying which tools are available for form field creation and manipulation.
Provide a list of FormDesignerToolbarItem to define the toolbar configuration. See PdfViewerToolbarSettings for more details.

Examples
<SfPdfViewer2>
<PdfViewerToolbarSettings FormDesignerToolbarItems="toolbarItems"> </PdfViewerToolbarSettings>
</SfPdfViewer2>

@code {
    List<FormDesignerToolbarItem> toolbarItems = new List<FormDesignerToolbarItem>
    {
       FormDesignerToolbarItem.Textbox,
       FormDesignerToolbarItem.Password,
       FormDesignerToolbarItem.Delete
    };
}

MobileToolbarItems

Specifies options for the Mobile Toolbar in the PDF Viewer. The PDF Viewer toolbar in mobile will only display options configured with this property.

Declaration
[Parameter]
[JsonPropertyName("mobileToolbarItem")]
public List<MobileToolbarItem> MobileToolbarItems { get; set; }
Property Value
Type
List<MobileToolbarItem>
Remarks

This list contains the enumeration values for mobile toolbar items.

See Also

RedactionToolbarItems

Gets or sets the toolbar items available in the redaction toolbar of the PDF Viewer.

Declaration
[Parameter]
[JsonPropertyName("redactionToolbarItems")]
public List<RedactionToolbarItem> RedactionToolbarItems { get; set; }
Property Value
Type Description
List<RedactionToolbarItem>

A list of RedactionToolbarItem representing the available toolbar items.
Remarks

This property allows customization of the redaction toolbar by specifying which tools are available for redaction operations. Provide a list of RedactionToolbarItem to define the toolbar configuration.

Examples
<SfPdfViewer2>
    <PdfViewerToolbarSettings RedactionToolbarItems="redactionItems"> </PdfViewerToolbarSettings>
</SfPdfViewer2>

@code {
    List<RedactionToolbarItem> redactionItems = new List<RedactionToolbarItem>
    {
        RedactionToolbarItem.MarkForRedaction,
        RedactionToolbarItem.RedactPages,
        RedactionToolbarItem.Delete
    };
}

ShowTooltip

Enable or disables the toolbar of PdfViewer. By default it is true.

Declaration
[Parameter]
[JsonPropertyName("showTooltip")]
public bool ShowTooltip { get; set; }
Property Value
Type
bool

ToolbarItems

Provide option to customize the toolbar of the PDF Viewer. PDF Viewer toolbar will be rendered only options configured with this property.

Declaration
[Parameter]
[JsonPropertyName("toolbarItems")]
public List<ToolbarItem> ToolbarItems { get; set; }
Property Value
Type
List<ToolbarItem>

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

OnInitializedAsync()

Performs asynchronous initialization for the component, registers it with the parent viewer, and initializes backing fields from current parameter values.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A task that represents the asynchronous initialization operation.

OnParametersSet()

Applies parameter changes and updates combined toolbar items with custom items in correct order.

Declaration
protected override void OnParametersSet()

OnParametersSetAsync()

Applies parameter changes and notifies property updates to the parent component when needed.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A task that represents the asynchronous parameter-set operation.