ClassRadPdfViewerContainer
Represents a container element that manages the layout and interaction between PDF viewer components including thumbnails, bookmarks, AI summary, signature panel, and the main PDF viewing area. The container provides resizable panels and navigation functionality for PDF documents.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.PdfViewer.dll
Syntax:
public class RadPdfViewerContainer : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadPdfViewerContainer
Implements:
Inherited Members
Constructors
RadPdfViewerContainer(RadPdfViewerElement)
Initializes a new instance of the RadPdfViewerContainer class with the specified PDF viewer element as the owner.
Declaration
public RadPdfViewerContainer(RadPdfViewerElement owner)Parameters
owner
The RadPdfViewerElement that this container will manage.
Fields
MinimumThumbWidthProperty
Defines the minimum width for the thumbnail panel when resizing.
Declaration
public static RadProperty MinimumThumbWidthPropertyField Value
Properties
BookmarksTree
Gets the RadTreeView control that displays the document bookmarks in a hierarchical structure.
ChatElement
Gets the instance of the RadChatElement associated with this object.
Declaration
public RadPdfChatElement ChatElement { get; }Property Value
DefaultScaleFactor
Gets or sets the default scale factor used for rendering thumbnail images of PDF pages.
DefaultThumbnailWidth
Gets or sets the default(initial) width of the thumbnail panel, automatically scaled for DPI awareness.
Declaration
public virtual int DefaultThumbnailWidth { get; set; }Property Value
IsAISummaryHidden
Gets a value indicating whether the AI summary chat is currently hidden from view.
IsBookmarksHidden
Gets a value indicating whether the bookmarks panel is currently hidden from view.
IsThumbHidden
Gets a value indicating whether the thumbnail panel is currently hidden from view.
MinimumThumbWidth
Gets or sets the minimum width allowed for the thumbnail panel during resizing operations.
SignatureElement
Gets the signature panel element that manages digital signature display and validation for the PDF document.
Declaration
public PdfSignatureElement SignatureElement { get; }Property Value
ThumbVisible
Gets or sets a value indicating whether the thumbnail panel is visible and accessible to the user.
ThumbnailList
Gets the RadPdfViewerElement that displays the thumbnail list of PDF pages.
Declaration
public RadPdfViewerElement ThumbnailList { get; }Property Value
ThumbnailWidth
Gets or sets the width of the thumbnail panel, automatically scaled for DPI awareness.
Methods
ArrangeOverride(SizeF)
Arranges all child elements within the final layout bounds, positioning thumbnails, AI summary, signature panel, size grip, and PDF viewer.
BeginResize(int)
Initiates the resize operation for the thumbnail panel with the specified offset.
Declaration
public virtual void BeginResize(int offset)Parameters
offset
The offset value used for calculating the new thumbnail panel size.
CreateAISummary()
Creates the AI Summary chat.
Declaration
protected virtual void CreateAISummary()CreateChildElements()
Creates and initializes the child elements including thumbnail list, tree view, AI summary, and sizing elements.
Declaration
protected override void CreateChildElements()Overrides
DisposeManagedResources()
Releases managed resources and unsubscribes from events to prevent memory leaks.
Declaration
protected override void DisposeManagedResources()Overrides
GetAISummary()
Updates the visibility of the AI summary button based on whether AI summary functionality is enabled in the PDF viewer.
Declaration
protected virtual void GetAISummary()Remarks
Override this method to customize how the AI summary button's visibility is managed in derived classes.
GetBookmarks()
Retrieves and populates the bookmarks tree view with the document's bookmark structure.
Declaration
protected virtual void GetBookmarks()GetCurrentBookmark()
Gets the bookmark item that corresponds to the current page being viewed.
Declaration
public BookmarkItem GetCurrentBookmark()Returns
The BookmarkItem for the current page, or null if no bookmark is found.
GetThumbs()
Generates and populates the thumbnail list with pages from the currently loaded PDF document.
Declaration
protected virtual void GetThumbs()HideAISummary()
Hides the AI summary chat.
Declaration
public virtual void HideAISummary()HideBookmarks()
Hides the bookmarks panel by calling the HideThumb() method.
Declaration
public virtual void HideBookmarks()HideThumb()
Hides the thumbnail panel by setting it to its minimum width and marking it as hidden.
Declaration
public virtual void HideThumb()MeasureOverride(SizeF)
Measures the desired size of all child elements within the available space, considering thumbnail width and DPI scaling.
OnBubbleEvent(RadElement, RoutedEventArgs)
Handles mouse events for thumbnail navigation and page selection functionality.
Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)Parameters
sender
The element that raised the event.
args
The event arguments containing mouse event details.
Overrides
OnDoubleClick(EventArgs)
Handles double-click events to toggle the thumbnail panel visibility when clicking on the resize grip.
Declaration
protected override void OnDoubleClick(EventArgs e)Parameters
e
The event arguments containing mouse event details.
Overrides
OnMouseDown(MouseEventArgs)
Handles mouse down events to initiate thumbnail panel resizing when clicking on the size grip element.
Declaration
protected override void OnMouseDown(MouseEventArgs e)Parameters
e
The mouse event arguments.
Overrides
OnMouseLeave(EventArgs)
Declaration
protected override void OnMouseLeave(EventArgs e)Parameters
e
Overrides
OnMouseMove(MouseEventArgs)
Handles mouse move events to perform thumbnail panel resizing and update cursor appearance.
Declaration
protected override void OnMouseMove(MouseEventArgs e)Parameters
e
The mouse event arguments.
Overrides
OnMouseUp(MouseEventArgs)
Handles mouse up events to complete the thumbnail panel resizing operation.
Declaration
protected override void OnMouseUp(MouseEventArgs e)Parameters
e
The mouse event arguments.
Overrides
ShowAISummary()
Shows the AI summary chat without restoring its initial position.
Declaration
public virtual void ShowAISummary()ShowAISummary(bool)
Shows the AI summary chat and optionally restores it to its initial position and size.
Declaration
public virtual void ShowAISummary(bool restoreInitialPos)Parameters
restoreInitialPos
True to restore the AI summary chat to its initial position and size; otherwise, false.
ShowBookmarks()
Shows the bookmarks panel without restoring its initial position.
Declaration
public virtual void ShowBookmarks()ShowBookmarks(bool)
Shows the bookmarks panel and optionally restores it to its initial position and size.
Declaration
public virtual void ShowBookmarks(bool restoreInitialPos)Parameters
restoreInitialPos
True to restore the bookmarks panel to its initial position and size; otherwise, false.
ShowThumb(bool)
Shows the page thumbnails panel and optionally restores it to its initial position and size.
Declaration
public virtual void ShowThumb(bool restoreInitialPos)Parameters
restoreInitialPos
True to restore the page thumbnails panel to its initial position and size; otherwise, false.
SyncBookmark()
Synchronizes the bookmark tree selection with the current page being viewed in the PDF.
Declaration
public virtual void SyncBookmark()