ClassRadPdfViewerNavigator
Represents a command bar control that provides navigation and interaction capabilities for PDF documents. The RadPdfViewerNavigator includes buttons for opening, printing, saving documents, as well as navigation controls, zoom functionality, search features, and viewing mode options. It can be associated with a RadPdfViewer to provide a complete PDF viewing experience.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.PdfViewer.dll
Syntax:
[TelerikToolboxCategory("PdfViewer")]
public class RadPdfViewerNavigator : RadCommandBar, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadCommandBarRadPdfViewerNavigator
Implements:
Inherited Members
Constructors
RadPdfViewerNavigator()
Initializes a new instance of the RadPdfViewerNavigator class with default controls and configuration.
Declaration
public RadPdfViewerNavigator()RadPdfViewerNavigator(RadPdfViewer)
Initializes a new instance of the RadPdfViewerNavigator class and associates it with the specified RadPdfViewer.
Declaration
public RadPdfViewerNavigator(RadPdfViewer owner)Parameters
owner
The RadPdfViewer control to associate with this navigator.
Properties
AssociatedViewer
Gets or sets the RadPdfViewer control that this navigator is associated with for providing navigation and control functionality.
Declaration
[Browsable(true)]
public RadPdfViewer AssociatedViewer { get; set; }Property Value
AssociatedViewerElement
Gets or sets the RadPdfViewerElement that this navigator directly controls for PDF viewing operations.
Declaration
[Browsable(false)]
public RadPdfViewerElement AssociatedViewerElement { get; set; }Property Value
CurrentPageTextBox
Gets the text box that displays and allows editing of the current page number.
Declaration
[Browsable(false)]
public CommandBarTextBox CurrentPageTextBox { get; }Property Value
DefaultSize
Declaration
protected override Size DefaultSize { get; }Property Value
Overrides
DefaultStrip
Gets the command bar strip element that contains the default set of navigation and control buttons.
Declaration
[Browsable(false)]
public CommandBarStripElement DefaultStrip { get; }Property Value
Dock
Gets or sets the docking behavior of this navigator control within its parent container.
Declaration
public override DockStyle Dock { get; set; }Property Value
Overrides
FindNextButton
Gets the button that searches for the next occurrence of the specified text in the document.
Declaration
[Browsable(false)]
public CommandBarButton FindNextButton { get; }Property Value
FindPreviousButton
Gets the button that searches for the previous occurrence of the specified text in the document.
Declaration
[Browsable(false)]
public CommandBarButton FindPreviousButton { get; }Property Value
FitToPageButton
Gets the toggle button that switches between fit-to-page mode and normal display mode.
Declaration
[Browsable(false)]
public CommandBarToggleButton FitToPageButton { get; }Property Value
FitToWidthButton
Gets the toggle button that switches between fit-to-width mode and normal display mode.
Declaration
[Browsable(false)]
public CommandBarToggleButton FitToWidthButton { get; }Property Value
Focusable
Gets or sets a value indicating whether this navigator control can receive input focus.
Declaration
[Browsable(false)]
public override bool Focusable { get; set; }Property Value
Overrides
HandToolButton
Gets the toggle button that activates the hand tool for panning and scrolling the document.
Declaration
[Browsable(false)]
public CommandBarToggleButton HandToolButton { get; }Property Value
NextButton
Gets the button that navigates to the next page in the document.
Declaration
[Browsable(false)]
public CommandBarButton NextButton { get; }Property Value
OpenButton
Gets the button that opens PDF documents.
Declaration
[Browsable(false)]
public CommandBarButton OpenButton { get; }Property Value
PreviousButton
Gets the button that navigates to the previous page in the document.
Declaration
[Browsable(false)]
public CommandBarButton PreviousButton { get; }Property Value
PrintButton
Gets the button that prints the current PDF document.
Declaration
[Browsable(false)]
public CommandBarButton PrintButton { get; }Property Value
PrintDocument
Gets the RadPrintDocument instance used for printing PDF documents through this navigator.
Declaration
[Browsable(false)]
public RadPrintDocument PrintDocument { get; }Property Value
RotateClockwiseButton
Gets the button that rotates the document clockwise.
Declaration
[Browsable(false)]
public CommandBarButton RotateClockwiseButton { get; }Property Value
RotateCounterclockwiseButton
Gets the button that rotates the document counterclockwise.
Declaration
[Browsable(false)]
public CommandBarButton RotateCounterclockwiseButton { get; }Property Value
Rows
Gets the collection of command bar row elements that define the layout structure of this navigator.
Declaration
[Browsable(false)]
public RadCommandBarLinesElementCollection Rows { get; }Property Value
SaveButton
Gets the button that saves the PDF document.
Declaration
[Browsable(false)]
public CommandBarButton SaveButton { get; }Property Value
SearchTextBox
Gets the text box that allows users to enter search terms for finding text within the document.
Declaration
[Browsable(false)]
public CommandBarTextBox SearchTextBox { get; }Property Value
SelectToolButton
Gets the toggle button that activates the text selection tool for selecting text within the document.
Declaration
[Browsable(false)]
public CommandBarToggleButton SelectToolButton { get; }Property Value
ShowPrintPreview
Gets or sets a value indicating whether the print preview dialog is displayed before printing documents.
Declaration
[Browsable(true)]
public bool ShowPrintPreview { get; set; }Property Value
ShowSignatureButton
Gets the toggle button that shows or hides the digital signature panel for viewing document signatures.
Declaration
[Browsable(false)]
public CommandBarToggleButton ShowSignatureButton { get; }Property Value
TotalPagesLabel
Gets the label that displays the total number of pages in the document.
Declaration
[Browsable(false)]
public CommandBarLabel TotalPagesLabel { get; }Property Value
ZoomDropDown
Gets the drop-down list that allows selecting specific zoom levels for the document.
Declaration
[Browsable(false)]
public CommandBarDropDownList ZoomDropDown { get; }Property Value
ZoomInButton
Gets the button that increases the zoom level of the document.
Declaration
[Browsable(false)]
public CommandBarButton ZoomInButton { get; }Property Value
ZoomOutButton
Gets the button that decreases the zoom level of the document.
Declaration
[Browsable(false)]
public CommandBarButton ZoomOutButton { get; }Property Value
Methods
AddDefaultItems()
Creates and configures the default set of command bar items including buttons, text boxes, and separators for PDF navigation and control.
Declaration
protected virtual void AddDefaultItems()Dispose(bool)
Declaration
protected override void Dispose(bool disposing)Parameters
disposing
Overrides
InitializeZoomDropDown()
Initializes the zoom dropdown control with predefined zoom factor values and configures its event handlers.
Declaration
protected virtual void InitializeZoomDropDown()LocalizeStrings()
Localizes the text and tooltip content of all navigator buttons and controls using the current localization provider.
Declaration
protected virtual void LocalizeStrings()OnAssociatedViewerChanged()
Called when the associated PDF viewer changes and updates the navigator's state to reflect the new viewer's properties.
Declaration
protected virtual void OnAssociatedViewerChanged()OnLoad(Size)
Called when the control is loaded and sets up the initial zoom dropdown sizing based on the current theme.
Declaration
protected override void OnLoad(Size desiredSize)Parameters
desiredSize
The desired size for the control.
Overrides
OnThemeChanged()
Called when the theme changes and updates the zoom control sizing and icon sets based on the new theme.
Declaration
protected override void OnThemeChanged()Overrides
OnVisibleChanged(EventArgs)
Declaration
protected override void OnVisibleChanged(EventArgs e)Parameters
e
Overrides
SetZoom(float)
Sets the zoom level for the PDF document to the specified factor.
Declaration
protected void SetZoom(float factor)Parameters
factor
The zoom factor to apply to the document.
SetZoomSize()
Sets the appropriate sizing constraints for the zoom dropdown control based on the current theme settings.
Declaration
protected virtual void SetZoomSize()UnwireViewerEvents()
Unsubscribes from events of the previously associated PDF viewer element to prevent memory leaks and state conflicts.
Declaration
protected virtual void UnwireViewerEvents()UpdateButtonsEnableState()
Updates the enabled state of search-related buttons based on whether search text is present.
Declaration
protected virtual void UpdateButtonsEnableState()UpdateCurrentPage()
Updates the current page display to show the current page number from the PDF viewer.
Declaration
public void UpdateCurrentPage()UpdatePageCount()
Updates the total page count display to show the total number of pages in the current document.
Declaration
public void UpdatePageCount()UpdatePrintLandscapeMode()
Updates the print orientation based on the current document's page orientation.
Declaration
public virtual void UpdatePrintLandscapeMode()WireViewerEvents()
Subscribes to events from the associated PDF viewer element to keep the navigator synchronized with viewer state changes.
Declaration
protected virtual void WireViewerEvents()