Back to all docs
API Reference / Telerik.Windows.Controls / FixedDocumentViewerBase
New to Telerik UI for WPF? Start a free 30-day trial

FixedDocumentViewerBase

Class

Base document viewing control that can host RadFixedDocument.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.FixedDocumentViewers.dll

Syntax:
C#
public abstract class FixedDocumentViewerBase : Control, IFixedDocumentViewer

Inheritance: objectFixedDocumentViewerBase

Derived Classes: RadPdfViewer

Implements: IFixedDocumentViewer

Constructors

FixedDocumentViewerBase()

Initializes a new instance of the FixedDocumentViewerBase class.

C#
public FixedDocumentViewerBase()

Fields

CommandDescriptorsProperty

DependencyProperty

Identifies Teleerik.Windows.Controls.FixedDocumentViewerBase.CommandDescriptors property.

C#
public static readonly DependencyProperty CommandDescriptorsProperty

CurrentPageNumberProperty

DependencyProperty

Identifies Telerik.Windows.Controls.FixedDocumentViewerBase.CurrentPageNumber property.

C#
public static readonly DependencyProperty CurrentPageNumberProperty

DocumentProperty

DependencyProperty

Identifies Telerik.Windows.Controls.FixedDocumentViewerBase.Document property.

C#
public static readonly DependencyProperty DocumentProperty

ModeProperty

DependencyProperty

Identifies Telerik.Windows.Controls.FixedDocumentViewerBase.Mode property.

C#
public static readonly DependencyProperty ModeProperty

ScaleFactorProperty

DependencyProperty

Identifies Teleerik.Windows.Controls.FixedDocumentViewerBase.ScaleFactor property.

C#
public static readonly DependencyProperty ScaleFactorProperty

ScaleModeProperty

DependencyProperty

Identifies Telerik.Windows.Controls.FixedDocumentViewerBase.ScaleMode property.

C#
public static readonly DependencyProperty ScaleModeProperty

SelectionFillProperty

DependencyProperty

Identifies Telerik.Windows.Controls.FixedDocumentViewerBase.SelectionFill property.

C#
public static readonly DependencyProperty SelectionFillProperty

Properties

CanHorizontallyScroll

Gets the can horizontally scroll.

C#
public bool CanHorizontallyScroll { get; }
Property Value:

The can horizontally scroll.

Implements: IFixedDocumentViewer.CanHorizontallyScroll

CanVerticallyScroll

Gets the can vertically scroll.

C#
public bool CanVerticallyScroll { get; }
Property Value:

The can vertically scroll.

Implements: IFixedDocumentViewer.CanVerticallyScroll

CommandDescriptors

Gets or sets the command descriptors.

C#
public CommandDescriptors CommandDescriptors { get; set; }
Property Value:

The command descriptors.

CurrentPage

RadFixedPage

Gets the current page.

C#
public RadFixedPage CurrentPage { get; }
Property Value:

The current page.

CurrentPageNumber

Gets or sets the current page number.

C#
public int CurrentPageNumber { get; set; }
Property Value:

The current page number.

Cursors

Gets the cursors.

C#
public CursorsCollection Cursors { get; }
Property Value:

The cursors.

Implements: IFixedDocumentViewer.Cursors

DefaultImportSettings

PdfImportSettings

Gets or sets the default import settings for the current FixedDocumentViewerBase. This property is used in the OpenPdfDocumentCommand.

C#
public PdfImportSettings DefaultImportSettings { get; set; }
Property Value:

The default import settings.

Document

RadFixedDocument

Gets or sets the document for the viewer.

C#
public RadFixedDocument Document { get; set; }
Property Value:

The document.

Implements: IFixedDocumentViewer.Document

Remarks:

Instance of RadFixedDocument can be created from PdfFormatProvider class. Otherwise the DocumentSource property should be used.

DocumentSource

Gets or sets the document source for the viewer.

C#
public abstract FixedDocumentStreamSource DocumentSource { get; set; }
Property Value:

The document source.

FixedDocumentPresenter

Gets or sets the document presenter. The fixed document presenter is used to visualize RadFixedDocument instance.

C#
public IFixedDocumentPresenter FixedDocumentPresenter { get; set; }
Property Value:

The document presenter.

Implements: IFixedDocumentViewer.FixedDocumentPresenter

HorizontalScrollBar

ScrollBar

Gets the horizontal scroll bar.

C#
public ScrollBar HorizontalScrollBar { get; }

Implements: IFixedDocumentViewer.HorizontalScrollBar

HorizontalScrollOffset

Gets the horizontal scroll offset.

C#
public double HorizontalScrollOffset { get; }
Property Value:

The horizontal scroll offset.

Implements: IFixedDocumentViewer.HorizontalScrollOffset

Mode

Gets or sets the mode that the FixedDocumentViewerBase class works.

C#
public FixedDocumentViewerMode Mode { get; set; }
Property Value:

The mode.

Implements: IFixedDocumentViewer.Mode

PagesCount

Gets the number of pages of the currently loaded document.

C#
public int PagesCount { get; }
Property Value:

The pages count.

RotationAngle

Gets the rotation angle.

C#
public RotationAngle RotationAngle { get; }
Property Value:

The rotation angle.

Implements: IFixedDocumentViewer.RotationAngle

ScaleFactor

Gets or sets the scale factor for the viewer.

C#
public double ScaleFactor { get; set; }
Property Value:

The scale factor.

Implements: IFixedDocumentViewer.ScaleFactor

ScaleMode

ScaleMode

Gets or sets the scale mode.

C#
public ScaleMode ScaleMode { get; set; }
Property Value:

The scale mode.

SelectionFill

Brush

Gets or sets the selection fill.

C#
public Brush SelectionFill { get; set; }
Property Value:

The selection fill.

Settings

Gets or sets the settings for the RadPdfViewerBase class.

C#
public FixedDocumentViewerSettings Settings { get; set; }
Property Value:

The settings.

Implements: IFixedDocumentViewer.Settings

VerticalScrollBar

ScrollBar

Gets the vertical scroll bar.

C#
public ScrollBar VerticalScrollBar { get; }

Implements: IFixedDocumentViewer.VerticalScrollBar

VerticalScrollOffset

Gets the vertical scroll offset.

C#
public double VerticalScrollOffset { get; }
Property Value:

The vertical scroll offset.

Implements: IFixedDocumentViewer.VerticalScrollOffset

Methods

ClearDocument()

Clears the document.

C#
public void ClearDocument()

Copy()

Copies the selected text in the Clipboard.

C#
public void Copy()

Find(string, TextSearchOptions)

SearchResult

Finds next match for the specified text in the current document using specified options.

C#
public SearchResult Find(string text, TextSearchOptions options)
Parameters:textstring

The text.

optionsTextSearchOptions

The options.

Returns:

SearchResult

The result.

Find(string)

SearchResult

Finds next match for the specified text in the current document.

C#
public SearchResult Find(string text)
Parameters:textstring

The text.

Returns:

SearchResult

The result.

FindAll(string, TextSearchOptions)

IEnumerable<SearchResult>

Finds all matches for the specified text in the current document using specified options.

C#
public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options)
Parameters:textstring

The text.

optionsTextSearchOptions

The options.

Returns:

IEnumerable<SearchResult>

FindAll(string)

IEnumerable<SearchResult>

Finds all matches for the specified text in the current document.

C#
public IEnumerable<SearchResult> FindAll(string text)
Parameters:textstring

The text.

Returns:

IEnumerable<SearchResult>

FindPrevious(string, TextSearchOptions)

SearchResult

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

C#
public SearchResult FindPrevious(string text, TextSearchOptions options)
Parameters:textstring

The text.

optionsTextSearchOptions

The options.

Returns:

SearchResult

FindPrevious(string)

SearchResult

Finds the previous text in the current document.

C#
public SearchResult FindPrevious(string text)
Parameters:textstring

The text.

Returns:

SearchResult

FitToPage()

Fits FixedDocumentViewerBase content to page size.

C#
public void FitToPage()

FitToWidth()

Fits FixedDocumentViewerBase content to page width.

C#
public void FitToWidth()

GetRegisteredPresenter(string)

Gets the registered presenter.

C#
public IFixedDocumentPresenter GetRegisteredPresenter(string presenterName)
Parameters:presenterNamestring

Name of the presenter.

Returns:

IFixedDocumentPresenter

GetSelectedText()

Gets the selected text.

C#
public string GetSelectedText()
Returns:

string

GetSelectedTextAsync()

Gets the selected text asynchronously.

C#
public Task<string> GetSelectedTextAsync()
Returns:

Task<string>

GoToDestination(Destination, bool)

Goes to given destination.

C#
public void GoToDestination(Destination destination, bool syncBookmark = true)
Parameters:destinationDestination

The destination.

syncBookmarkbool

If set to true the SyncCurrentBookmarkItemCommand is executed as well.

GoToPage(int)

Goes to specified page.

C#
public void GoToPage(int pageNo)
Parameters:pageNoint

The page number.

HasRegisteredPresenter(string)

Determines whether [has registered presenter] [the specified presenter name].

C#
public bool HasRegisteredPresenter(string presenterName)
Parameters:presenterNamestring

Name of the presenter.

Returns:

bool

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call . In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks.

C#
public override void OnApplyTemplate()

OnDocumentChangedOverride(RadFixedDocument, RadFixedDocument)

Called when the document is changed.

C#
protected virtual void OnDocumentChangedOverride(RadFixedDocument oldValue, RadFixedDocument newValue)
Parameters:oldValueRadFixedDocument

The old value.

newValueRadFixedDocument

The new value.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

PageDown()

Goes a page down.

C#
public void PageDown()

PageUp()

Goes a page up.

C#
public void PageUp()

Print()

Prints the current document using the default print settings.

C#
public void Print()

Print(PrintDialog, PrintSettings)

Prints with the specified print dialog. The dialog should already be initialized.

C#
public void Print(PrintDialog printDialog, PrintSettings settings)
Parameters:printDialogPrintDialog

The print dialog. .

settingsPrintSettings

The print settings.

Print(PrintSettings)

Prints the current document.

C#
public void Print(PrintSettings settings)
Parameters:settingsPrintSettings

The print settings.

RegisterPresenter(string, IFixedDocumentPresenter)

Registers the presenter.

C#
public void RegisterPresenter(string presenterName, IFixedDocumentPresenter presenter)
Parameters:presenterNamestring

Name of the presenter.

presenterIFixedDocumentPresenter

The presenter.

ScrollToHorizontalOffset(double)

Scrolls to horizontal offset.

C#
public void ScrollToHorizontalOffset(double offset)
Parameters:offsetdouble

The offset.

Implements: IFixedDocumentViewer.ScrollToHorizontalOffset(double)

ScrollToVerticalOffset(double)

Scrolls to vertical offset.

C#
public void ScrollToVerticalOffset(double offset)
Parameters:offsetdouble

The offset.

Implements: IFixedDocumentViewer.ScrollToVerticalOffset(double)

Select(TextPosition, TextPosition)

Creates selection from start position to end position.

C#
public void Select(TextPosition startPosition, TextPosition endPosition)
Parameters:startPositionTextPosition

The start position.

endPositionTextPosition

The end position.

Select(TextRange)

Selects the specified range.

C#
public void Select(TextRange range)
Parameters:rangeTextRange

The range.

SetDocumentSource(FixedDocumentStreamSource)

Sets the document source.

C#
protected virtual void SetDocumentSource(FixedDocumentStreamSource source)
Parameters:sourceFixedDocumentStreamSource

The source.

SetRotationAngle(RotationAngle)

Sets the rotation angle.

C#
public void SetRotationAngle(RotationAngle rotationAngle)
Parameters:rotationAngleRotationAngle

The rotation angle.

UpdatePresenterLayout()

Updates the current presenter layout.

C#
public void UpdatePresenterLayout()

Events

AnnotationClicked

EventHandler<AnnotationEventArgs>

Occurs when annotation is clicked.

C#
public event EventHandler<AnnotationEventArgs> AnnotationClicked

CurrentPageChanged

Occurs when the current page is changed.

C#
public event EventHandler<CurrentPageChangedEventArgs> CurrentPageChanged

DocumentChanged

Occurs when the PDF document is changed.

C#
public event EventHandler<DocumentChangedEventArgs> DocumentChanged

Implements: IFixedDocumentViewer.DocumentChanged

FixedDocumentPresenterChanged

Occurs when [fixed document presenter changed].

C#
public event EventHandler FixedDocumentPresenterChanged

HyperlinkClicked

Occurs when the hyperlink is clicked.

C#
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked

Implements: IFixedDocumentViewer.HyperlinkClicked

ModeChanged

Occurs when the mode is changed.

C#
public event EventHandler ModeChanged

ScaleFactorChanged

Occurs when the scale factor is changed.

C#
public event EventHandler<ScaleFactorChangedEventArgs> ScaleFactorChanged

Implements: IFixedDocumentViewer.ScaleFactorChanged

ScaleModeChanged

Occurs when the scale mode is changed.

C#
public event EventHandler ScaleModeChanged
In this article
DefinitionConstructorsFixedDocumentViewerBase()FieldsCommandDescriptorsPropertyCurrentPageNumberPropertyDocumentPropertyModePropertyScaleFactorPropertyScaleModePropertySelectionFillPropertyPropertiesCanHorizontallyScrollCanVerticallyScrollCommandDescriptorsCurrentPageCurrentPageNumberCursorsDefaultImportSettingsDocumentDocumentSourceFixedDocumentPresenterHorizontalScrollBarHorizontalScrollOffsetModePagesCountRotationAngleScaleFactorScaleModeSelectionFillSettingsVerticalScrollBarVerticalScrollOffsetMethodsClearDocument()Copy()Find(string, TextSearchOptions)Find(string)FindAll(string, TextSearchOptions)FindAll(string)FindPrevious(string, TextSearchOptions)FindPrevious(string)FitToPage()FitToWidth()GetRegisteredPresenter(string)GetSelectedText()GetSelectedTextAsync()GoToDestination(Destination, bool)GoToPage(int)HasRegisteredPresenter(string)OnApplyTemplate()OnDocumentChangedOverride(RadFixedDocument, RadFixedDocument)OnInitialized(EventArgs)PageDown()PageUp()Print()Print(PrintDialog, PrintSettings)Print(PrintSettings)RegisterPresenter(string, IFixedDocumentPresenter)ScrollToHorizontalOffset(double)ScrollToVerticalOffset(double)Select(TextPosition, TextPosition)Select(TextRange)SetDocumentSource(FixedDocumentStreamSource)SetRotationAngle(RotationAngle)UpdatePresenterLayout()EventsAnnotationClickedCurrentPageChangedDocumentChangedFixedDocumentPresenterChangedHyperlinkClickedModeChangedScaleFactorChangedScaleModeChanged
Not finding the help you need?
Contact Support