Class RadBook
RadBook is an ItemsControl that displays its items in the fashion of a regular book.
Inheritance
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll
Syntax
[TelerikToolboxCategory("Containers")]
[Themable]
public class RadBook : ItemsControl, IThemableConstructors
RadBook()
Fields
FirstPagePositionProperty
DependencyProperty for the FirstPagePosition property.
Declaration
public static readonly DependencyProperty FirstPagePositionPropertyField Value
|
System.
|
FlipDurationProperty
DependencyProperty for the FlipDuration property.
Declaration
public static readonly DependencyProperty FlipDurationPropertyField Value
|
System.
|
FoldActivatedEvent
RoutedEvent for the FoldActivated event.
Declaration
public static readonly RoutedEvent FoldActivatedEventField Value
|
System.
|
FoldDeactivatedEvent
RoutedEvent for the FoldDeactivated event.
Declaration
public static readonly RoutedEvent FoldDeactivatedEventField Value
|
System.
|
FoldHintPositionProperty
DependencyProperty for the DefaultActiveFoldPosition property.
Declaration
public static readonly DependencyProperty FoldHintPositionPropertyField Value
|
System.
|
FoldSizeProperty
DependencyProperty for the FoldSize property.
Declaration
public static readonly DependencyProperty FoldSizePropertyField Value
|
System.
|
HardPagesProperty
Identifies the HardPages dependency property.
Declaration
public static readonly DependencyProperty HardPagesPropertyField Value
|
System.
|
IsKeyboardNavigationEnabledProperty
IsVirtualizingProperty
Identifies the IsVirtualizing dependency property. This property tells RadBook whether to reuse its item containers or not.
Declaration
public static readonly DependencyProperty IsVirtualizingPropertyField Value
|
System.
|
LeftPageTemplateProperty
DependencyProperty for the LeftPageTemplate property.
Declaration
public static readonly DependencyProperty LeftPageTemplatePropertyField Value
|
System.
|
LeftPageTemplateSelectorProperty
DependencyProperty for the LeftPageTemplateSelector property.
Declaration
public static readonly DependencyProperty LeftPageTemplateSelectorPropertyField Value
|
System.
|
PageChangedEvent
RoutedEvent for the PageChanged event.
Declaration
public static readonly RoutedEvent PageChangedEventField Value
|
System.
|
PageFlipEndedEvent
RoutedEvent for the PageFlipEnded event.
Declaration
public static readonly RoutedEvent PageFlipEndedEventField Value
|
System.
|
PageFlipModeProperty
DependencyProperty for the PageFlipMode property.
Declaration
public static readonly DependencyProperty PageFlipModePropertyField Value
|
System.
|
PageFlipStartedEvent
RoutedEvent for the PreviewPageFlipStarted event.
Declaration
public static readonly RoutedEvent PageFlipStartedEventField Value
|
System.
|
PreviewPageFlipStartedEvent
RoutedEvent for the PreviewPageFlipStarted event.
Declaration
public static readonly RoutedEvent PreviewPageFlipStartedEventField Value
|
System.
|
RightPageIndexProperty
DependencyProperty for the RightPageIndex property.
Declaration
public static readonly DependencyProperty RightPageIndexPropertyField Value
|
System.
|
RightPageTemplateProperty
DependencyProperty for the RightPageTemplate property.
Declaration
public static readonly DependencyProperty RightPageTemplatePropertyField Value
|
System.
|
RightPageTemplateSelectorProperty
DependencyProperty for theRightPageTemplateSelector property.
Declaration
public static readonly DependencyProperty RightPageTemplateSelectorPropertyField Value
|
System.
|
ShowPageFoldProperty
DependencyProperty for the ShowPageFold property.
Declaration
public static readonly DependencyProperty ShowPageFoldPropertyField Value
|
System.
|
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
FlipDuration
Gets or sets the amount of time necessary to flip a page.
Declaration
public TimeSpan FlipDuration { get; set; }Property Value
|
System.
|
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
FoldSize
Gets or sets the size of the page fold.
Declaration
public Size FoldSize { get; set; }Property Value
|
System.
|
HardPages
Gets or sets the HardPages property.
Declaration
public HardPages HardPages { get; set; }Property Value
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.
|
LeftPageTemplate
Gets or sets the template for a left page.
Declaration
public DataTemplate LeftPageTemplate { get; set; }Property Value
|
System. The left page template. |
LeftPageTemplateSelector
Gets or sets the left page template selector.
Declaration
public DataTemplateSelector LeftPageTemplateSelector { get; set; }Property Value
|
System.
|
PagedItems
Gets or sets the paged items.
Declaration
public IPagedCollectionView PagedItems { get; set; }Property Value
|
IPaged 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
RightPageIndex
Gets or sets the index of the right page in the book.
Declaration
public int RightPageIndex { get; set; }Property Value
|
System.
|
RightPageTemplate
Gets or sets the template for a right page.
Declaration
public DataTemplate RightPageTemplate { get; set; }Property Value
|
System. The right page template. |
RightPageTemplateSelector
Gets or sets the right page template selector.
Declaration
public DataTemplateSelector RightPageTemplateSelector { get; set; }Property Value
|
System.
|
ShowPageFold
Gets or sets whether and when a fold will be displayed.
Declaration
public PageFoldVisibility ShowPageFold { get; set; }Property Value
Methods
add_PageChanged(RadRoutedEventHandler)
Declaration
public void add_PageChanged(RadRoutedEventHandler value)Parameters
|
Rad
|
ClearContainerForItemOverride(DependencyObject, Object)
Override for ClearContainerForItem.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)Parameters
|
System.
|
|
System.
|
ConvertPageToSheetIndex(Int32, PagePosition)
Converts a page index to a sheet index.
Declaration
public static int ConvertPageToSheetIndex(int rightPageIndex, PagePosition firstPagePosition)Parameters
|
System. The RightPageIndex of the book. |
|
Page The position of the first page in the book. |
Returns
|
System.
|
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. Index of the sheet. |
|
Page The fist page position of the book. |
|
System. The total number of items in the book. |
Returns
|
System.
|
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. 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.
|
Returns
|
System.
|
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.
Declaration
public override void OnApplyTemplate()OnCreateAutomationPeer()
When implemented in a derived class, returns class-specific System.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
|
System. The class-specific System. |
OnFoldActivated(FoldEventArgs)
Raises the Fold
Declaration
protected virtual void OnFoldActivated(FoldEventArgs e)Parameters
|
Fold The Fold |
OnFoldDeactivated(FoldEventArgs)
Raises the Fold
Declaration
protected virtual void OnFoldDeactivated(FoldEventArgs e)Parameters
|
Fold The Fold |
OnInitialized(EventArgs)
Raises the System.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
|
System. The System. |
OnItemsChanged(NotifyCollectionChangedEventArgs)
Called when the value of the System.
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)Parameters
|
System. A System. |
OnKeyDown(KeyEventArgs)
Called before the System.
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
|
System. The data for the event. |
OnPageChanged(RadRoutedEventArgs)
Called when a page is changed. Raises PageChanged event.
Declaration
protected virtual void OnPageChanged(RadRoutedEventArgs e)Parameters
OnPageFlipEnded(PageFlipEventArgs)
Called when a page flips. Raises PageFlipped event.
Declaration
protected virtual void OnPageFlipEnded(PageFlipEventArgs e)Parameters
OnPageFlipStarted(PageFlipEventArgs)
Raises the Page
Declaration
protected virtual void OnPageFlipStarted(PageFlipEventArgs e)Parameters
|
Page The Page |
OnPreviewPageFlipStarted(PageFlipEventArgs)
Raises the Preview
Declaration
protected virtual void OnPreviewPageFlipStarted(PageFlipEventArgs e)Parameters
|
Page The Page |
PrepareContainerForItemOverride(DependencyObject, Object)
Prepares the specified element to display the specified item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)Parameters
|
System. Element used to display the specified item. |
|
System. Specified item. |
PreviousPage()
Navigates to the previous page.
Declaration
public void PreviousPage()remove_PageChanged(RadRoutedEventHandler)
Declaration
public void remove_PageChanged(RadRoutedEventHandler value)Parameters
|
Rad
|
ResetTheme()
Resets the theme.
Declaration
public void ResetTheme()Events
FoldActivated
Occurs when mouse enters any of the four corners of the book.
Declaration
public event EventHandler<FoldEventArgs> FoldActivatedEvent Type
|
System.
|
FoldDeactivated
Occurs when mouse leaves any of the four corners of the book.
Declaration
public event EventHandler<FoldEventArgs> FoldDeactivatedEvent Type
|
System.
|
PageChanged
Occurs when a full page flip occurs.
Declaration
public event RadRoutedEventHandler PageChangedEvent Type
PageFlipEnded
Occurs when page has finished dragging.
Declaration
public event EventHandler<PageFlipEventArgs> PageFlipEndedEvent Type
|
System.
|
PageFlipStarted
Occurs when page is dragged.
Declaration
public event EventHandler<PageFlipEventArgs> PageFlipStartedEvent Type
|
System.
|
PreviewPageFlipStarted
Occurs when page is about to get dragged.
Declaration
public event EventHandler<PageFlipEventArgs> PreviewPageFlipStartedEvent Type
|
System.
|