Class RadPdfViewerContainer

Represents a container element that manages the layout and interaction between PDF viewer components including thumbnails, bookmarks, signature panel, and the main PDF viewing area. The container provides resizable panels and navigation functionality for PDF documents.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadPdfViewerContainer
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.PdfViewer.dll

Syntax

public class RadPdfViewerContainer : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

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
RadPdfViewerElement owner

The RadPdfViewerElement that this container will manage.

Fields

MinimumThumbWidthProperty

Defines the minimum width for the thumbnail panel when resizing.

Declaration
public static RadProperty MinimumThumbWidthProperty
Field Value
RadProperty

Properties

BookmarksTree

Gets the RadTreeView control that displays the document bookmarks in a hierarchical structure.

Declaration
public RadTreeView BookmarksTree { get; }
Property Value
RadTreeView

DefaultScaleFactor

Gets or sets the default scale factor used for rendering thumbnail images of PDF pages.

Declaration
public float DefaultScaleFactor { get; set; }
Property Value
System.Single

IsBookmarksHidden

Gets a value indicating whether the bookmarks panel is currently hidden from view.

Declaration
public bool IsBookmarksHidden { get; }
Property Value
System.Boolean

IsThumbHidden

Gets a value indicating whether the thumbnail panel is currently hidden from view.

Declaration
public bool IsThumbHidden { get; }
Property Value
System.Boolean

MinimumThumbWidth

Gets or sets the minimum width allowed for the thumbnail panel during resizing operations.

Declaration
public int MinimumThumbWidth { get; set; }
Property Value
System.Int32

SignatureElement

Gets the signature panel element that manages digital signature display and validation for the PDF document.

Declaration
public PdfSignatureElement SignatureElement { get; }
Property Value
PdfSignatureElement

ThumbnailList

Gets the RadPdfViewerElement that displays the thumbnail list of PDF pages.

Declaration
public RadPdfViewerElement ThumbnailList { get; }
Property Value
RadPdfViewerElement

ThumbnailWidth

Gets or sets the width of the thumbnail panel, automatically scaled for DPI awareness.

Declaration
public virtual int ThumbnailWidth { get; set; }
Property Value
System.Int32

ThumbVisible

Gets or sets a value indicating whether the thumbnail panel is visible and accessible to the user.

Declaration
public virtual bool ThumbVisible { get; set; }
Property Value
System.Boolean

Methods

ArrangeOverride(SizeF)

Arranges all child elements within the final layout bounds, positioning thumbnails, signature panel, size grip, and PDF viewer.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size allocated for the container.
Returns
System.Drawing.SizeF

The actual size used by the container.
Overrides

BeginResize(Int32)

Initiates the resize operation for the thumbnail panel with the specified offset.

Declaration
public virtual void BeginResize(int offset)
Parameters
System.Int32 offset

The offset value used for calculating the new thumbnail panel size.

CreateChildElements()

Creates and initializes the child elements including thumbnail list, tree view, 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

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
BookmarkItem

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

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.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size for layout.
Returns
System.Drawing.SizeF

The desired size for the container.
Overrides

OnBubbleEvent(RadElement, RoutedEventArgs)

Handles mouse events for thumbnail navigation and page selection functionality.

Declaration
protected override void OnBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

The element that raised the event.
RoutedEventArgs 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
System.EventArgs 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
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.
Overrides

OnMouseMove(MouseEventArgs)

Handles mouse move events to perform thumbnail panel resizing and update cursor appearance.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs 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
System.Windows.Forms.MouseEventArgs e

The mouse event arguments.
Overrides

ShowBookmarks()

Shows the bookmarks panel without restoring its initial position.

Declaration
public virtual void ShowBookmarks()

ShowBookmarks(Boolean)

Shows the bookmarks panel and optionally restores it to its initial position and size.

Declaration
public virtual void ShowBookmarks(bool restoreInitialPos)
Parameters
System.Boolean restoreInitialPos

True to restore the bookmarks panel to its initial position and size; otherwise, false.

ShowThumb(Boolean)

Shows the thumbnail panel and optionally restores it to its initial position and size.

Declaration
public virtual void ShowThumb(bool restoreInitialPos)
Parameters
System.Boolean restoreInitialPos

True to restore the thumbnail 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()

Extension Methods