New to Telerik UI for WinForms? Start a free 30-day trial
Properties
Updated over 6 months ago
| Property | Description |
|---|---|
| HorizontalScrollState | Gets or sets the display state of the horizontal scroll bar. |
| VerticalScrollState | Gets or sets the display state of the vertical scroll bar. |
| EnableThumbnails | Gets or sets whether the thumbnail element is visible. |
| ContainerElement | Gets the which represents the elements container of the control. |
| PdfViewerElement | Gets the which represents the main element of the control. |
| AnnotationsColor | Gets or sets the background color of the annotations when they are pressed. |
| FitToWidth | Fit to window width |
| FitFullPage | Fit one full page to control |
| SelectionColor | Gets or sets the color that highlights the current selection. |
| ScaleFactor | Gets or sets the factor by which the document is scaled. |
| Document | Gets the currently loaded |
| ReadingMode | Gets or sets whether the entire document is loaded at the beginning or pages are loaded on demand. |
| RadContextMenu | Gets or sets the associated . By default this is . |
| ViewerMode | Gets or sets the current viewer mode - Pan, TextSelection or None. |
| BackColor | RadPdfViewer consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored. |
| ForeColor | RadPdfViewer consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored. |
| ThumbnailListWidth | Get or Set the width of the Thumbnail list |
| PrintScalePageToPaperSize | Scale page when printing to fit the paper size without keeping the aspect ratio. |
| PrintOrientation | Set or get the page orientation when printing. |
| PdfViewerElement.AllowSignatureDialog | Allows you to disable the SignatureDialog and SingSignatureDialog |
| PdfViewerElement.AllowSignSignatureDialog | Allows you to disable the document signing. |
| RadPdfViewerElement.AsyncRender | Enable or disable the async rendering of pages. |
| RadPdfViewerElement.CachePaint | Enable or disable the cached painting of pages. |
| UseBufferedPrinting [Released in R2 2021] | If true, the page will be printed in an image that will be send to the printer at once. Loss of quality is possible. |
Methods
| Method | Description |
|---|---|
| Select | Creates selection from start position to end position. |
| PageUp | Navigates to the previous page. |
| PageDown | Navigates to the next page. |
| LoadDocument(string path) | Loads a PDF document from a specified file name. |
| LoadDocument(Stream stream) | Loads a PDF document from a specified stream. |
| UnloadDocument | Unload the current PDF document. |
| ShowThubnails | Show the Pdf document's thumbnails |
| HideThumbnails | Hide the Pdf document's thumbnails |
| Directly prints the document to the default printer. | |
| Print(bool showPrinterSettings) | Prints the document with the parameter indicating whether printer settings dialog should be shown. |
| Print(bool showPrinterSettings, RadPrintDocument document) | Prints the document. The first parameter indicating whether printer settings dialog should be shown. The second parameter provides an option for supplying a RadPrintDocument object controlling the printing process . |
| PrintPreview | Shows a RadPrintPreviewDialog for editing the print settings. |
| PrintPreview(RadPrintDocument document) | Shows a RadPrintPreviewDialog for editing the print settings with an option for a RadPrintDocument instance. |
Events
As of R1 2021 RadPdfViewerElement offers the cancelable SignatureDialogShowing and SignSignatureDialogShowing events. They allow customizing or changing the signature dialogs in RadPdfViewer.
| Event | Description |
|---|---|
| DocumentLoaded | Fires when the document has finished loading. |
| DataError | Fires when an internal exception in during loading parts of the document occurs. If the event is not handled, a default error message box will be shown, otherwise the message box will not show and handling the error should be done in the event handler. |
| AnnotationClicked | Fires when a link or a bookmark was clicked. |
| FitToWidthChanged | Fires when the FitToWidth property has changed. |
| FitFullPageChanged | Fires when the FitFullPage property has changed. |
| ScaleFactorChanged | Fires when the ScaleFactor property has changed. |
| CaretPositionChanged | Fires when the caret changes its position. |
| SelectionChanged | Fires when the text selection has changed. |
| PageElementCreating | Fires when a is being created. Allows for replacing it with custom page element. |
| ViewerModeChanged | Fires when the ViewerMode property has changed. |