PdfViewer
This documentation provides a comprehensive reference for the PdfViewer component, guiding you through its configuration options.
Screenshot #
Parameters #
| Name | Type | Default | Required | Description | Added Version |
|---|---|---|---|---|---|
| AdditionalAttributes | Dictionary<string, object> | null | Gets or sets additional attributes that will be applied to the component. | 1.0.0 | |
| Class | string? | null | Gets or sets the CSS class name(s) to apply to the component. | 1.0.0 | |
| Id | string? | null | Gets or sets the ID. If not set, a unique ID will be generated. | 1.0.0 | |
| Orientation | Orientation | Portrait | Gets or sets the preferred orientation for the PDF viewer. | 1.0.0 | |
| Password | string? | null | Gets or sets the password used for the PDF document if it is password-protected. | 1.1.0 | |
| PdfContainerCssClass | string? | null | Gets or sets the pdf container css class. | 1.0.0 | |
| Style | string? | null | Gets or sets the CSS style string that defines the inline styles for the component. | 1.0.0 | |
| Url | string? | null | Gets or sets the URL of the PDF document to be displayed. PDF Viewer component supports base64 string as a URL. | 1.0.0 |
Events #
| Name | Return Type | Description | Added Version |
|---|---|---|---|
| OnDocumentLoaded | EventCallback<PdfViewerEventArgs> | This event fires immediately after the PDF document is loaded. | 1.0.0 |
| OnDocumentLoadError | EventCallback<string> | This event fires if there is an error loading the PDF document. | 1.1.0 |
| OnPageChanged | EventCallback<PdfViewerEventArgs> | This event fires immediately after the page is changed. | 1.0.0 |