Class

FixedDocumentViewerBase

Declaration

public FixedDocumentViewerBase()

Indentifies CommandDescriptors property.

Declaration

public static readonly DependencyProperty CommandDescriptorsProperty

Field Value

Identifies the CurrentPageNumber property.

Declaration

public static readonly DependencyProperty CurrentPageNumberProperty

Field Value

Identifies the Document property.

Declaration

public static readonly DependencyProperty DocumentProperty

Field Value

Identifies DocumentSource property.

Declaration

public static readonly DependencyProperty DocumentSourceProperty

Field Value

Identifies Mode property.

Declaration

public static readonly DependencyProperty ModeProperty

Field Value

Indentifies the ScaleFactor property.

Declaration

public static readonly DependencyProperty ScaleFactorProperty

Field Value

Identifies the ScaleMode property.

Declaration

public static readonly DependencyProperty ScaleModeProperty

Field Value

Identifies the SelectionFill property.

Declaration

public static readonly DependencyProperty SelectionFillProperty

Field Value

Gets the can horizontally scroll.

Declaration

public bool CanHorizontallyScroll { get; }

Property Value

Implements IFixedDocumentViewer.CanHorizontallyScroll

Gets the can vertically scroll.

Declaration

public bool CanVerticallyScroll { get; }

Property Value

Implements IFixedDocumentViewer.CanVerticallyScroll

Gets or sets the command descriptors.

Declaration

public CommandDescriptors CommandDescriptors { get; set; }

Property Value

Gets the current page.

Declaration

public RadFixedPage CurrentPage { get; }

Property Value

Gets or sets the current page number.

Declaration

public int CurrentPageNumber { get; set; }

Property Value

Gets the cursors.

Declaration

public CursorsCollection Cursors { get; }

Property Value

Implements IFixedDocumentViewer.Cursors

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

Declaration

public PdfImportSettings DefaultImportSettings { get; set; }

Property Value

Gets or sets the document for the viewer.

Declaration

public RadFixedDocument Document { get; set; }

Property Value

Implements IFixedDocumentViewer.Document

Remarks

Gets or sets the document source for the viewer.

Declaration

public abstract FixedDocumentStreamSource DocumentSource { get; set; }

Property Value

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

Declaration

public IFixedDocumentPresenter FixedDocumentPresenter { get; set; }

Property Value

Implements IFixedDocumentViewer.FixedDocumentPresenter

Gets the horizontal scroll bar.

Declaration

public ScrollBar HorizontalScrollBar { get; }

Property Value

Implements IFixedDocumentViewer.HorizontalScrollBar

Gets the horizontal scroll offset.

Declaration

public double HorizontalScrollOffset { get; }

Property Value

Implements IFixedDocumentViewer.HorizontalScrollOffset

Gets or sets the mode that the FixedDocumentViewerBase class works.

Declaration

public FixedDocumentViewerMode Mode { get; set; }

Property Value

Implements IFixedDocumentViewer.Mode

Gets the number of pages of the currently loaded document.

Declaration

public int PagesCount { get; }

Property Value

Gets the rotation angle.

Declaration

public RotationAngle RotationAngle { get; }

Property Value

Implements IFixedDocumentViewer.RotationAngle

Gets or sets the scale factor for the viewer.

Declaration

public double ScaleFactor { get; set; }

Property Value

Implements IFixedDocumentViewer.ScaleFactor

Gets or sets the scale mode.

Declaration

public ScaleMode ScaleMode { get; set; }

Property Value

Gets or sets the selection fill.

Declaration

public Brush SelectionFill { get; set; }

Property Value

Gets the vertical scroll bar.

Declaration

public ScrollBar VerticalScrollBar { get; }

Property Value

Implements IFixedDocumentViewer.VerticalScrollBar

Gets the vertical scroll offset.

Declaration

public double VerticalScrollOffset { get; }

Property Value

Implements IFixedDocumentViewer.VerticalScrollOffset

Copies the selected text in the Clipboard.

Declaration

public void Copy()

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

Declaration

public SearchResult Find(string text)

Parameters

Returns

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

Declaration

public SearchResult Find(string text, TextSearchOptions options)

Parameters

Returns

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

Declaration

public IEnumerable<SearchResult> FindAll(string text)

Parameters

Returns

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

Declaration

public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options)

Parameters

Returns

Finds the previous text in the current document.

Declaration

public SearchResult FindPrevious(string text)

Parameters

Returns

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

Declaration

public SearchResult FindPrevious(string text, TextSearchOptions options)

Parameters

Returns

Fits FixedDocumentViewerBase content to page size.

Declaration

public void FitToPage()

Fits FixedDocumentViewerBase content to page width.

Declaration

public void FitToWidth()

Gets the registered presenter.

Declaration

public IFixedDocumentPresenter GetRegisteredPresenter(string presenterName)

Parameters

Returns

Gets the selected text.

Declaration

public string GetSelectedText()

Returns

Gets the selected text asynchronously.

Declaration

public Task<string> GetSelectedTextAsync()

Returns

Goes to given destination.

Declaration

public void GoToDestination(Destination destination)

Parameters

Goes to specified page.

Declaration

public void GoToPage(int pageNo)

Parameters

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate.

Declaration

protected override void OnApplyTemplate()

Overrides RadControl.OnApplyTemplate()

Called when current page is changed.

Declaration

protected void OnCurrentPageChanged(CurrentPageChangedEventArgs e)

Parameters

Called when the document is changed.

Declaration

protected virtual void OnDocumentChangedOverride(RadFixedDocument oldValue, RadFixedDocument newValue)

Parameters

Goes a page down.

Declaration

public void PageDown()

Goes a page up.

Declaration

public void PageUp()

Shows the PrintManager print UI obtained from the main Window of the current process.

The WinUI printing API is currently supported only on Windows 11.

Declaration

public void Print()

Registers the presenter.

Declaration

public void RegisterPresenter(string presenterName, IFixedDocumentPresenter presenter)

Parameters

Scrolls to horizontal offset.

Declaration

public void ScrollToHorizontalOffset(double offset)

Parameters

Implements IFixedDocumentViewer.ScrollToHorizontalOffset(double)

Scrolls to vertical offset.

Declaration

public void ScrollToVerticalOffset(double offset)

Parameters

Implements IFixedDocumentViewer.ScrollToVerticalOffset(double)

Creates selection from start position to end position.

Declaration

public void Select(TextPosition startPosition, TextPosition endPosition)

Parameters

Selects the specified range.

Declaration

public void Select(TextRange range)

Parameters

Sets the document source.

Declaration

protected virtual void SetDocumentSource(FixedDocumentStreamSource source)

Parameters

Sets the rotation angle.

Declaration

public void SetRotationAngle(RotationAngle rotationAngle)

Parameters

Occurs when annotation is clicked.

Declaration

public event EventHandler<AnnotationEventArgs> AnnotationClicked

Event Value

Occurs after the current page is changed.

Declaration

public event EventHandler<CurrentPageChangedEventArgs> CurrentPageChanged

Event Value

Occurs after the PDF document is changed.

Declaration

public event EventHandler<DocumentChangedEventArgs> DocumentChanged

Event Value

Implements IFixedDocumentViewer.DocumentChanged

Occurs after the fixed document presenter is changed.

Declaration

public event EventHandler FixedDocumentPresenterChanged

Event Value

Occurs when a hyperlink is clicked.

Declaration

public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked

Event Value

Implements IFixedDocumentViewer.HyperlinkClicked

Occurs when the mode is changed.

Declaration

public event EventHandler ModeChanged

Event Value

Occurs when the scale factor is changed.

Declaration

public event EventHandler<ScaleFactorChangedEventArgs> ScaleFactorChanged

Event Value

Implements IFixedDocumentViewer.ScaleFactorChanged

Occurs when the scale mode is changed.

Declaration

public event EventHandler ScaleModeChanged

Event Value