Class

RadPdfViewerElement

Initializes a new instance of the RadPdfViewerElement class. Sets up initial component configurations, input handlers, and UI elements.

Declaration

public RadPdfViewerElement()

Gets or sets the model for AI-powered summaries and chat messages.

Declaration

public AISummaryModel AISummaryModel { get; set; }

Property Value

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.

Declaration

[Browsable(false)]
public bool AllowSignSignatureDialog { get; set; }

Property Value

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.

Declaration

[Browsable(false)]
public bool AllowSignatureDialog { get; set; }

Property Value

Declaration

public Dictionary<RadFixedPage, RadElement> Annotations { get; set; }

Property Value

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.

Declaration

public Color AnnotationsColor { get; set; }

Property Value

Gets or sets whether pages are rendered asynchronously. When enabled, pages are rendered on background threads to prevent UI freezing during complex page rendering.

Declaration

[Browsable(false)]
public bool AsyncRender { get; set; }

Property Value

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.

Declaration

[Browsable(false)]
public int CacheCapacity { get; set; }

Property Value

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.

Declaration

[Browsable(false)]
public bool CachePaint { get; set; }

Property Value

Gets whether horizontal scrolling is possible in the current state. Returns true if the document width exceeds the visible width of the control.

Declaration

public bool CanScrollHorizontally { get; }

Property Value

Implements IFixedDocumentPresenter.CanScrollHorizontally

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.

Declaration

public bool CanScrollVertically { get; }

Property Value

Implements IFixedDocumentPresenter.CanScrollVertically

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.

Declaration

public RadContextMenu ContextMenu { get; set; }

Property Value

Gets the currently visible page in the viewer. Triggers the CurrentPageChanged event when the visible page changes.

Declaration

public RadFixedPage CurrentPage { get; }

Property Value

Implements IFixedDocumentPresenter.CurrentPage

Gets or sets the currently loaded PDF document. Setting this property automatically unloads any previous document and loads the new one.

Declaration

public RadFixedDocument Document { get; set; }

Property Value

Implements IFixedDocumentPresenter.Document

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.

Declaration

public bool EnableAISummary { get; set; }

Property Value

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.

Declaration

public bool FitFullPage { get; set; }

Property Value

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.

Declaration

public bool FitToWidth { get; set; }

Property Value

Gets or sets the display state of the horizontal scrollbar. Controls whether the horizontal scrollbar is always visible, hidden, or only appears when needed.

Declaration

public ScrollState HorizontalScrollState { get; set; }

Property Value

Gets or sets the settings used when importing PDF documents. Controls aspects like reading mode, password handling, and stream management.

Declaration

public PdfImportSettings ImportSettings { get; set; }

Property Value

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.

Declaration

public FixedDocumentViewerMode Mode { get; set; }

Property Value

Implements IFixedDocumentPresenter.Mode

Gets the MouseHandlersController which manages all mouse input handling for the PDF viewer. Controls behaviors like text selection, panning, and annotation interaction.

Declaration

public MouseHandlersController MouseController { get; }

Property Value

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.

Declaration

public MouseHandlersController MouseHandlersController { get; }

Property Value

Implements IFixedDocumentPresenter.MouseHandlersController

Gets or sets the behavior used for PDF navigation operations. Defines how the viewer responds to navigation requests like GoToPage, GoToDestination, etc.

Declaration

[Browsable(false)]
public IPdfNavigationBehavior PdfNavigationBehavior { get; set; }

Property Value

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).

Declaration

[Browsable(false)]
public PrintOrientation PrintOrientation { get; set; }

Property Value

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.

Declaration

[Browsable(false)]
public bool PrintScalePageToPaperSize { get; set; }

Property Value

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.

Declaration

public ReadingMode ReadingMode { get; set; }

Property Value

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.

Declaration

public RotationAngle RotateAngle { get; set; }

Property Value

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.

Declaration

public float ScaleFactor { get; set; }

Property Value

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.

Declaration

public Color SelectionColor { get; set; }

Property Value

Gets or sets the properties used for validating digital signatures in the PDF document. Controls how signature validation is performed and displayed.

Declaration

public SignatureValidationProperties SignatureValidationProperties { get; set; }

Property Value

Gets or sets the summary provider used for generating summaries and answering questions.

Declaration

public ISummaryProvider SummaryProvider { get; set; }

Property Value

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.

Declaration

public bool UseBufferedPrinting { get; set; }

Property Value

Gets or sets the display state of the vertical scrollbar. Controls whether the vertical scrollbar is always visible, hidden, or only appears when needed.

Declaration

public ScrollState VerticalScrollState { get; set; }

Property Value

Overrides the default arrangement behavior to position the waiting bar within the element.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides ScrollViewElement<VirtualizedStackContainer<RadFixedPage>>.ArrangeOverride(SizeF)

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.

Declaration

public void BringIntoView(TextPosition textPosition)

Parameters

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.

Declaration

public void Copy()

Creates and initializes all child elements of the PDF viewer including the waiting bar, and sets up default visual appearance.

Declaration

protected override void CreateChildElements()

Overrides VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>.CreateChildElements()

Creates the element provider responsible for virtualizing PDF page elements.

Declaration

protected override IVirtualizedElementProvider<RadFixedPage> CreateElementProvider()

Returns

Overrides VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>.CreateElementProvider()

Creates and initializes the item scroller used to scroll through PDF pages.

Declaration

protected override ItemScroller<RadFixedPage> CreateItemScroller()

Returns

Overrides VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>.CreateItemScroller()

Creates a RadFixedPageElement for displaying a RadFixedPage in the viewer. Fires the PageElementCreating event to allow customization of the created element.

Declaration

public virtual IVirtualizedElement<RadFixedPage> CreatePageElement(RadFixedPage data, object context)

Parameters

Returns

Creates the main view element container used to display PDF pages.

Declaration

protected override VirtualizedStackContainer<RadFixedPage> CreateViewElement()

Returns

Overrides ScrollViewElement<VirtualizedStackContainer<RadFixedPage>>.CreateViewElement()

Clears the current selection.

Declaration

public void DeselectAll()

Releases all managed resources used by the element. Unloads the document and disposes of the page renderer and mouse controller.

Declaration

protected override void DisposeManagedResources()

Overrides VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>.DisposeManagedResources()

Exports a single PDF page as a Bitmap image in memory.

Declaration

public Bitmap ExportPage(int pageNumber, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)

Parameters

Returns

Exports a single PDF page as an image file on disk.

Declaration

public bool ExportPage(int pageNumber, string fileName, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)

Parameters

Returns

Exports all PDF pages as a collection of Bitmap images in memory.

Declaration

public IEnumerable<Bitmap> ExportPages(double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)

Parameters

Returns

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).

Declaration

public bool ExportPages(string fileName, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)

Parameters

Returns

Finds the specified text in the current document using default search options.

Declaration

public SearchResult Find(string text)

Parameters

Returns

Finds the specified text in the current document using specified search options.

Declaration

public SearchResult Find(string text, TextSearchOptions options)

Parameters

Returns

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.

Declaration

public SearchResult Find(string text, TextSearchOptions options, TextPosition startPosition)

Parameters

Returns

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.

Declaration

public SearchResult Find(string text, TextSearchOptions options, TextRange range)

Parameters

Returns

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.

Declaration

public SearchResult Find(string text, int pageNumber)

Parameters

Returns

Finds all occurrences of the specified text in the current document using default search options. Returns all matching results found throughout the entire document.

Declaration

public IEnumerable<SearchResult> FindAll(string text)

Parameters

Returns

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.

Declaration

public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options)

Parameters

Returns

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.

Declaration

public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options, TextPosition startPosition)

Parameters

Returns

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.

Declaration

public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options, TextRange range)

Parameters

Returns

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.

Declaration

public SearchResult FindPrevious(string text)

Parameters

Returns

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.

Declaration

public SearchResult FindPrevious(string text, TextSearchOptions options)

Parameters

Returns

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.

Declaration

public SearchResult FindPrevious(string text, TextSearchOptions options, TextPosition startPosition)

Parameters

Returns

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.

Declaration

public SearchResult FindPrevious(string text, TextSearchOptions options, TextRange range)

Parameters

Returns

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.

Declaration

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.

Declaration

public void FitPageToWidthCore()

Gets the currently loaded PDF document as a stream.

Declaration

public Stream GetDocumentAsStream()

Returns

Gets the page element which contains the text caret when text selection is active.

Declaration

public RadFixedPageElement GetFocusedPage()

Returns

Converts a point in view coordinates to a location on a PDF page. Takes into account scrolling position and rotation angle of the document.

Declaration

public bool GetLocationFromViewPoint(Point viewPoint, out RadFixedPage page, out Point location)

Parameters

Returns

Implements IFixedDocumentPresenter.GetLocationFromViewPoint(Point, out RadFixedPage, out Point)

Gets the visual page element which corresponds to a specific logical page from the document.

Declaration

public RadFixedPageElement GetPageElement(RadFixedPage page)

Parameters

Returns

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.

Declaration

public int GetPageVerticalOffset(RadFixedPage page)

Parameters

Returns

Gets the current scroll offset.

Declaration

public Point GetScrollOffset()

Returns

Implements IFixedDocumentPresenter.GetScrollOffset()

Gets the currently selected text content from the document. Returns an empty string if no document is loaded or if no text is selected.

Declaration

public string GetSelectedText()

Returns

Gets the currently selected text content from the document asynchronously. This is useful for large selections where retrieving the text may be time-consuming.

Declaration

public Task<string> GetSelectedTextAsync()

Returns

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.

Declaration

public Point GetViewPointFromTextPosition(TextPosition position)

Parameters

Returns

Navigates to a specified destination.

Declaration

public void GoToDestination(Destination dest)

Parameters

Implements IFixedDocumentPresenter.GoToDestination(Destination)

Navigates to the page with the specified number.

Declaration

public void GoToPage(int pageNo)

Parameters

Implements IFixedDocumentPresenter.GoToPage(int)

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.

Declaration

public void HideCaret()

Implements IFixedDocumentPresenter.HideCaret()

Hides the signature panel if it's currently visible.

Declaration

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.

Declaration

public void InvalidatePage(RadFixedPage page)

Parameters

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.

Declaration

public void InvalidatePages()

Checks if the loading indicator is currently visible, indicating an operation is in progress.

Declaration

public bool IsWaiting()

Returns

Loads an already created RadFixedDocument into the PDF viewer. Updates the view and initializes all necessary handlers for the document.

Declaration

public void LoadDocument(RadFixedDocument document)

Parameters

Loads a PDF document from a provided stream containing PDF data. Unloads any currently loaded document and displays a waiting indicator while loading.

Declaration

public void LoadDocument(Stream stream)

Parameters

Loads a PDF document from a specified file path. Unloads any currently loaded document and displays a waiting indicator while loading.

Declaration

public void LoadDocument(string path)

Parameters

Overrides the default measuring behavior to include the waiting bar in measurement calculations.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>.MeasureOverride(SizeF)

Moves focus to the next interactive element (such as form field) in the document.

Declaration

public virtual void MoveToNextEditor()

Moves focus to the previous interactive element (such as form field) in the document.

Declaration

public virtual void MoveToPreviousEditor()