RadPdfViewer
Represents a control that can display and interact with PDF documents within your application. The RadPdfViewer provides comprehensive PDF viewing capabilities including zooming, scrolling, panning, and text search functionality. The control features a virtualized rendering engine to ensure optimal performance with large documents. It can be seamlessly integrated with a RadPdfViewerNavigator control to provide additional navigation features such as page thumbnails, bookmarks, and quick page selection.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.PdfViewer.dll
Syntax:
[TelerikToolboxCategory("PdfViewer")]
[Docking(DockingBehavior.Ask)]
public class RadPdfViewer : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, IPrintableInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadPdfViewer...
Implements:
Inherited Members
Constructors
Creates a RadPdfViewer control.
public RadPdfViewer()Properties
Gets or sets the background color of the annotations when they are pressed.
[Browsable(true)]
public Color AnnotationsColor { get; set; }Gets the RadPdfViewerContainer which represents the elements container of the control.
[Browsable(false)]
public RadPdfViewerContainer ContainerElement { get; }protected override Size DefaultSize { get; }Overrides:
Gets or Sets the currently loaded RadFixedDocument
[Browsable(false)]
public RadFixedDocument Document { get; set; }Enables or disables the AI Summary feature.
[Browsable(true)]
public bool EnableAISummary { get; set; }When set to true the SummaryProvider must be assigned to generate summaries and answer questions.
Gets or sets whether the thumbnail element is visible.
[Browsable(true)]
public bool EnableThumbnails { get; set; }Gets or sets whether a complete page should be fitted within the viewer control. When enabled, the zoom level automatically adjusts to display an entire page.
public bool FitFullPage { get; set; }Gets or sets whether the document should be scaled to fit the width of the viewer control. When enabled, the zoom level automatically adjusts when the control is resized.
public bool FitToWidth { get; set; }Gets or sets the display state of the horizontal scrollbar.
public ScrollState HorizontalScrollState { get; set; }Gets the RadPdfViewerElement which represents the main element of the control.
[Browsable(false)]
public RadPdfViewerElement PdfViewerElement { get; }Set or get the page orientation when printing.
[Browsable(true)]
public PrintOrientation PrintOrientation { get; set; }Scale page when printing to fit the paper size without keeping the aspect ratio.
[Browsable(false)]
public bool PrintScalePageToPaperSize { get; set; }Gets or sets the associated RadContextMenu. By default this is PdfViewerContextMenu.
[Browsable(false)]
public RadContextMenu RadContextMenu { get; set; }Gets or sets whether the entire document is loaded at the beginning or pages are loaded on demand.
[Browsable(true)]
public ReadingMode ReadingMode { get; set; }Gets or sets the rotation angle applied to all pages in the document.
public RotationAngle RotationAngle { get; set; }Gets or sets the factor by which the document is scaled.
[Browsable(true)]
public float ScaleFactor { get; set; }Gets or sets the color that highlights the current selection.
[Browsable(true)]
public Color SelectionColor { get; set; }Get or Set the width of the Thumbnail list
public int ThumbnailListWidth { get; set; }public float ThumbnailsScaleFactor { get; set; }if true, the page will be printed in an image that will be send to the printer at once. Loss of quality is possible.
public bool UseBufferedPrinting { get; set; }Gets or sets the display state of the vertical scrollbar.
public ScrollState VerticalScrollState { get; set; }Gets or sets the current viewer mode - Pan, TextSelection or None.
[Browsable(true)]
public FixedDocumentViewerMode ViewerMode { get; set; }Methods
Creates the child elements of the RadPdfViewer control.
protected override void CreateChildItems(RadElement parent)The parent element to which child elements will be added.
Overrides:
Creates the container element that hosts the PDF viewer element.
protected virtual RadPdfViewerContainer CreateContainerElement(RadPdfViewerElement ownerElement)The PDF viewer element that will be contained.
Returns:A new instance of RadPdfViewerContainer.
Creates the PDF viewer element used for document visualization.
protected virtual RadPdfViewerElement CreateViewerElement()A new instance of RadPdfViewerElement.
Exports a single PDF page to a Bitmap object.
public Bitmap ExportPage(int pageNumber, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Number of the page to export. First page has a number 1. A value of 0 means export the current page.
aspectRatiodoubleScale factor for the exported image. Value of 1.0 represents the original size.
overrideFileIfAlreadyExistboolWhen true, overrides the image file if it already exists.
imageFormatImageFormatThe image format to use when creating the bitmap.
Returns:Returns a Bitmap object representing the PDF page. This bitmap should be disposed manually when no longer needed.
Exports a single PDF page to an image file on the disk.
public bool ExportPage(int pageNumber, string fileName, double scaleSize, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Number of the page to export. First page has a number 1. A value of 0 means export the current page.
fileNamestringFull path to the output image file.
scaleSizedoubleScale factor for the exported image. Value of 1.0 represents the original size.
overrideFileIfAlreadyExistboolWhen true, overrides the image file if it already exists.
imageFormatImageFormatThe image format to use when saving the image.
Returns:Returns true if the export was successful, false if the file already exists and overrideFileIfAlreadyExist is false.
Exports all PDF pages to a collection of Bitmap objects.
public IEnumerable<Bitmap> ExportPages(double scaleSize, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Scale factor for the exported images. Value of 1.0 represents the original size.
overrideFileIfAlreadyExistboolWhen true, overrides existing files if encountered during the operation.
imageFormatImageFormatThe image format to use when creating the bitmaps.
Returns:IEnumerable<Bitmap>
Returns a collection of Bitmap objects, one for each page in the document. These Bitmaps should be disposed manually when no longer needed.
Exports all PDF pages to image files on the disk with sequential numbering.
public bool ExportPages(string fileName, double scaleSize, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Base name for the output image files. Page numbers will be appended automatically.
scaleSizedoubleScale factor for the exported images. Value of 1.0 represents the original size.
overrideFileIfAlreadyExistboolWhen true, overrides the image files if they already exist.
imageFormatImageFormatThe image format to use when saving the images.
Returns:Returns true if all exports were successful, false if any file already existed and overrideFileIfAlreadyExist is false.
Finds the specified text in the current document using specified search options and starting from a specific position. The search begins from the provided position and moves forward through the document.
public SearchResult Find(string text, TextSearchOptions options, TextPosition startPosition)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
startPositionTextPositionThe text position from which to begin searching.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Finds the specified text within a specific range of the current document using specified search options. The search is limited to the text content within the provided range boundaries.
public SearchResult Find(string text, TextSearchOptions options, TextRange range)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
rangeTextRangeThe text range within which to limit the search operation.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Finds the specified text in the current document using specified search options.
public SearchResult Find(string text, TextSearchOptions options)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Finds the specified text in the current document using default search options.
public SearchResult Find(string text)The text to search for in the document.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Finds all occurrences of the specified text in the current document using specified search options and starting from a specific position. Returns all matching results found from the start position to the end of the document.
public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options, TextPosition startPosition)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
startPositionTextPositionThe text position from which to begin searching.
Returns:IEnumerable<SearchResult>
An enumerable collection of SearchResult objects representing all found occurrences of the text from the start position.
Finds all occurrences of the specified text within a specific range of the current document using specified search options. Returns all matching results found within the boundaries of the provided text range.
public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options, TextRange range)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
rangeTextRangeThe text range within which to limit the search operation.
Returns:IEnumerable<SearchResult>
An enumerable collection of SearchResult objects representing all found occurrences of the text within the specified range.
Finds all occurrences of the specified text in the current document using specified search options. Returns all matching results found throughout the entire document based on the provided search criteria.
public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
Returns:IEnumerable<SearchResult>
An enumerable collection of SearchResult objects representing all found occurrences of the text.
Finds all occurrences of the specified text in the current document using default search options. Returns all matching results found throughout the entire document.
public IEnumerable<SearchResult> FindAll(string text)The text to search for in the document.
Returns:IEnumerable<SearchResult>
An enumerable collection of SearchResult objects representing all found occurrences of the text.
Finds the previous occurrence of the specified text in the current document using specified search options and starting from a specific position. The search begins from the provided position and moves backward through the document.
public SearchResult FindPrevious(string text, TextSearchOptions options, TextPosition startPosition)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
startPositionTextPositionThe text position from which to begin searching backward.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Finds the previous occurrence of the specified text within a specific range of the current document using specified search options. The search moves backward through the text content within the provided range boundaries.
public SearchResult FindPrevious(string text, TextSearchOptions options, TextRange range)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
rangeTextRangeThe text range within which to limit the search operation.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Finds the previous occurrence of the specified text in the current document using specified search options. The search begins from the current selection or position and moves backward through the document.
public SearchResult FindPrevious(string text, TextSearchOptions options)The text to search for in the document.
optionsTextSearchOptionsThe search options that control case sensitivity, whole word matching, and other search parameters.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Finds the previous occurrence of the specified text in the current document using default search options. The search begins from the current selection or position and moves backward through the document.
public SearchResult FindPrevious(string text)The text to search for in the document.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found.
Gets the bookmark nearest to the current viewing position in the document.
public BookmarkItem GetCurrentBookmark()The BookmarkItem representing the nearest bookmark to the current position.
Gets the currently loaded PDF document as a stream.
Hides the AI summary chat in the viewer.
public void HideAISummary()Hides the PDF document's bookmarks panel in the viewer.
public void HideBookmarks()Hides the PDF document's signature panel in the viewer.
public void HideSignaturePanel()Hide the Pdf document's thumbnails
public void HideThumbnails()Loads a PDF document from a specified stream.
Loads a PDF document from a specified file name.
Raises the CaptureLosing event. Handles cases when the control loses capture.
protected override void OnCaptureLosing()Overrides:
Raises the KeyDown event. Handles keyboard input in the PDF viewer.
protected override void OnKeyDown(KeyEventArgs e)A KeyEventArgs that contains the event data.
Overrides:
Notifies that the control is about to be visualized.
Raises the MouseDown event. Handles mouse button presses over the PDF viewer.
protected override void OnMouseDown(MouseEventArgs e)A MouseEventArgs that contains the event data.
Overrides:
Raises the MouseMove event. Handles mouse movement over the PDF viewer.
protected override void OnMouseMove(MouseEventArgs e)A MouseEventArgs that contains the event data.
Overrides:
Raises the MouseUp event. Handles mouse button releases over the PDF viewer.
protected override void OnMouseUp(MouseEventArgs e)A MouseEventArgs that contains the event data.
Overrides:
protected override void OnThemeChanged()Overrides:
Navigates to the next page.
public void PageDown()Navigates to the previous page.
public void PageUp()Directly prints the RadPdfViewer to the default printer.
public virtual void Print()Directly prints the RadPdfViewer to the default printer or shows printer settings and then prints the RadPdfViewer.
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)Indicates whether printer settings dialog should be shown.
documentRadPrintDocumentAs instance of RadPrintDocument used to control the print process.
Directly prints the RadPdfViewer to the default printer or shows printer settings and then prints the RadPdfViewer.
public virtual void Print(bool showPrinterSettings)Indicates whether printer settings dialog should be shown.
Shows a RadPrintPreviewDialog for editing the RadPdfViewer print settings.
public virtual void PrintPreview()Shows a RadPrintPreviewDialog for editing the RadPdfViewer print settings.
public virtual void PrintPreview(RadPrintDocument document)As instance of RadPrintDocument used to control the print process.
Processes a command key. Handles Tab and Shift+Tab for navigating between form fields in the PDF document.
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)A Message, passed by reference, that represents the Win32 message to process.
keyDataKeysOne of the Keys values that represents the key to process.
Returns:True if the character was processed by the control; otherwise, false.
Overrides:
Rotates all pages in the document to the specified angle.
public virtual void Rotate(RotationAngle angle)The rotation angle to apply to all pages.
Scales the control and its contents according to the specified scaling factor.
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)The factor by which to scale the control.
specifiedBoundsSpecifiedA bitwise combination of BoundsSpecified values.
Overrides:
Creates selection from start position to end position.
Show the AI summary chat for the PDF document
public void ShowAISummary()Show the Pdf document's bookmarks
public void ShowBookmarks()Shows the PDF document's signature panel, allowing users to view and interact with digital signatures.
public void ShowSignaturePanel()Show the Pdf document's thumbnails
public void ShowThumbnails()Sync the nearest bookmark from the Pdf document's to the tree
public void SyncCurrentBookmark()Unload the current PDF document.
public void UnloadDocument()Events
AnnotationClicked
EventHandler<AnnotationEventArgs>
Fires when a link or a bookmark was clicked.
public event EventHandler<AnnotationEventArgs> AnnotationClickedFires when the caret changes its position.
public event EventHandler CaretPositionChangedFires after the current RadFixedPage has been changed.
public event CurrentPageChangedEventHandler CurrentPageChangedFires 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.
public event PdfExceptionEventHandler DataErrorFires when the document has finished loading.
public event EventHandler DocumentLoadedFires when the FitFullPage property has changed.
public event EventHandler FitFullPageChangedFires when the FitToWidth property has changed.
public event EventHandler FitToWidthChangedHyperlinkClicked
EventHandler<HyperlinkClickedEventArgs>
Occurs when the hyperlink is clicked.
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClickedFires when a RadFixedPageElement is being created. Allows for replacing it with custom page element.
public event RadFixedPageElementEventHandler PageElementCreatingFires when a RadFixedPageElement has been asynchronously rendered.
public event EventHandler PageRenderCompletedFires when a RadFixedPageElement is about to be asynchronously rendered.
public event EventHandler PageRenderStartedFires when SignaturePanel hides or shows
public event EventHandler PdfSignaturePanelVisibilityChangedFires when the ScaleFactor property has changed.
public event EventHandler ScaleFactorChangedFires when the text selection has changed.
public event EventHandler SelectionChangedFires when the ViewerMode property has changed.
public event EventHandler ViewerModeChanged