Class RadBook
RadBook is an ItemsControl that displays its items in the fashion of a regular book.
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll
Syntax
[TelerikToolboxCategory("Containers")]
public class RadBook : ItemsControl
Constructors
RadBook()
Fields
FirstPagePositionProperty
DependencyProperty for the FirstPagePosition property.
Declaration
public static readonly DependencyProperty FirstPagePositionProperty
Field Value
System.Windows.DependencyProperty
|
FlipDurationProperty
DependencyProperty for the FlipDuration property.
Declaration
public static readonly DependencyProperty FlipDurationProperty
Field Value
System.Windows.DependencyProperty
|
FoldActivatedEvent
RoutedEvent for the FoldActivated event.
Declaration
public static readonly RoutedEvent FoldActivatedEvent
Field Value
RoutedEvent
|
FoldDeactivatedEvent
RoutedEvent for the FoldDeactivated event.
Declaration
public static readonly RoutedEvent FoldDeactivatedEvent
Field Value
RoutedEvent
|
FoldHintPositionProperty
DependencyProperty for the DefaultActiveFoldPosition property.
Declaration
public static readonly DependencyProperty FoldHintPositionProperty
Field Value
System.Windows.DependencyProperty
|
FoldSizeProperty
DependencyProperty for the FoldSize property.
Declaration
public static readonly DependencyProperty FoldSizeProperty
Field Value
System.Windows.DependencyProperty
|
HardPagesProperty
Identifies the HardPages dependency property.
Declaration
public static readonly DependencyProperty HardPagesProperty
Field Value
System.Windows.DependencyProperty
|
IsKeyboardNavigationEnabledProperty
IsVirtualizingProperty
Identifies the IsVirtualizing dependency property. This property tells RadBook whether to reuse its item containers or not.
Declaration
public static readonly DependencyProperty IsVirtualizingProperty
Field Value
System.Windows.DependencyProperty
|
LeftPageTemplateProperty
DependencyProperty for the LeftPageTemplate property.
Declaration
public static readonly DependencyProperty LeftPageTemplateProperty
Field Value
System.Windows.DependencyProperty
|
LeftPageTemplateSelectorProperty
DependencyProperty for the LeftPageTemplateSelector property.
Declaration
public static readonly DependencyProperty LeftPageTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty
|
PageChangedEvent
RoutedEvent for the PageChanged event.
Declaration
public static readonly RoutedEvent PageChangedEvent
Field Value
RoutedEvent
|
PageFlipEndedEvent
RoutedEvent for the PageFlipEnded event.
Declaration
public static readonly RoutedEvent PageFlipEndedEvent
Field Value
RoutedEvent
|
PageFlipModeProperty
DependencyProperty for the PageFlipMode property.
Declaration
public static readonly DependencyProperty PageFlipModeProperty
Field Value
System.Windows.DependencyProperty
|
PageFlipStartedEvent
RoutedEvent for the PreviewPageFlipStarted event.
Declaration
public static readonly RoutedEvent PageFlipStartedEvent
Field Value
RoutedEvent
|
PreviewPageFlipStartedEvent
RoutedEvent for the PreviewPageFlipStarted event.
Declaration
public static readonly RoutedEvent PreviewPageFlipStartedEvent
Field Value
RoutedEvent
|
RightPageIndexProperty
DependencyProperty for the RightPageIndex property.
Declaration
public static readonly DependencyProperty RightPageIndexProperty
Field Value
System.Windows.DependencyProperty
|
RightPageTemplateProperty
DependencyProperty for the RightPageTemplate property.
Declaration
public static readonly DependencyProperty RightPageTemplateProperty
Field Value
System.Windows.DependencyProperty
|
RightPageTemplateSelectorProperty
DependencyProperty for theRightPageTemplateSelector property.
Declaration
public static readonly DependencyProperty RightPageTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty
|
ShowPageFoldProperty
DependencyProperty for the ShowPageFold property.
Declaration
public static readonly DependencyProperty ShowPageFoldProperty
Field Value
System.Windows.DependencyProperty
|
Properties
FirstPagePosition
Gets or sets the position the first page - left or right, with respect to the book.
Declaration
public PagePosition FirstPagePosition { get; set; }
Property Value
PagePosition
|
FlipDuration
Gets or sets the amount of time necessary to flip a page.
Declaration
public TimeSpan FlipDuration { get; set; }
Property Value
System.TimeSpan
|
FoldHintPosition
Gets or sets the starting fold when turning the page programmatically or when ShowPageFold is set to OnPageEnter.
Declaration
public FoldHintPosition FoldHintPosition { get; set; }
Property Value
FoldHintPosition
|
FoldSize
Gets or sets the size of the page fold.
Declaration
public Size FoldSize { get; set; }
Property Value
System.Windows.Size
|
HardPages
Gets or sets the HardPages property.
Declaration
public HardPages HardPages { get; set; }
Property Value
HardPages
|
IsKeyboardNavigationEnabled
IsVirtualizing
Gets or sets the IsVirtualizing property. This property tells RadBook whether to reuse its item containers or not.
Declaration
public bool IsVirtualizing { get; set; }
Property Value
System.Boolean
|
LeftPageTemplate
Gets or sets the template for a left page.
Declaration
public DataTemplate LeftPageTemplate { get; set; }
Property Value
System.Windows.DataTemplate
The left page template. |
LeftPageTemplateSelector
Gets or sets the left page template selector.
Declaration
public DataTemplateSelector LeftPageTemplateSelector { get; set; }
Property Value
DataTemplateSelector
|
PagedItems
Gets or sets the paged items.
Declaration
public IPagedCollectionView PagedItems { get; set; }
Property Value
System.ComponentModel.IPagedCollectionView
The paged items. |
PageFlipMode
Gets or sets the fashion (None, SingleClick or DoubleClick) in which the pages turn.
Declaration
public PageFlipMode PageFlipMode { get; set; }
Property Value
PageFlipMode
|
RightPageIndex
Gets or sets the index of the right page in the book.
Declaration
public int RightPageIndex { get; set; }
Property Value
System.Int32
|
RightPageTemplate
Gets or sets the template for a right page.
Declaration
public DataTemplate RightPageTemplate { get; set; }
Property Value
System.Windows.DataTemplate
The right page template. |
RightPageTemplateSelector
Gets or sets the right page template selector.
Declaration
public DataTemplateSelector RightPageTemplateSelector { get; set; }
Property Value
DataTemplateSelector
|
ShowPageFold
Gets or sets whether and when a fold will be displayed.
Declaration
public PageFoldVisibility ShowPageFold { get; set; }
Property Value
PageFoldVisibility
|
Methods
add_PageChanged(RadRoutedEventHandler)
Declaration
public void add_PageChanged(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
ClearContainerForItemOverride(DependencyObject, Object)
Override for ClearContainerForItem.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject
element
|
System.Object
item
|
ConvertPageToSheetIndex(Int32, PagePosition)
Converts a page index to a sheet index.
Declaration
public static int ConvertPageToSheetIndex(int rightPageIndex, PagePosition firstPagePosition)
Parameters
System.Int32
rightPageIndex
The RightPageIndex of the book. |
PagePosition
firstPagePosition
The position of the first page in the book. |
Returns
System.Int32
|
ConvertSheetToPageIndex(Int32, PagePosition, Int32)
Converts the index of the sheet to page.
Declaration
public static int ConvertSheetToPageIndex(int sheetIndex, PagePosition fistPagePosition, int totalItemsCount)
Parameters
System.Int32
sheetIndex
Index of the sheet. |
PagePosition
fistPagePosition
The fist page position of the book. |
System.Int32
totalItemsCount
The total number of items in the book. |
Returns
System.Int32
|
FirstPage()
Navigates to the first page.
Declaration
public void FirstPage()
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject
The element that is used to display the given item. |
IsItemItsOwnContainerOverride(Object)
Determines if the specified item is (or is eligible to be) its own container.
Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
System.Object
item
|
Returns
System.Boolean
|
LastPage()
Navigates to the last page.
Declaration
public void LastPage()
NextPage()
Navigates to the next page.
Declaration
public void NextPage()
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.
Declaration
public override void OnApplyTemplate()
Overrides
OnCreateAutomationPeer()
When implemented in a derived class, returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Silverlight automation infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer
The class-specific System.Windows.Automation.Peers.AutomationPeer subclass to return. |
OnFoldActivated(FoldEventArgs)
Raises the FoldActivated event.
Declaration
protected virtual void OnFoldActivated(FoldEventArgs e)
Parameters
FoldEventArgs
e
The FoldEventArgs instance containing the event data. |
OnFoldDeactivated(FoldEventArgs)
Raises the FoldDeactivated event.
Declaration
protected virtual void OnFoldDeactivated(FoldEventArgs e)
Parameters
FoldEventArgs
e
The FoldEventArgs instance containing the event data. |
OnItemsChanged(NotifyCollectionChangedEventArgs)
Called when the value of the System.Windows.Controls.ItemsControl.Items property changes.
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs
e
A System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data. |
Overrides
OnKeyDown(KeyEventArgs)
Called before the System.Windows.UIElement.KeyDown event occurs.
Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs
e
The data for the event. |
OnPageChanged(RadRoutedEventArgs)
Called when a page is changed. Raises PageChanged event.
Declaration
protected virtual void OnPageChanged(RadRoutedEventArgs e)
Parameters
RadRoutedEventArgs
e
|
OnPageFlipEnded(PageFlipEventArgs)
Called when a page flips. Raises PageFlipped event.
Declaration
protected virtual void OnPageFlipEnded(PageFlipEventArgs e)
Parameters
PageFlipEventArgs
e
|
OnPageFlipStarted(PageFlipEventArgs)
Raises the PageFlipStarted event.
Declaration
protected virtual void OnPageFlipStarted(PageFlipEventArgs e)
Parameters
PageFlipEventArgs
e
The PageFlipEventArgs instance containing the event data. |
OnPreviewPageFlipStarted(PageFlipEventArgs)
Raises the PreviewPageFlipStarted event.
Declaration
protected virtual void OnPreviewPageFlipStarted(PageFlipEventArgs e)
Parameters
PageFlipEventArgs
e
The PageFlipEventArgs instance containing the event data. |
PrepareContainerForItemOverride(DependencyObject, Object)
Prepares the specified element to display the specified item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject
element
Element used to display the specified item. |
System.Object
item
Specified item. |
Overrides
PreviousPage()
Navigates to the previous page.
Declaration
public void PreviousPage()
remove_PageChanged(RadRoutedEventHandler)
Declaration
public void remove_PageChanged(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler
value
|
Events
FoldActivated
Occurs when mouse enters any of the four corners of the book.
Declaration
public event EventHandler<FoldEventArgs> FoldActivated
Event Type
System.EventHandler<FoldEventArgs>
|
FoldDeactivated
Occurs when mouse leaves any of the four corners of the book.
Declaration
public event EventHandler<FoldEventArgs> FoldDeactivated
Event Type
System.EventHandler<FoldEventArgs>
|
PageChanged
Occurs when a full page flip occurs.
Declaration
public event RadRoutedEventHandler PageChanged
Event Type
RadRoutedEventHandler
|
PageFlipEnded
Occurs when page has finished dragging.
Declaration
public event EventHandler<PageFlipEventArgs> PageFlipEnded
Event Type
System.EventHandler<PageFlipEventArgs>
|
PageFlipStarted
Occurs when page is dragged.
Declaration
public event EventHandler<PageFlipEventArgs> PageFlipStarted
Event Type
System.EventHandler<PageFlipEventArgs>
|
PreviewPageFlipStarted
Occurs when page is about to get dragged.
Declaration
public event EventHandler<PageFlipEventArgs> PreviewPageFlipStarted
Event Type
System.EventHandler<PageFlipEventArgs>
|