Class
FixedDocumentPresenterBase

Represents base document presenter class.

Definition

Namespace:Telerik.Windows.Documents.UI

Assembly:Telerik.Windows.Controls.FixedDocumentViewers.dll

Syntax:

cs-api-definition
public abstract class FixedDocumentPresenterBase : ContentControl, IFixedDocumentPresenter

Inheritance: objectFixedDocumentPresenterBase

Derived Classes: FixedDocumentPagesPresenterFixedDocumentSinglePageViewPresenter

Implements: IFixedDocumentPresenter

Constructors

FixedDocumentPresenterBase()

Initializes a new instance of the FixedDocumentPresenterBase class.

Declaration

cs-api-definition
public FixedDocumentPresenterBase()

Properties

CurrentPage

Gets the current page.

Declaration

cs-api-definition
public RadFixedPage CurrentPage { get; protected set; }

Property Value

RadFixedPage

The current page.

Implements IFixedDocumentPresenter.CurrentPage

CurrentPageNo

Gets the current page number.

Declaration

cs-api-definition
protected abstract int CurrentPageNo { get; }

Property Value

int

The current page number.

LayoutRoot

Gets the layout root.

Declaration

cs-api-definition
protected Canvas LayoutRoot { get; }

Property Value

Canvas

The layout root.

Owner

Gets the owner.

Declaration

cs-api-definition
public IFixedDocumentViewer Owner { get; }

Property Value

IFixedDocumentViewer

The owner.

Implements IFixedDocumentPresenter.Owner

PagesLayoutManager

Gets the pages layout manager.

Declaration

cs-api-definition
protected abstract PagesLayoutManagerBase PagesLayoutManager { get; }

Property Value

PagesLayoutManagerBase

The pages layout manager.

PointerHandlersController

Gets the mouse handlers controller.

Declaration

cs-api-definition
public PointerHandlersController PointerHandlersController { get; }

Property Value

PointerHandlersController

The mouse handlers controller.

Implements IFixedDocumentPresenter.PointerHandlersController

ReleasedPresenters

Gets the released presenters.

Declaration

cs-api-definition
protected Stack<FixedPagePresenter> ReleasedPresenters { get; }

Property Value

Stack<FixedPagePresenter>

The released presenters.

ShouldShowSelectionMarkers

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

Declaration

cs-api-definition
protected bool ShouldShowSelectionMarkers { get; }

Property Value

bool

The value indicating wheter the selection markes should be shown.

ViewportSize

Gets or sets the size of the viewport.

Declaration

cs-api-definition
protected Size ViewportSize { get; set; }

Property Value

Size

The size of the viewport.

VisiblePages

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

Declaration

cs-api-definition
protected IEnumerable<FixedPageLayoutInfo> VisiblePages { get; set; }

Property Value

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

cs-api-definition
public int VisiblePagesCacheOffset { get; set; }

Property Value

int

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

VisiblePresenters

Gets the visible presenters.

Declaration

cs-api-definition
protected Dictionary<int, FixedPagePresenter> VisiblePresenters { get; }

Property Value

Dictionary<int, FixedPagePresenter>

The visible presenters.

Methods

ArrangeOverride(Size)

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

Declaration

cs-api-definition
protected override Size ArrangeOverride(Size arrangeBounds)

Parameters

arrangeBounds

Size

The computed size that is used to arrange the content.

Returns

Size

The size of the control.

DoOnScaleFactorChangedOverride(double, double)

Does the on scale factor changed.

Declaration

cs-api-definition
protected virtual void DoOnScaleFactorChangedOverride(double oldScaleFactor, double newScaleFactor)

Parameters

oldScaleFactor

double

The old scale factor.

newScaleFactor

double

The new scale factor.

GetFocusedPresenter()

Gets the focused presenter.

Declaration

cs-api-definition
protected virtual FixedPagePresenter GetFocusedPresenter()

Returns

FixedPagePresenter

GetLocationFromViewPoint(Point, out RadFixedPage, out Point)

Gets the location from view point.

Declaration

cs-api-definition
public abstract bool GetLocationFromViewPoint(Point viewPoint, out RadFixedPage page, out Point location)

Parameters

viewPoint

Point

The view point.

page

RadFixedPage

The page.

location

Point

The location.

Returns

bool

Implements IFixedDocumentPresenter.GetLocationFromViewPoint(Point, out RadFixedPage, out Point)

GetPagePresenter(FixedPageLayoutInfo)

Gets the page presenter.

Declaration

cs-api-definition
protected virtual FixedPagePresenter GetPagePresenter(FixedPageLayoutInfo pageInfo)

Parameters

pageInfo

FixedPageLayoutInfo

The page info.

Returns

FixedPagePresenter

GetViewPointFromLocation(RadFixedPage, Point, out Point)

Gets the view point from location.

Declaration

cs-api-definition
public virtual bool GetViewPointFromLocation(RadFixedPage page, Point location, out Point viewPoint)

Parameters

page

RadFixedPage

The page.

location

Point

The location.

viewPoint

Point

The view point.

Returns

bool

Implements IFixedDocumentPresenter.GetViewPointFromLocation(RadFixedPage, Point, out Point)

GoToDestination(Destination)

Goes to destination.

Declaration

cs-api-definition
public virtual void GoToDestination(Destination destination)

Parameters

destination

Destination

The destination.

Implements IFixedDocumentPresenter.GoToDestination(Destination)

GoToPage(int)

Goes to page.

Declaration

cs-api-definition
public virtual void GoToPage(int pageNo)

Parameters

pageNo

int

The page no.

Implements IFixedDocumentPresenter.GoToPage(int)

HideSelectionMarkers()

Hides the selection markers.

Declaration

cs-api-definition
public virtual void HideSelectionMarkers()

Implements IFixedDocumentPresenter.HideSelectionMarkers()

Initialize(IFixedDocumentViewer)

Initializes the presenter.

Declaration

cs-api-definition
public virtual void Initialize(IFixedDocumentViewer owner)

Parameters

owner

IFixedDocumentViewer

The owner.

Implements IFixedDocumentPresenter.Initialize(IFixedDocumentViewer)

Initialize(IFixedDocumentViewer, IFixedDocumentPresenter)

Initializes the specified owner.

Declaration

cs-api-definition
public virtual void Initialize(IFixedDocumentViewer owner, IFixedDocumentPresenter presenter)

Parameters

owner

IFixedDocumentViewer

The owner.

presenter

IFixedDocumentPresenter

The presenter.

Implements IFixedDocumentPresenter.Initialize(IFixedDocumentViewer, IFixedDocumentPresenter)

OnCurrentPageChanged(RadFixedPage)

Called when current page is changed.

Declaration

cs-api-definition
protected void OnCurrentPageChanged(RadFixedPage page)

Parameters

page

RadFixedPage

The page.

OnLostMouseCapture(MouseEventArgs)

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

Declaration

cs-api-definition
protected override void OnLostMouseCapture(MouseEventArgs e)

Parameters

e

MouseEventArgs

A MouseEventArgs that contains the event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

e

MouseButtonEventArgs

The data for the event.

OnMouseLeftButtonUp(MouseButtonEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)

Parameters

e

MouseButtonEventArgs

The data for the event.

OnMouseMove(MouseEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnMouseMove(MouseEventArgs e)

Parameters

e

MouseEventArgs

The data for the event.

OnMouseWheel(MouseWheelEventArgs)

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

Declaration

cs-api-definition
protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

e

MouseWheelEventArgs

A MouseWheelEventArgs that contains the event data.

PageDown()

Goes page down.

Declaration

cs-api-definition
public virtual void PageDown()

Implements IFixedDocumentPresenter.PageDown()

PageUp()

Goes page up.

Declaration

cs-api-definition
public virtual void PageUp()

Implements IFixedDocumentPresenter.PageUp()

Release()

Releases the presenter.

Declaration

cs-api-definition
public virtual void Release()

Implements IFixedDocumentPresenter.Release()

ReleaseDocumentResourcesOverride()

Releases the document resources.

Declaration

cs-api-definition
protected virtual void ReleaseDocumentResourcesOverride()

ReleaseOverride()

Releases this instance override.

Declaration

cs-api-definition
protected virtual void ReleaseOverride()

ReleasePagePresenter(int)

Releases the page presenter.

Declaration

cs-api-definition
protected virtual void ReleasePagePresenter(int pageNo)

Parameters

pageNo

int

The page no.

ShowSelectionMarkers()

Shows the selection markers.

Declaration

cs-api-definition
public virtual void ShowSelectionMarkers()

Implements IFixedDocumentPresenter.ShowSelectionMarkers()

UpdatePresenterLayout()

Updates the presenter layout.

Declaration

cs-api-definition
public void UpdatePresenterLayout()

Implements IFixedDocumentPresenter.UpdatePresenterLayout()

UpdateScrollBars(Size)

Updates the scroll bars.

Declaration

cs-api-definition
protected void UpdateScrollBars(Size viewportSize)

Parameters

viewportSize

Size

Size of the viewport.

UpdateScrollOffsetFromPosition(TextPosition)

Updates the scroll offset from position.

Declaration

cs-api-definition
protected abstract void UpdateScrollOffsetFromPosition(TextPosition position)

Parameters

position

TextPosition

The position.

Events

CurrentPageChanged

Occurs when current page is changed.

Declaration

cs-api-definition
public event EventHandler<CurrentPageChangedEventArgs> CurrentPageChanged

Event Value

EventHandler<CurrentPageChangedEventArgs>

Implements IFixedDocumentPresenter.CurrentPageChanged