Class FixedDocumentPresenterBase

Represents base document presenter class.

Inheritance
System.Object
FixedDocumentPresenterBase
FixedDocumentPagesPresenter
FixedDocumentSinglePageViewPresenter
Namespace: Telerik.Windows.Documents.UI
Assembly: Telerik.Windows.Controls.FixedDocumentViewers.dll

Syntax

public abstract class FixedDocumentPresenterBase : ContentControl, IFixedDocumentPresenter

Constructors

FixedDocumentPresenterBase()

Initializes a new instance of the FixedDocumentPresenterBase class.

Declaration
public FixedDocumentPresenterBase()

Properties

CurrentPage

Gets the current page.

Declaration
public RadFixedPage CurrentPage { get; protected set; }
Property Value
Telerik.Windows.Documents.Fixed.Model.RadFixedPage

The current page.
Implements

CurrentPageNo

Gets the current page number.

Declaration
protected abstract int CurrentPageNo { get; }
Property Value
System.Int32

The current page number.

LayoutRoot

Gets the layout root.

Declaration
protected Canvas LayoutRoot { get; }
Property Value
System.Windows.Controls.Canvas

The layout root.

Owner

Gets the owner.

Declaration
public IFixedDocumentViewer Owner { get; }
Property Value
IFixedDocumentViewer

The owner.
Implements

PagesLayoutManager

Gets the pages layout manager.

Declaration
protected abstract PagesLayoutManagerBase PagesLayoutManager { get; }
Property Value
PagesLayoutManagerBase

The pages layout manager.

PointerHandlersController

Gets the mouse handlers controller.

Declaration
public PointerHandlersController PointerHandlersController { get; }
Property Value
PointerHandlersController

The mouse handlers controller.
Implements

ReleasedPresenters

Gets the released presenters.

Declaration
protected Stack<FixedPagePresenter> ReleasedPresenters { get; }
Property Value
System.Collections.Generic.Stack<FixedPagePresenter>

The released presenters.

ShouldShowSelectionMarkers

Gets or sets the value indicating wheter the selection markes should be shown.

Declaration
protected bool ShouldShowSelectionMarkers { get; }
Property Value
System.Boolean

The value indicating wheter the selection markes should be shown.

ViewportSize

Gets or sets the size of the viewport.

Declaration
protected Size ViewportSize { get; set; }
Property Value
System.Windows.Size

The size of the viewport.

VisiblePages

Gets or sets the visible pages. Setting this property ensures that visible pages content is loaded.

Declaration
protected IEnumerable<FixedPageLayoutInfo> VisiblePages { get; set; }
Property Value
System.Collections.Generic.IEnumerable<FixedPageLayoutInfo>

The visible pages.

VisiblePagesCacheOffset

Defines the amount of pages to be cached before and after the visible ones. The default value is one.

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

The amount of pages to cache before and after the visible ones. The default value is one.

VisiblePresenters

Gets the visible presenters.

Declaration
protected Dictionary<int, FixedPagePresenter> VisiblePresenters { get; }
Property Value
System.Collections.Generic.Dictionary<System.Int32, FixedPagePresenter>

The visible presenters.

Methods

ArrangeOverride(Size)

Called to arrange and size the content of a System.Windows.Controls.Control object.

Declaration
protected override Size ArrangeOverride(Size arrangeBounds)
Parameters
System.Windows.Size arrangeBounds

The computed size that is used to arrange the content.
Returns
System.Windows.Size

The size of the control.

DoOnScaleFactorChangedOverride(Double, Double)

Does the on scale factor changed.

Declaration
protected virtual void DoOnScaleFactorChangedOverride(double oldScaleFactor, double newScaleFactor)
Parameters
System.Double oldScaleFactor

The old scale factor.
System.Double newScaleFactor

The new scale factor.

GetFocusedPresenter()

Gets the focused presenter.

Declaration
protected virtual FixedPagePresenter GetFocusedPresenter()
Returns
FixedPagePresenter

GetLocationFromViewPoint(Point, out RadFixedPage, out Point)

Gets the location from view point.

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

The view point.
Telerik.Windows.Documents.Fixed.Model.RadFixedPage page

The page.
System.Windows.Point location

The location.
Returns
System.Boolean

Implements

GetPagePresenter(FixedPageLayoutInfo)

Gets the page presenter.

Declaration
protected virtual FixedPagePresenter GetPagePresenter(FixedPageLayoutInfo pageInfo)
Parameters
FixedPageLayoutInfo pageInfo

The page info.
Returns
FixedPagePresenter

GetViewPointFromLocation(RadFixedPage, Point, out Point)

Gets the view point from location.

Declaration
public virtual bool GetViewPointFromLocation(RadFixedPage page, Point location, out Point viewPoint)
Parameters
Telerik.Windows.Documents.Fixed.Model.RadFixedPage page

The page.
System.Windows.Point location

The location.
System.Windows.Point viewPoint

The view point.
Returns
System.Boolean

Implements

GoToDestination(Destination)

Goes to destination.

Declaration
public virtual void GoToDestination(Destination destination)
Parameters
Telerik.Windows.Documents.Fixed.Model.Navigation.Destination destination

The destination.
Implements

GoToPage(Int32)

Goes to page.

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

The page no.
Implements

HideSelectionMarkers()

Hides the selection markers.

Declaration
public virtual void HideSelectionMarkers()
Implements

Initialize(IFixedDocumentViewer)

Initializes the presenter.

Declaration
public virtual void Initialize(IFixedDocumentViewer owner)
Parameters
IFixedDocumentViewer owner

The owner.
Implements

Initialize(IFixedDocumentViewer, IFixedDocumentPresenter)

Initializes the specified owner.

Declaration
public virtual void Initialize(IFixedDocumentViewer owner, IFixedDocumentPresenter presenter)
Parameters
IFixedDocumentViewer owner

The owner.
IFixedDocumentPresenter presenter

The presenter.
Implements

OnCurrentPageChanged(RadFixedPage)

Called when current page is changed.

Declaration
protected void OnCurrentPageChanged(RadFixedPage page)
Parameters
Telerik.Windows.Documents.Fixed.Model.RadFixedPage page

The page.

OnLostMouseCapture(MouseEventArgs)

Called before the System.Windows.UIElement.LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate.

Declaration
protected override void OnLostMouseCapture(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

A System.Windows.Input.MouseEventArgs that contains the event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Called before the System.Windows.UIElement.MouseLeftButtonDown event occurs.

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The data for the event.

OnMouseLeftButtonUp(MouseButtonEventArgs)

Called before the System.Windows.UIElement.MouseLeftButtonUp event occurs.

Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The data for the event.

OnMouseMove(MouseEventArgs)

Called before the System.Windows.UIElement.MouseMove event occurs.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The data for the event.

OnMouseWheel(MouseWheelEventArgs)

Called before the System.Windows.UIElement.MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate.

Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
System.Windows.Input.MouseWheelEventArgs e

A System.Windows.Input.MouseWheelEventArgs that contains the event data.

PageDown()

Goes page down.

Declaration
public virtual void PageDown()
Implements

PageUp()

Goes page up.

Declaration
public virtual void PageUp()
Implements

Release()

Releases the presenter.

Declaration
public virtual void Release()
Implements

ReleaseDocumentResourcesOverride()

Releases the document resources.

Declaration
protected virtual void ReleaseDocumentResourcesOverride()

ReleaseOverride()

Releases this instance override.

Declaration
protected virtual void ReleaseOverride()

ReleasePagePresenter(Int32)

Releases the page presenter.

Declaration
protected virtual void ReleasePagePresenter(int pageNo)
Parameters
System.Int32 pageNo

The page no.

ShowSelectionMarkers()

Shows the selection markers.

Declaration
public virtual void ShowSelectionMarkers()
Implements

UpdatePresenterLayout()

Updates the presenter layout.

Declaration
public void UpdatePresenterLayout()
Implements

UpdateScrollBars(Size)

Updates the scroll bars.

Declaration
protected void UpdateScrollBars(Size viewportSize)
Parameters
System.Windows.Size viewportSize

Size of the viewport.

UpdateScrollOffsetFromPosition(TextPosition)

Updates the scroll offset from position.

Declaration
protected abstract void UpdateScrollOffsetFromPosition(TextPosition position)
Parameters
Telerik.Windows.Documents.Fixed.Text.TextPosition position

The position.

Events

CurrentPageChanged

Occurs when current page is changed.

Declaration
public event EventHandler<CurrentPageChangedEventArgs> CurrentPageChanged
Event Type
System.EventHandler<CurrentPageChangedEventArgs>

Implements

Explicit Interface Implementations

IFixedDocumentPresenter.InvalidateArrange()

Declaration
void IFixedDocumentPresenter.InvalidateArrange()
Implements

IFixedDocumentPresenter.InvalidateMeasure()

Declaration
void IFixedDocumentPresenter.InvalidateMeasure()
Implements

Extension Methods