Skip to content
BlazorUI

Legacy

PdfReaderLegacy

Bit.BlazorUI.Legacy

BitPdfReaderLegacy is a simple pdf renderer utilizing the pdfjs library to bring pdf reading feature into Blazor world.

Notes

To use this component, you need to install the Bit.BlazorUI.Legacy nuget package, as described in the Legacy components section of the Getting started page.

Usage

Every example is live. Open its code to see exactly what produced the component running underneath.

Basic

RenderAllPages

Public API

    /    |

API

Every parameter, public member, sub-class and enum this component exposes.

BitPdfReaderLegacy parameters

Name Type Default value Description
CanvasClass string? null The CSS class of the canvas element(s).
CanvasStyle string? null The CSS style of the canvas element(s).
Config BitPdfReaderLegacyConfig The configuration of the pdf reader.
Horizontal bool false Renders the pages horizontally.
InitialPageNumber int 1 The page number to render initially.
OnPdfPageRendered EventCallback The callback for when the pdf page is done rendering.
OnPdfLoaded EventCallback The callback for when the pdf document is done loading and processing.
RenderAllPages bool false Whether render all pages at start.

BitComponentBase parameters

Name Type Default value Description
AriaLabel string? null Gets or sets the accessible label for the component, used by assistive technologies.
Class string? null Gets or sets the CSS class name(s) to apply to the rendered element.
Dir BitDir? null Gets or sets the text directionality for the component's content.
ForceAnimation bool false Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters.
Id string? null Gets or sets the unique identifier for the component's root element.
IsEnabled bool true Gets or sets a value indicating whether the component is enabled and can respond to user interaction.
Style string? null Gets or sets the CSS style string to apply to the rendered element.
TabIndex string? null Gets or sets the tab order index for the component when navigating with the keyboard.
Visibility BitVisibility BitVisibility.Visible Gets or sets the visibility state (visible, hidden, or collapsed) of the component.

BitComponentBase public members

Name Type Default value Description
UniqueId Guid Guid.NewGuid() Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed.
RootElement ElementReference Gets the reference to the root HTML element associated with this component.

BitPdfReaderLegacyConfig properties

Name Type Default value Description
Id string Guid.NewGuid().ToString() The id of the pdf reader instance and its canvas element(s).
Url string The URL of the pdf file.
Scale decimal 1 The scale in which the pdf document gets rendered on the page.
AutoScale bool true Automatically scales the pdf based on the device pixel-ratio.

BitVisibility enum

Name Value Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).

BitDir enum

Name Value Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.

Feedback

Found a mistake, a gap, or something that could be clearer? Every page and every component is one click from its source.