RadPdfViewerElement
Represents the main element of the RadPdfViewer control.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.PdfViewer.dll
Syntax:
public class RadPdfViewerElement : VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IFixedDocumentPresenter, IPrintableInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementScrollViewElement<VirtualizedStackContainer<RadFixedPage>>VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>RadPdfViewerElement...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadPdfViewerElement class. Sets up initial component configurations, input handlers, and UI elements.
public RadPdfViewerElement()Properties
Gets or sets the model for AI-powered summaries and chat messages.
public AISummaryModel AISummaryModel { get; set; }Gets or sets whether the signature verification dialog should be displayed when encountering digital signatures. When disabled, signature verification information will not be shown to the user.
[Browsable(false)]
public bool AllowSignatureDialog { get; set; }Gets or sets whether the dialog for adding new digital signatures should be displayed. When disabled, users will not be able to sign documents through the standard dialog.
[Browsable(false)]
public bool AllowSignSignatureDialog { get; set; }Annotations
Dictionary<RadFixedPage, RadElement>
public Dictionary<RadFixedPage, RadElement> Annotations { get; set; }Gets or sets the background color of the annotations when they are pressed or highlighted. This color is used to visually indicate interactive annotation elements in the document.
public Color AnnotationsColor { get; set; }Gets or sets whether pages are rendered asynchronously. When enabled, pages are rendered on background threads to prevent UI freezing during complex page rendering.
[Browsable(false)]
public bool AsyncRender { get; set; }True if asynchronous rendering is enabled; otherwise, false.
Gets or sets the maximum number of pages that can be cached in memory. Higher values increase memory usage but improve performance when navigating between pages.
[Browsable(false)]
public int CacheCapacity { get; set; }The maximum number of pages that can be stored in the cache.
Gets or sets whether page caching is enabled for painting operations. When enabled, rendered pages are stored in memory to improve performance during scrolling and navigation.
[Browsable(false)]
public bool CachePaint { get; set; }True if page caching is enabled; otherwise, false.
Gets whether horizontal scrolling is possible in the current state. Returns true if the document width exceeds the visible width of the control.
public bool CanScrollHorizontally { get; }True if horizontal scrolling is possible; otherwise, false.
Implements:
Gets whether vertical scrolling is possible in the current state. Returns true if the document height exceeds the visible height of the control and discrete mode is not active.
public bool CanScrollVertically { get; }True if vertical scrolling is possible; otherwise, false.
Implements:
Gets or sets the context menu that appears when right-clicking within the PDF viewer. By default, this is an instance of PdfViewerContextMenu with standard PDF viewing options.
public RadContextMenu ContextMenu { get; set; }Gets the currently visible page in the viewer. Triggers the CurrentPageChanged event when the visible page changes.
public RadFixedPage CurrentPage { get; }The current RadFixedPage being displayed, or null if no page is visible.
Implements:
Gets or sets the currently loaded PDF document. Setting this property automatically unloads any previous document and loads the new one.
public RadFixedDocument Document { get; set; }Implements:
Gets or sets a value indicating whether AI-generated summaries are enabled. When set to true the SummaryProvider must be assigned to generate summaries and answer questions.
public bool EnableAISummary { get; set; }Gets or sets whether the document should be scaled to fit the entire page within the viewer. When enabled, the viewer will show complete pages and use discrete scrolling between pages.
public bool FitFullPage { get; set; }Gets or sets whether the document should be scaled to fit the width of the viewer. When enabled, the document will be automatically resized horizontally to fill the available width.
public bool FitToWidth { get; set; }Gets or sets the display state of the horizontal scrollbar. Controls whether the horizontal scrollbar is always visible, hidden, or only appears when needed.
public ScrollState HorizontalScrollState { get; set; }Gets or sets the settings used when importing PDF documents. Controls aspects like reading mode, password handling, and stream management.
public PdfImportSettings ImportSettings { get; set; }The current import settings, creating default settings if none have been set.
Gets or sets the current viewer mode that determines how mouse input is interpreted. Supported modes include Pan (for navigation), TextSelection (for selecting text), and None.
public FixedDocumentViewerMode Mode { get; set; }The current FixedDocumentViewerMode value.
Implements:
Gets the MouseHandlersController which manages all mouse input handling for the PDF viewer. Controls behaviors like text selection, panning, and annotation interaction.
public MouseHandlersController MouseController { get; }Gets the MouseHandlersController which handles and manages all mouse input for the PDF viewer. The controller processes mouse events and delegates them to appropriate handlers based on the current viewer mode.
public MouseHandlersController MouseHandlersController { get; }The MouseHandlersController instance that manages mouse interactions.
Implements:
Gets or sets the behavior used for PDF navigation operations. Defines how the viewer responds to navigation requests like GoToPage, GoToDestination, etc.
[Browsable(false)]
public IPdfNavigationBehavior PdfNavigationBehavior { get; set; }The current navigation behavior implementation.
Gets or sets the page orientation used when printing the document. Can be set to Portrait, Landscape, or Auto (determines orientation based on page content).
[Browsable(false)]
public PrintOrientation PrintOrientation { get; set; }Gets or sets whether pages are scaled during printing to fit the paper size without preserving aspect ratio. When enabled, pages will be stretched or compressed to fill the entire printable area.
[Browsable(false)]
public bool PrintScalePageToPaperSize { get; set; }Gets or sets whether the entire document is loaded immediately or pages are loaded as they're needed. This affects memory usage and initial loading performance of large documents.
public ReadingMode ReadingMode { get; set; }Gets or sets the rotation angle for all pages in the document. Changes to this property will cause the document pages to be redrawn with the new orientation.
public RotationAngle RotateAngle { get; set; }The current rotation angle applied to the document.
Gets or sets the zoom factor by which the document is scaled. Values range from 0.01 (1%) to 62.0 (6200%), with 1.0 representing the original document size.
public float ScaleFactor { get; set; }Gets or sets the color used to highlight text selections within the PDF document. This color is applied as a semi-transparent overlay on selected text content.
public Color SelectionColor { get; set; }Gets or sets the properties used for validating digital signatures in the PDF document. Controls how signature validation is performed and displayed.
public SignatureValidationProperties SignatureValidationProperties { get; set; }The current signature validation properties.
Gets or sets the summary provider used for generating summaries and answering questions.
public ISummaryProvider SummaryProvider { get; set; }Gets or sets whether buffered printing is used. When true, the page is rendered to an image before being sent to the printer, which may result in quality loss but can improve compatibility.
public bool UseBufferedPrinting { get; set; }True if buffered printing is enabled; otherwise, false.
Gets or sets the display state of the vertical scrollbar. Controls whether the vertical scrollbar is always visible, hidden, or only appears when needed.
public ScrollState VerticalScrollState { get; set; }Methods
Scrolls the viewer horizontally and vertically to ensure that the specified text position is visible. This is useful when programmatically navigating to specific text content within the document.
public void BringIntoView(TextPosition textPosition)The text position that should be made visible in the viewport.
Copies the currently selected text in the document to the system clipboard. If no text is selected or no document is loaded, this operation does nothing.
public void Copy()Creates and initializes all child elements of the PDF viewer including the waiting bar, and sets up default visual appearance.
protected override void CreateChildElements()Overrides:
Creates the element provider responsible for virtualizing PDF page elements.
protected override IVirtualizedElementProvider<RadFixedPage> CreateElementProvider()IVirtualizedElementProvider<RadFixedPage>
A FixedPageElementProvider that manages the creation and recycling of page elements.
Overrides:
Creates and initializes the item scroller used to scroll through PDF pages.
protected override ItemScroller<RadFixedPage> CreateItemScroller()ItemScroller<RadFixedPage>
A specialized PdfItemScroller instance to handle PDF page scrolling.
Overrides:
Creates a RadFixedPageElement for displaying a RadFixedPage in the viewer. Fires the PageElementCreating event to allow customization of the created element.
public virtual IVirtualizedElement<RadFixedPage> CreatePageElement(RadFixedPage data, object context)The RadFixedPage to create an element for.
contextobjectAdditional context information for element creation.
Returns:IVirtualizedElement<RadFixedPage>
A new IVirtualizedElement instance representing the page.
Creates the main view element container used to display PDF pages.
protected override VirtualizedStackContainer<RadFixedPage> CreateViewElement()VirtualizedStackContainer<RadFixedPage>
A specialized PdfViewerStackContainer to manage PDF page layout.
Overrides:
Clears the current selection.
public void DeselectAll()Releases all managed resources used by the element. Unloads the document and disposes of the page renderer and mouse controller.
protected override void DisposeManagedResources()Overrides:
Exports a single PDF page as a Bitmap image in memory.
public Bitmap ExportPage(int pageNumber, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Number of the page to export (1-based index, first page is 1). A value of 0 exports the current visible page.
aspectRatiodoubleScale factor for the export. Value of 1.0 represents original size.
overrideFileIfAlreadyExistboolUnused parameter in this overload.
imageFormatImageFormatUnused parameter in this overload.
Returns:A Bitmap containing the rendered PDF page. This bitmap must be manually disposed by the caller.
Exports a single PDF page as an image file on disk.
public bool ExportPage(int pageNumber, string fileName, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Number of the page to export (1-based index, first page is 1). A value of 0 exports the current visible page.
fileNamestringFull path where the output image file should be saved.
aspectRatiodoubleScale factor for the export. Value of 1.0 represents original size.
overrideFileIfAlreadyExistboolWhen true, overwrites any existing file with the same name.
imageFormatImageFormatThe image format to use when saving the file (PNG, JPEG, BMP, etc).
Returns:True if the page was successfully exported; false if the file exists and overrideFileIfAlreadyExist is false.
Exports all PDF pages as a collection of Bitmap images in memory.
public IEnumerable<Bitmap> ExportPages(double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Scale factor for the export. Value of 1.0 represents original size.
overrideFileIfAlreadyExistboolUnused parameter in this overload.
imageFormatImageFormatUnused parameter in this overload.
Returns:IEnumerable<Bitmap>
A collection of Bitmap objects, one for each page in the document. These Bitmaps must be manually disposed by the caller.
Exports all PDF pages as separate image files on disk. Page numbers will be appended to the filename (e.g., file-1.png, file-2.png).
public bool ExportPages(string fileName, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)Base path and filename pattern for the output image files.
aspectRatiodoubleScale factor for the export. Value of 1.0 represents original size.
overrideFileIfAlreadyExistboolWhen true, overwrites any existing files with the same names.
imageFormatImageFormatThe image format to use when saving the files (PNG, JPEG, BMP, etc).
Returns:True if all pages were successfully exported; false if any file exists and overrideFileIfAlreadyExist is false.
Finds the specified text in a specific page of the current document. This search is limited to the specified page only and will not search across multiple pages.
public SearchResult Find(string text, int pageNumber)The text to search for in the document.
pageNumberintThe page number (1-based) to search within.
Returns:A SearchResult object containing information about the found text position or SearchResult.NotFound if the text was not found on the specified page.
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.
Adjusts the scale factor to fit the entire current page in the viewer. Calculates the optimal scale that allows the page to be fully visible within the available space.
public void FitFullPageCore()Adjusts the scale factor to fit the current page width to the viewer width. Takes into account the orientation of the page and available space in the control.
public void FitPageToWidthCore()Gets the currently loaded PDF document as a stream.
public Stream GetDocumentAsStream()A stream containing the PDF document data, or null if no document is loaded.
Gets the page element which contains the text caret when text selection is active.
public RadFixedPageElement GetFocusedPage()The RadFixedPageElement containing the caret, or null if text operations are not supported or no caret exists.
Converts a point in view coordinates to a location on a PDF page. Takes into account scrolling position and rotation angle of the document.
public bool GetLocationFromViewPoint(Point viewPoint, out RadFixedPage page, out Point location)The point in viewer coordinates.
pageRadFixedPageWhen this method returns, contains the page that the point is on, or null if the point is not on any page.
locationPointWhen this method returns, contains the point in page coordinates, or Point.Empty if the point is not on any page.
Returns:True if the point is on a page; otherwise, false.
Implements:
Gets the visual page element which corresponds to a specific logical page from the document.
public RadFixedPageElement GetPageElement(RadFixedPage page)The logical page from the document model.
Returns:The visual RadFixedPageElement corresponding to the given logical page, or null if the page isn't currently visible.
Gets the vertical offset in pixels of a specific page from the top edge of the first page in the document. This value is useful for programmatically scrolling to specific pages.
public int GetPageVerticalOffset(RadFixedPage page)The page whose offset should be calculated.
Returns:The vertical offset in pixels from the top of the document to the specified page.
Gets the current scroll offset.
Gets the currently selected text content from the document. Returns an empty string if no document is loaded or if no text is selected.
public string GetSelectedText()A string containing the selected text, or an empty string if no selection exists.
Gets the currently selected text content from the document asynchronously. This is useful for large selections where retrieving the text may be time-consuming.
Gets the screen coordinates in the viewer corresponding to a specific text position in the document. Useful for positioning UI elements like tooltips or annotations at specific text locations.
public Point GetViewPointFromTextPosition(TextPosition position)The text position in the document model.
Returns:A Point representing the screen coordinates in the viewer, or Point.Empty if the position is invalid.
Navigates to a specified destination.
public void GoToDestination(Destination dest)The destination.
Implements:
Navigates to the page with the specified number.
Hides the text caret indicator on the current page. Has no effect if there is no focused page or if the caret is already hidden.
public void HideCaret()Implements:
Hides the signature panel if it's currently visible.
public void HideSignaturePanel()Forces a specific page to be redrawn in the viewer. Use this when the page content has changed and needs to be visually updated.
public void InvalidatePage(RadFixedPage page)The page that needs to be redrawn.
Forces all pages in the document to be redrawn in the viewer. Use this when multiple pages have changed or when global document settings have been modified.
public void InvalidatePages()Checks if the loading indicator is currently visible, indicating an operation is in progress.
public bool IsWaiting()True if the loading indicator is displayed and waiting; false otherwise.
Loads an already created RadFixedDocument into the PDF viewer. Updates the view and initializes all necessary handlers for the document.
public void LoadDocument(RadFixedDocument document)The RadFixedDocument to display in the viewer.
Loads a PDF document from a provided stream containing PDF data. Unloads any currently loaded document and displays a waiting indicator while loading.
public void LoadDocument(Stream stream)The stream containing the PDF document data to load.
Loads a PDF document from a specified file path. Unloads any currently loaded document and displays a waiting indicator while loading.
public void LoadDocument(string path)The full path to the PDF file to load.
Moves focus to the next interactive element (such as form field) in the document.
public virtual void MoveToNextEditor()Moves focus to the previous interactive element (such as form field) in the document.
public virtual void MoveToPreviousEditor()Fires the AnnotationClicked event.
protected virtual void OnAnnotationClicked(AnnotationEventArgs e)Responds to changes in the element's bounds by adjusting the document view. Updates the page fitting when the control is resized to maintain proper page display.
protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)The event arguments containing the old and new property values.
Overrides:
Fires the CaretPositionChanged event.
protected virtual void OnCaretPositionChanged()protected virtual void OnCurrenPageChanged(CurrentPageChangedEventArgs args)protected virtual bool OnDataError(object sender, PdfExceptionEventArgs e)Fires the DocumentLoaded event.
protected virtual void OnDocumentLoaded()Fires the DocumentLoaded event.
protected virtual void OnDocumentUnloaded()Fires the FitFullPageChanged event.
Fires the FitToWidthChanged event.
Fires the PageElementCreating event.
protected virtual void OnPageElementCreating(RadFixedPageElementEventArgs args)Handles pan gesture events for navigation within the PDF document. Processes touch-based panning gestures to allow scrolling through the document.
protected override void OnPanGesture(PanGestureEventArgs args)The event arguments containing information about the pan gesture.
Overrides:
Fires the ScaleFactorChanged event.
protected virtual void OnScaleFactorChanged()Fires the SelectionChanged event.
protected virtual void OnSelectionChanged()Fires the ViewerModeChanged event.
protected virtual void OnViewerModeChanged()Handles zoom gesture events for adjusting the document scale. Processes touch-based pinch and stretch gestures to zoom in and out of the document.
protected override void OnZoomGesture(ZoomGestureEventArgs args)The event arguments containing information about the zoom gesture.
Overrides:
Navigates to the next page.
public void PageDown()Implements:
Navigates to the previous page.
public void PageUp()Implements:
Overrides the default painting behavior to handle page rendering and pre-rendering. Stops pre-rendering during painting and restarts it afterward for multi-page documents.
protected override void PaintChildren(IGraphics graphics, Rectangle clipRectange, float angle, SizeF scale, bool useRelativeTransformation)The graphics context to paint on.
clipRectangeRectangleThe clipping rectangle defining the area to paint.
anglefloatThe rotation angle to apply.
scaleSizeFThe scaling factor to apply.
useRelativeTransformationboolWhether to use relative transformations.
Overrides:
Directly prints the RadPdfViewer content to the default printer without showing settings dialog. This is a convenience method that calls Print(false).
public virtual void Print()Prints the RadPdfViewer content using a specified print document, optionally showing the printer settings dialog.
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)True to display the printer settings dialog before printing; false to print directly with current settings.
documentRadPrintDocumentThe RadPrintDocument instance used to control the print process and settings.
Prints the RadPdfViewer content to the default printer, optionally showing the printer settings dialog.
public virtual void Print(bool showPrinterSettings)True to display the printer settings dialog before printing; false to print directly with default settings.
Shows a print preview dialog for the RadPdfViewer content with default margins set to zero. Creates a new RadPrintDocument with appropriate orientation settings.
public virtual void PrintPreview()Shows a print preview dialog for the RadPdfViewer content using a specified print document.
public virtual void PrintPreview(RadPrintDocument document)The RadPrintDocument instance used to control the print process and settings.
Processes the CaptureLost event that occurs when the element loses mouse capture. This ensures that any ongoing mouse operations are properly terminated.
public virtual bool ProcessCaptureLost()True if the event should not be processed further; false to allow normal event propagation.
Processes key down events to handle keyboard navigation and interaction with the PDF document. Handles arrow keys for navigation, Home/End for document positioning, and Page Up/Down for page navigation.
public virtual bool ProcessKeyDown(KeyEventArgs e)The key event arguments containing the pressed key information.
Returns:True if the event should not be processed further; false to allow normal event propagation.
Processes mouse down events to handle interactions with the PDF document. Handles right-clicks for context menu, middle-clicks for panning, and left-clicks for selection and navigation.
public virtual bool ProcessMouseDown(MouseEventArgs e, bool shift, bool control)The mouse event arguments containing position and button information.
shiftboolTrue if the Shift key was pressed during the mouse event; otherwise, false.
controlboolTrue if the Control key was pressed during the mouse event; otherwise, false.
Returns:True if the event should not be processed further; false to allow normal event propagation.
Processes mouse move events to handle interactions with the PDF document. Updates the cursor appearance and tracks mouse movements for selection and other operations.
public virtual bool ProcessMouseMove(MouseEventArgs e, bool shift, bool control)The mouse event arguments containing position and button information.
shiftboolTrue if the Shift key was pressed during the mouse event; otherwise, false.
controlboolTrue if the Control key was pressed during the mouse event; otherwise, false.
Returns:True if the event should not be processed further; false to allow normal event propagation.
Processes mouse up events to complete interactions with the PDF document. Handles the completion of middle-button panning and left-button selections or clicks.
public virtual bool ProcessMouseUp(MouseEventArgs e, bool shift, bool control)The mouse event arguments containing position and button information.
shiftboolTrue if the Shift key was pressed during the mouse event; otherwise, false.
controlboolTrue if the Control key was pressed during the mouse event; otherwise, false.
Returns:True if the event should not be processed further; false to allow normal event propagation.
Processes mouse wheel events to handle zooming and scrolling in the PDF document. When Control key is pressed, zooms in or out; otherwise, scrolls the document vertically.
public virtual bool ProcessMouseWheel(MouseEventArgs e, bool shift, bool control)The mouse event arguments containing the wheel delta information.
shiftboolTrue if the Shift key was pressed during the mouse event; otherwise, false.
controlboolTrue if the Control key was pressed during the mouse event; otherwise, false.
Returns:True if the event should not be processed further; false to allow normal event propagation.
Rotates all pages in the document to the specified angle. Clears the page cache and rebuilds the view to reflect the new rotation.
public void Rotate(RotationAngle angle)The angle to rotate the pages to.
Saves the current PDF document to a stream, including any changes made through form field editing or annotations.
Saves the current PDF document to a file, including any changes made through form field editing or annotations.
Creates a text selection in the document based on a search result. Also scrolls the view to ensure the start position of the search result is visible.
public void Select(SearchResult result)The search result containing the text range to select.
Creates a text selection in the document from the specified start position to end position. Also scrolls the view to ensure the start position is visible.
public void Select(TextPosition startPosition, TextPosition endPosition)The starting text position of the selection.
endPositionTextPositionThe ending text position of the selection.
Selects all text content in the document. This will select all readable text across all pages in the document.
public void SelectAll()Shows the text caret indicator on the current page. Only works when text operations are supported in the current document.
public void ShowCaret()Implements:
Shows the currently assigned context menu at the specified position within the viewer.
public void ShowMenu(Point location)The point coordinates where the context menu should be displayed.
Shows a dialog prompting the user for a password when opening a password-protected PDF. Can be canceled through the PasswordRequireDialogShowing event.
protected virtual string ShowPasswordRequireDialog()The password entered by the user, or an empty string if canceled or no password was entered.
Shows a dialog displaying information about a signature field and its validation status. Can be canceled through the SignatureDialogShowing event.
protected bool ShowSignatureDialog(SignatureField signatureField)The signature field to display information about.
Returns:True if the dialog was shown or canceled; false if there were no signatures to validate.
Shows the signature panel if the document contains digital signatures. The panel displays information about the signatures and their validation status.
public void ShowSignaturePanel()Shows a dialog allowing the user to sign a signature field in the document. Can be canceled through the SignSignatureDialogShowing event.
protected virtual void ShowSignSignatureDialog(SignatureField signatureField)The signature field to be signed.
Displays the loading indicator to show that an operation is in progress. Use this method before starting time-consuming operations to provide visual feedback to the user.
public void StartWaiting()Hides the loading indicator to show that an operation has completed. Call this method after a time-consuming operation completes to remove the visual feedback.
public void StopWaiting()Unloads the current document and releases all associated resources. Clears document content, disposes all page elements, and resets the viewer state.
public void UnloadDocument()Called when a document is being unloaded to remove event handlers associated with the document. Disconnects from selection, caret position, annotation, and exception events to prevent memory leaks.
protected virtual void UnwireDocumentEvents()Unwires all event handlers to prevent memory leaks. Removes event handlers related to PDF document importing.
protected override void UnwireEvents()Overrides:
Updates the element during the measure phase of the layout cycle. Adjusts horizontal scrollbar properties based on content size and scroll state.
Updates the layout.
public void UpdatePresenterLayout()Implements:
Called when a document is being loaded to attach event handlers to the document. Connects to selection, caret position, annotation, and exception events to enable proper document interaction.
protected virtual void WireDocumentEvents()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.
[Browsable(true)]
public event PdfExceptionEventHandler DataErrorFires when the document finishes loading.
public event EventHandler DocumentLoadedFires when the document is unloaded.
public event EventHandler DocumentUnloadedFires 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 PageRenderStartedpublic event EventHandler<PasswordRequireDialogShowingEventArgs> PasswordRequireDialogShowingOccurs when the visibility of the PDF signature panel changes.
public event EventHandler PdfSignaturePanelVisibilityChangedFires when the ScaleFactor property has changed.
public event EventHandler ScaleFactorChangedFires when the text selection has changed.
public event EventHandler SelectionChangedpublic event EventHandler<SignatureDialogShowingEventArgs> SignatureDialogShowingpublic event EventHandler<SignSignatureDialogShowingEventArgs> SignSignatureDialogShowingFires when the ViewerMode property has changed.
public event EventHandler ViewerModeChanged