ClassFixedDocumentPresenterBase
Represents base document presenter class.
Definition
Namespace:Telerik.Windows.Documents.UI
Assembly:Telerik.Windows.Controls.FixedDocumentViewers.dll
Syntax:
public abstract class FixedDocumentPresenterBase : ContentControl, IFixedDocumentPresenter
Inheritance: objectFixedDocumentPresenterBase
Derived Classes:
Implements:
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
RadFixedPage
The current page.
Implements
CurrentPageNo
Gets the current page number.
Declaration
protected abstract int CurrentPageNo { get; }
Property Value
The current page number.
LayoutRoot
Gets the layout root.
Declaration
protected Canvas LayoutRoot { get; }
Property Value
Canvas
The layout root.
Owner
Gets the owner.
Declaration
public IFixedDocumentViewer Owner { get; }
Property Value
The owner.
Implements
PagesLayoutManager
Gets the pages layout manager.
Declaration
protected abstract PagesLayoutManagerBase PagesLayoutManager { get; }
Property Value
The pages layout manager.
PointerHandlersController
Gets the mouse handlers controller.
Declaration
public PointerHandlersController PointerHandlersController { get; }
Property Value
The mouse handlers controller.
Implements
ReleasedPresenters
Gets the released presenters.
Declaration
protected Stack<FixedPagePresenter> ReleasedPresenters { get; }
Property Value
The released presenters.
ShouldShowSelectionMarkers
Gets or sets the value indicating wheter the selection markes should be shown.
Declaration
protected bool ShouldShowSelectionMarkers { get; }
Property Value
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
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
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
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
Dictionary<int, FixedPagePresenter>
The visible presenters.
Methods
ArrangeOverride(Size)
Called to arrange and size the content of a Control object.
Declaration
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.
GetFocusedPresenter()
Gets the focused presenter.
Declaration
protected virtual FixedPagePresenter GetFocusedPresenter()
Returns
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
viewPoint
Point
The view point.
page
RadFixedPage
The page.
location
Point
The location.
Returns
Implements
GetPagePresenter(FixedPageLayoutInfo)
Gets the page presenter.
Declaration
protected virtual FixedPagePresenter GetPagePresenter(FixedPageLayoutInfo pageInfo)
Parameters
pageInfo
The page info.
Returns
GetViewPointFromLocation(RadFixedPage, Point, out Point)
Gets the view point from location.
Declaration
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
Implements
GoToDestination(Destination)
Goes to destination.
Declaration
public virtual void GoToDestination(Destination destination)
Parameters
destination
Destination
The destination.
Implements
GoToPage(int)
Goes to page.
Declaration
public virtual void GoToPage(int pageNo)
Parameters
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
owner
The owner.
Implements
Initialize(IFixedDocumentViewer, IFixedDocumentPresenter)
Initializes the specified owner.
Declaration
public virtual void Initialize(IFixedDocumentViewer owner, IFixedDocumentPresenter presenter)
Parameters
owner
The owner.
presenter
The presenter.
Implements
OnCurrentPageChanged(RadFixedPage)
Called when current page is changed.
Declaration
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
protected override void OnLostMouseCapture(MouseEventArgs e)
Parameters
e
MouseEventArgs
A MouseEventArgs that contains the event data.
OnMouseLeftButtonDown(MouseButtonEventArgs)
Called before the event occurs.
Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
e
MouseButtonEventArgs
The data for the event.
OnMouseLeftButtonUp(MouseButtonEventArgs)
Called before the event occurs.
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
e
MouseButtonEventArgs
The data for the event.
OnMouseMove(MouseEventArgs)
Called before the event occurs.
Declaration
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
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
e
MouseWheelEventArgs
A MouseWheelEventArgs that contains the event data.
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(int)
Releases the page presenter.
Declaration
protected virtual void ReleasePagePresenter(int pageNo)
Parameters
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
viewportSize
Size
Size of the viewport.
UpdateScrollOffsetFromPosition(TextPosition)
Updates the scroll offset from position.
Declaration
protected abstract void UpdateScrollOffsetFromPosition(TextPosition position)
Parameters
position
TextPosition
The position.
Events
CurrentPageChanged
Occurs when current page is changed.
Declaration
public event EventHandler<CurrentPageChangedEventArgs> CurrentPageChanged
Event Value
Implements