Loading...

Class RadPdfViewerElement

Represents the main element of the RadPdfViewer control.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
ScrollViewElement<VirtualizedStackContainer<RadFixedPage>>
VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>
RadPdfViewerElement
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 RadPdfViewerElement : VirtualizedScrollPanel<RadFixedPage, RadFixedPageElement>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IFixedDocumentPresenter, IPrintable

Constructors

RadPdfViewerElement()

Declaration
public RadPdfViewerElement()

Properties

AllowSignatureDialog

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

AllowSignSignatureDialog

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

Annotations

Declaration
public Dictionary<RadFixedPage, RadElement> Annotations { get; set; }
Property Value
System.Collections.Generic.Dictionary<RadFixedPage, RadElement>

AnnotationsColor

Gets or sets the background color of the annotations when they are pressed.

Declaration
public Color AnnotationsColor { get; set; }
Property Value
System.Drawing.Color

AsyncRender

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

CacheCapacity

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

CachePaint

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

CanScrollHorizontally

[true] if the horizontal scroll is visible, [false] otherwise.

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

Implements

CanScrollVertically

[true] if the vertical scroll is visible, [false] otherwise.

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

Implements

ContextMenu

Gets or sets the associated RadContextMenu. By default this is PdfViewerContextMenu.

Declaration
public RadContextMenu ContextMenu { get; set; }
Property Value
RadContextMenu

CurrentPage

Gets the current page.

Declaration
public RadFixedPage CurrentPage { get; }
Property Value
RadFixedPage

Implements

Document

Gets or sets the currently loaded RadFixedDocument

Declaration
public RadFixedDocument Document { get; set; }
Property Value
RadFixedDocument

Implements

EditingFields

Declaration
public EditingFields EditingFields { get; }
Property Value
EditingFields

FitFullPage

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

FitToWidth

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

HorizontalScrollState

Gets or sets the display state of the horizontal scrollbar.

Declaration
public ScrollState HorizontalScrollState { get; set; }
Property Value
ScrollState

ImportSettings

Declaration
public PdfImportSettings ImportSettings { get; set; }
Property Value
PdfImportSettings

Mode

Gets or sets the current viewer mode - Pan, TextSelection or None.

Declaration
public FixedDocumentViewerMode Mode { get; set; }
Property Value
FixedDocumentViewerMode

Implements

MouseController

Gets the MouseHandlersController which handles and manages the mouse input.

Declaration
public MouseHandlersController MouseController { get; }
Property Value
MouseHandlersController

MouseHandlersController

Gets the MouseHandlersController which handles and manages the mouse input.

Declaration
public MouseHandlersController MouseHandlersController { get; }
Property Value
MouseHandlersController

Implements

PdfNavigationBehavior

Declaration
public IPdfNavigationBehavior PdfNavigationBehavior { get; set; }
Property Value
IPdfNavigationBehavior

PrintOrientation

Declaration
public PrintOrientation PrintOrientation { get; set; }
Property Value
PrintOrientation

PrintScalePageToPaperSize

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

ReadingMode

Gets or sets whether the entire document is loaded at the beginning or pages are loaded on demand.

Declaration
public ReadingMode ReadingMode { get; set; }
Property Value
ReadingMode

RotateAngle

Gets or Sets the angle for pages rotation

Declaration
public RotationAngle RotateAngle { get; set; }
Property Value
RotationAngle

ScaleFactor

Gets or sets the factor by which the document is scaled.

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

SelectionColor

Gets or sets the color that highlights the current selection.

Declaration
public Color SelectionColor { get; set; }
Property Value
System.Drawing.Color

SignatureValidationProperties

Gets or Sets SignatureValidationProperties

Declaration
public SignatureValidationProperties SignatureValidationProperties { get; set; }
Property Value
SignatureValidationProperties

UseBufferedPrinting

if True, the page will be printed in an image that will be send to the printer at once. Loss of quality is possible.

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

UsePdfProcessingModel

Declaration
[Obsolete("The model from the PdfProcessing library is always used for rendering the PDF pages. As of R2 2023 setting this property will not have any effect. The property will be removed in R2 2024.")]
public bool UsePdfProcessingModel { get; set; }
Property Value
System.Boolean

UsePdfProcessingModelDefaultValue

Declaration
[Obsolete("The model from the PdfProcessing library is always used for rendering the PDF pages. As of R2 2023 setting this property will not have any effect. The property will be removed in R2 2024.")]
public static bool UsePdfProcessingModelDefaultValue { get; set; }
Property Value
System.Boolean

VerticalScrollState

Gets or sets the display state of the vertical scrollbar.

Declaration
public ScrollState VerticalScrollState { get; set; }
Property Value
ScrollState

Methods

ArrangeOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.VirtualizedStackContainer<Telerik.Windows.Documents.Fixed.Model.RadFixedPage>>.ArrangeOverride(System.Drawing.SizeF)

BringIntoView(TextPosition)

Scrolls horizontally and vertically to ensure that the specified TextPosition is in the view port.

Declaration
public void BringIntoView(TextPosition textPosition)
Parameters
TextPosition textPosition

The TextPosition to bring into view.

Copy()

Copies the selected text in the Clipboard.

Declaration
public void Copy()

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides
Telerik.WinControls.UI.VirtualizedScrollPanel<Telerik.Windows.Documents.Fixed.Model.RadFixedPage, Telerik.WinControls.UI.RadFixedPageElement>.CreateChildElements()

CreateElementProvider()

Declaration
protected override IVirtualizedElementProvider<RadFixedPage> CreateElementProvider()
Returns
IVirtualizedElementProvider<RadFixedPage>

Overrides
Telerik.WinControls.UI.VirtualizedScrollPanel<Telerik.Windows.Documents.Fixed.Model.RadFixedPage, Telerik.WinControls.UI.RadFixedPageElement>.CreateElementProvider()

CreateItemScroller()

Declaration
protected override ItemScroller<RadFixedPage> CreateItemScroller()
Returns
ItemScroller<RadFixedPage>

Overrides
Telerik.WinControls.UI.VirtualizedScrollPanel<Telerik.Windows.Documents.Fixed.Model.RadFixedPage, Telerik.WinControls.UI.RadFixedPageElement>.CreateItemScroller()

CreatePageElement(RadFixedPage, Object)

Creates a RadFixedPageElement for a given RadFixedPage. Fires the PageElementCreating event.

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

The RadFixedPage.
System.Object context

The context.
Returns
IVirtualizedElement<RadFixedPage>

The RadFixedPageElement.

CreateViewElement()

Declaration
protected override VirtualizedStackContainer<RadFixedPage> CreateViewElement()
Returns
VirtualizedStackContainer<RadFixedPage>

Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.VirtualizedStackContainer<Telerik.Windows.Documents.Fixed.Model.RadFixedPage>>.CreateViewElement()

DeselectAll()

Clears the current selection.

Declaration
public void DeselectAll()

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides
Telerik.WinControls.UI.VirtualizedScrollPanel<Telerik.Windows.Documents.Fixed.Model.RadFixedPage, Telerik.WinControls.UI.RadFixedPageElement>.DisposeManagedResources()

ExportPage(Int32, Double, Boolean, ImageFormat)

Export a single Pdf Page to a Bitmap

Declaration
public Bitmap ExportPage(int pageNumber, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)
Parameters
System.Int32 pageNumber

Number of the page to export. Firts page have a number 1. 0 means export of the current page.
System.Double aspectRatio

Scale factor. 1 mean original size.
System.Boolean overrideFileIfAlreadyExist

override image file if they exists
System.Drawing.Imaging.ImageFormat imageFormat

Specify an image format when saving the image
Returns
System.Drawing.Bitmap

returns a Bitmap. This bitmap should be disposed manually.

ExportPage(Int32, String, Double, Boolean, ImageFormat)

Export a single Pdf Page to an image file on the disk

Declaration
public bool ExportPage(int pageNumber, string fileName, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)
Parameters
System.Int32 pageNumber

Number of the page to export. Firts page have a number 1. 0 means export of the current page.
System.String fileName

Output image file
System.Double aspectRatio

Scale factor. 1 mean original size.
System.Boolean overrideFileIfAlreadyExist

override image file if they exists
System.Drawing.Imaging.ImageFormat imageFormat

Specify an image format when saving the image
Returns
System.Boolean

returns False if file already exist and overrideFileIfAlreadyExist is false

ExportPages(Double, Boolean, ImageFormat)

Export all Pdf Pages to a collection of Bitmaps

Declaration
public IEnumerable<Bitmap> ExportPages(double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)
Parameters
System.Double aspectRatio

Scale factor - 1 mean original size.
System.Boolean overrideFileIfAlreadyExist

override image file if they exists
System.Drawing.Imaging.ImageFormat imageFormat

Specify an image format when saving the image
Returns
System.Collections.Generic.IEnumerable<System.Drawing.Bitmap>

returns collection of Bitmaps. These Bitmaps should be disposed manually.

ExportPages(String, Double, Boolean, ImageFormat)

Export all Pdf Pages to an image files on the disk

Declaration
public bool ExportPages(string fileName, double aspectRatio, bool overrideFileIfAlreadyExist, ImageFormat imageFormat)
Parameters
System.String fileName

Output image file
System.Double aspectRatio

Scale factor - 1 mean original size.
System.Boolean overrideFileIfAlreadyExist

override image file if they exists
System.Drawing.Imaging.ImageFormat imageFormat

Specify an image format when saving the image
Returns
System.Boolean

returns False if file already exist and overrideFileIfAlreadyExist set to False

Find(String)

Finds the specified text in the current document.

Declaration
public SearchResult Find(string text)
Parameters
System.String text

The text.
Returns
SearchResult

The result.

Find(String, Int32)

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

Declaration
public SearchResult Find(string text, int pageNumber)
Parameters
System.String text

The text.
System.Int32 pageNumber

The Page.
Returns
SearchResult

The result.

Find(String, TextSearchOptions)

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

Declaration
public SearchResult Find(string text, TextSearchOptions options)
Parameters
System.String text

The text.
TextSearchOptions options

The options.
Returns
SearchResult

The result.

FindPrevious(String)

Finds the previous text in the current document.

Declaration
public SearchResult FindPrevious(string text)
Parameters
System.String text

The text.
Returns
SearchResult

FindPrevious(String, TextSearchOptions)

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

Declaration
public SearchResult FindPrevious(string text, TextSearchOptions options)
Parameters
System.String text

The text.
TextSearchOptions options

The options.
Returns
SearchResult

FitFullPageCore()

Declaration
public void FitFullPageCore()

FitPageToWidthCore()

Declaration
public void FitPageToWidthCore()

GetDocumentAsStream()

Gets the PDF document as stream

Declaration
public Stream GetDocumentAsStream()
Returns
System.IO.Stream

GetFocusedPage()

Gets the RadFixedPageElement which contains the caret.

Declaration
public RadFixedPageElement GetFocusedPage()
Returns
RadFixedPageElement

GetLocationFromViewPoint(Point, out RadFixedPage, out Point)

Declaration
public bool GetLocationFromViewPoint(Point viewPoint, out RadFixedPage page, out Point location)
Parameters
System.Drawing.Point viewPoint

RadFixedPage page

System.Drawing.Point location

Returns
System.Boolean

Implements

GetPageElement(RadFixedPage)

Gets the RadFixedPageElement which corresponds to a given RadFixedPage.

Declaration
public RadFixedPageElement GetPageElement(RadFixedPage page)
Parameters
RadFixedPage page

The RadFixedPage.
Returns
RadFixedPageElement

The RadFixedPageElement corresponding to the given logical page.

GetPageVerticalOffset(RadFixedPage)

Gets the vertical offset of a given page from the top edge of the first page.

Declaration
public int GetPageVerticalOffset(RadFixedPage page)
Parameters
RadFixedPage page

The page.
Returns
System.Int32

The offset.

GetScrollOffset()

Gets the current scroll offset.

Declaration
public Point GetScrollOffset()
Returns
System.Drawing.Point

The offset
Implements

GetSelectedText()

Gets the selected text.

Declaration
public string GetSelectedText()
Returns
System.String

GetSelectedTextAsync()

Gets the selected text asynchronously.

Declaration
public Task<string> GetSelectedTextAsync()
Returns
System.Threading.Tasks.Task<System.String>

GetViewPointFromTextPosition(TextPosition)

Gets the location in the view of a given TextPosition.

Declaration
public Point GetViewPointFromTextPosition(TextPosition position)
Parameters
TextPosition position

The TextPosition.
Returns
System.Drawing.Point

The coordinates of the location.

GoToDestination(Destination)

Navigates to a specified destination.

Declaration
public void GoToDestination(Destination dest)
Parameters
Destination dest

The destination.
Implements

GoToPage(Int32)

Navigates to the page with the specified number.

Declaration
public void GoToPage(int pageNo)
Parameters
System.Int32 pageNo

The page number.
Implements

HideCaret()

Hides the caret indicator.

Declaration
public void HideCaret()
Implements

HideSignaturePanel()

Declaration
public void HideSignaturePanel()

InvalidatePage(RadFixedPage)

Invalidates a given page.

Declaration
public void InvalidatePage(RadFixedPage page)
Parameters
RadFixedPage page

The page to invalidate.

InvalidatePages()

Invalidates all pages.

Declaration
public void InvalidatePages()

IsWaiting()

Checks if the loading indicator is currently waiting.

Declaration
public bool IsWaiting()
Returns
System.Boolean

[true] if the loading indicator is waiting, [false] otherwise

LoadDocument(Stream)

Loads a PDF document from a specified stream.

Declaration
public void LoadDocument(Stream stream)
Parameters
System.IO.Stream stream

The stream of PDF data.

LoadDocument(String)

Loads a PDF document from a specified file name.

Declaration
public void LoadDocument(string path)
Parameters
System.String path

The path of the PDF file.

LoadDocument(RadFixedDocument)

Loads a RadFixedDocument.

Declaration
public void LoadDocument(RadFixedDocument document)
Parameters
RadFixedDocument document

The RadFixedDocument.

MeasureOverride(SizeF)

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

Returns
System.Drawing.SizeF

Overrides
Telerik.WinControls.UI.VirtualizedScrollPanel<Telerik.Windows.Documents.Fixed.Model.RadFixedPage, Telerik.WinControls.UI.RadFixedPageElement>.MeasureOverride(System.Drawing.SizeF)

MoveToNextEditor()

Declaration
public virtual void MoveToNextEditor()

MoveToPreviousEditor()

Declaration
public virtual void MoveToPreviousEditor()

OnAnnotationClicked(AnnotationEventArgs)

Fires the AnnotationClicked event.

Declaration
protected virtual void OnAnnotationClicked(AnnotationEventArgs e)
Parameters
AnnotationEventArgs e

OnBoundsChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnCaretPositionChanged()

Fires the CaretPositionChanged event.

Declaration
protected virtual void OnCaretPositionChanged()

OnCurrenPageChanged(CurrentPageChangedEventArgs)

Declaration
protected virtual void OnCurrenPageChanged(CurrentPageChangedEventArgs args)
Parameters
CurrentPageChangedEventArgs args

OnDataError(Object, PdfExceptionEventArgs)

Declaration
protected virtual bool OnDataError(object sender, PdfExceptionEventArgs e)
Parameters
System.Object sender

PdfExceptionEventArgs e

Returns
System.Boolean

OnDocumentLoaded()

Fires the DocumentLoaded event.

Declaration
protected virtual void OnDocumentLoaded()

OnDocumentUnloaded()

Fires the DocumentLoaded event.

Declaration
protected virtual void OnDocumentUnloaded()

OnFitFullPageChanged(EventArgs)

Fires the FitFullPageChanged event.

Declaration
protected virtual void OnFitFullPageChanged(EventArgs e)
Parameters
System.EventArgs e

OnFitToWidthChanged(EventArgs)

Fires the FitToWidthChanged event.

Declaration
protected virtual void OnFitToWidthChanged(EventArgs e)
Parameters
System.EventArgs e

OnPageElementCreating(RadFixedPageElementEventArgs)

Fires the PageElementCreating event.

Declaration
protected virtual void OnPageElementCreating(RadFixedPageElementEventArgs args)
Parameters
RadFixedPageElementEventArgs args

OnPanGesture(PanGestureEventArgs)

Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
PanGestureEventArgs args

Overrides

OnScaleFactorChanged()

Fires the ScaleFactorChanged event.

Declaration
protected virtual void OnScaleFactorChanged()

OnSelectionChanged()

Fires the SelectionChanged event.

Declaration
protected virtual void OnSelectionChanged()

OnViewerModeChanged()

Fires the ViewerModeChanged event.

Declaration
protected virtual void OnViewerModeChanged()

OnZoomGesture(ZoomGestureEventArgs)

Declaration
protected override void OnZoomGesture(ZoomGestureEventArgs args)
Parameters
ZoomGestureEventArgs args

Overrides

PageDown()

Navigates to the next page.

Declaration
public void PageDown()
Implements

PageUp()

Navigates to the previous page.

Declaration
public void PageUp()
Implements

PaintChildren(IGraphics, Rectangle, Single, SizeF, Boolean)

Declaration
protected override void PaintChildren(IGraphics graphics, Rectangle clipRectange, float angle, SizeF scale, bool useRelativeTransformation)
Parameters
IGraphics graphics

System.Drawing.Rectangle clipRectange

System.Single angle

System.Drawing.SizeF scale

System.Boolean useRelativeTransformation

Overrides

Print()

Directly prints the RadPdfViewer to the default printer.

Declaration
public virtual void Print()

Print(Boolean)

Directly prints the RadPdfViewer to the default printer or shows printer settitngs and then prints the RadPdfViewer.

Declaration
public virtual void Print(bool showPrinterSettings)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.

Print(Boolean, RadPrintDocument)

Directly prints the RadPdfViewer to the default printer or shows printer settitngs and then prints the RadPdfViewer.

Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

PrintPreview()

Shows a RadPrintPreviewDialog for editing the RadPdfViewer print settings.

Declaration
public virtual void PrintPreview()

PrintPreview(RadPrintDocument)

Shows a RadPrintPreviewDialog for editing the RadPdfViewer print settings.

Declaration
public virtual void PrintPreview(RadPrintDocument document)
Parameters
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

ProcessCaptureLost()

Processes the CaptureLost event.

Declaration
public virtual bool ProcessCaptureLost()
Returns
System.Boolean

[true] if the event should not be processed further, [false] otherwise

ProcessKeyDown(KeyEventArgs)

Processes the KeyDown event.

Declaration
public virtual bool ProcessKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The event arguments
Returns
System.Boolean

[true] if the event should not be processed further, [false] otherwise

ProcessMouseDown(MouseEventArgs, Boolean, Boolean)

Processes the MouseDown event.

Declaration
public virtual bool ProcessMouseDown(MouseEventArgs e, bool shift, bool control)
Parameters
System.Windows.Forms.MouseEventArgs e

The event arguments
System.Boolean shift

[true] if Shift was pressed, [false] otherwise
System.Boolean control

[true] if Control was pressed, [false] otherwise
Returns
System.Boolean

[true] if the event should not be processed further, [false] otherwise

ProcessMouseMove(MouseEventArgs, Boolean, Boolean)

Processes the MouseMove event.

Declaration
public virtual bool ProcessMouseMove(MouseEventArgs e, bool shift, bool control)
Parameters
System.Windows.Forms.MouseEventArgs e

The event arguments
System.Boolean shift

[true] if Shift was pressed, [false] otherwise
System.Boolean control

[true] if Control was pressed, [false] otherwise
Returns
System.Boolean

[true] if the event should not be processed further, [false] otherwise

ProcessMouseUp(MouseEventArgs, Boolean, Boolean)

Processes the MouseUp event.

Declaration
public virtual bool ProcessMouseUp(MouseEventArgs e, bool shift, bool control)
Parameters
System.Windows.Forms.MouseEventArgs e

The event arguments
System.Boolean shift

[true] if Shift was pressed, [false] otherwise
System.Boolean control

[true] if Control was pressed, [false] otherwise
Returns
System.Boolean

[true] if the event should not be processed further, [false] otherwise

ProcessMouseWheel(MouseEventArgs, Boolean, Boolean)

Processes the MouseWheel event.

Declaration
public virtual bool ProcessMouseWheel(MouseEventArgs e, bool shift, bool control)
Parameters
System.Windows.Forms.MouseEventArgs e

The event arguments
System.Boolean shift

[true] if Shift was pressed, [false] otherwise
System.Boolean control

[true] if Control was pressed, [false] otherwise
Returns
System.Boolean

[true] if the event should not be processed further, [false] otherwise

Rotate(RotationAngle)

Rotate page with

Declaration
public void Rotate(RotationAngle angle)
Parameters
RotationAngle angle

SaveDocument(Stream)

Declaration
public bool SaveDocument(Stream outputStream)
Parameters
System.IO.Stream outputStream

Returns
System.Boolean

SaveDocument(String)

Declaration
public bool SaveDocument(string fileName)
Parameters
System.String fileName

Returns
System.Boolean

Scroll(Nullable<Double>, Nullable<Double>)

Scrolls the view with a specified offset.

Declaration
public void Scroll(double? offsetX, double? offsetY)
Parameters
System.Nullable<System.Double> offsetX

The offset by X.
System.Nullable<System.Double> offsetY

The offset by Y.
Implements

ScrollTo(Nullable<Double>, Nullable<Double>)

Scrolls to a specified position.

Declaration
public void ScrollTo(double? x, double? y)
Parameters
System.Nullable<System.Double> x

The x coordinate of the position.
System.Nullable<System.Double> y

The y coordinate of the position.
Implements

Select(SearchResult)

Creates selection from start position to end position.

Declaration
public void Select(SearchResult result)
Parameters
SearchResult result

The result from search.

Select(TextPosition, TextPosition)

Creates selection from start position to end position.

Declaration
public void Select(TextPosition startPosition, TextPosition endPosition)
Parameters
TextPosition startPosition

The start position.
TextPosition endPosition

The end position.

SelectAll()

Selects all text in the document.

Declaration
public void SelectAll()

ShowCaret()

Shows the caret indicator.

Declaration
public void ShowCaret()
Implements

ShowMenu(Point)

Shows the currently assigned ContextMenu at the specified position.

Declaration
public void ShowMenu(Point location)
Parameters
System.Drawing.Point location

ShowPasswordRequireDialog()

Declaration
protected virtual string ShowPasswordRequireDialog()
Returns
System.String

ShowSignatureDialog(SignatureField)

Declaration
protected bool ShowSignatureDialog(SignatureField signatureField)
Parameters
SignatureField signatureField

Returns
System.Boolean

ShowSignaturePanel()

Declaration
public void ShowSignaturePanel()

ShowSignSignatureDialog(SignatureField)

Declaration
protected virtual void ShowSignSignatureDialog(SignatureField signatureField)
Parameters
SignatureField signatureField

StartWaiting()

Displays the loading indicator.

Declaration
public void StartWaiting()

StopWaiting()

Hides the loading indicator.

Declaration
public void StopWaiting()

UnloadDocument()

Declaration
public void UnloadDocument()

UnwireDocumentEvents()

Called when a document is being unloaded to unwire from its events.

Declaration
protected virtual void UnwireDocumentEvents()

UnwireEvents()

Declaration
protected override void UnwireEvents()
Overrides
Telerik.WinControls.UI.VirtualizedScrollPanel<Telerik.Windows.Documents.Fixed.Model.RadFixedPage, Telerik.WinControls.UI.RadFixedPageElement>.UnwireEvents()

UpdateOnMeasure(SizeF)

Declaration
protected override bool UpdateOnMeasure(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Boolean

Overrides
Telerik.WinControls.UI.VirtualizedScrollPanel<Telerik.Windows.Documents.Fixed.Model.RadFixedPage, Telerik.WinControls.UI.RadFixedPageElement>.UpdateOnMeasure(System.Drawing.SizeF)

UpdatePresenterLayout()

Updates the layout.

Declaration
public void UpdatePresenterLayout()
Implements

WireDocumentEvents()

Called when a document is being loaded to wire to its events.

Declaration
protected virtual void WireDocumentEvents()

Events

AnnotationClicked

Fires when a link or a bookmark was clicked.

Declaration
public event EventHandler<AnnotationEventArgs> AnnotationClicked
Event Type
System.EventHandler<AnnotationEventArgs>

CaretPositionChanged

Fires when the caret changes its position.

Declaration
public event EventHandler CaretPositionChanged
Event Type
System.EventHandler

CurrentPageChanged

Fires after the current RadFixedPage has been changed.

Declaration
public event CurrentPageChangedEventHandler CurrentPageChanged
Event Type
CurrentPageChangedEventHandler

DataError

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

Declaration
public event PdfExceptionEventHandler DataError
Event Type
PdfExceptionEventHandler

DocumentLoaded

Fires when the document finishes loading.

Declaration
public event EventHandler DocumentLoaded
Event Type
System.EventHandler

DocumentUnloaded

Fires when the document is unloaded.

Declaration
public event EventHandler DocumentUnloaded
Event Type
System.EventHandler

FitFullPageChanged

Fires when the FitFullPage property has changed.

Declaration
public event EventHandler FitFullPageChanged
Event Type
System.EventHandler

FitToWidthChanged

Fires when the FitToWidth property has changed.

Declaration
public event EventHandler FitToWidthChanged
Event Type
System.EventHandler

HyperlinkClicked

Occurs when the hyperlink is clicked.

Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked
Event Type
System.EventHandler<HyperlinkClickedEventArgs>

PageElementCreating

Fires when a RadFixedPageElement is being created. Allows for replacing it with custom page element.

Declaration
public event RadFixedPageElementEventHandler PageElementCreating
Event Type
RadFixedPageElementEventHandler

PageRenderCompleted

Fires when a RadFixedPageElement has been asynchronously rendered.

Declaration
public event EventHandler PageRenderCompleted
Event Type
System.EventHandler

PageRenderStarted

Fires when a RadFixedPageElement is about to be asynchronously rendered.

Declaration
public event EventHandler PageRenderStarted
Event Type
System.EventHandler

PasswordRequireDialogShowing

Declaration
public event EventHandler<PasswordRequireDialogShowingEventArgs> PasswordRequireDialogShowing
Event Type
System.EventHandler<PasswordRequireDialogShowingEventArgs>

PdfSignaturePanelVisibilityChanged

Declaration
public event EventHandler PdfSignaturePanelVisibilityChanged
Event Type
System.EventHandler

ScaleFactorChanged

Fires when the ScaleFactor property has changed.

Declaration
public event EventHandler ScaleFactorChanged
Event Type
System.EventHandler

SelectionChanged

Fires when the text selection has changed.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

SignatureDialogShowing

Declaration
public event EventHandler<SignatureDialogShowingEventArgs> SignatureDialogShowing
Event Type
System.EventHandler<SignatureDialogShowingEventArgs>

SignSignatureDialogShowing

Declaration
public event EventHandler<SignSignatureDialogShowingEventArgs> SignSignatureDialogShowing
Event Type
System.EventHandler<SignSignatureDialogShowingEventArgs>

ViewerModeChanged

Fires when the ViewerMode property has changed.

Declaration
public event EventHandler ViewerModeChanged
Event Type
System.EventHandler

Explicit Interface Implementations

IPrintable.BeginPrint(RadPrintDocument, PrintEventArgs)

Declaration
int IPrintable.BeginPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Int32

Implements

IPrintable.EndPrint(RadPrintDocument, PrintEventArgs)

Declaration
bool IPrintable.EndPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Boolean

Implements

IPrintable.GetSettingsDialog(RadPrintDocument)

Declaration
Form IPrintable.GetSettingsDialog(RadPrintDocument document)
Parameters
RadPrintDocument document

Returns
System.Windows.Forms.Form

Implements

IPrintable.PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)

Declaration
bool IPrintable.PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)
Parameters
System.Int32 pageNumber

RadPrintDocument sender

System.Drawing.Printing.PrintPageEventArgs args

Returns
System.Boolean

Implements

Extension Methods