ClassBaseNavigationElement
Definition
Namespace:Telerik.WinControls.UI.Navigation
Assembly:Telerik.WinControls.UI.dll
Syntax:
public abstract class BaseNavigationElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementBaseNavigationElement
Derived Classes:
Implements:
Inherited Members
Constructors
BaseNavigationElement()
Declaration
protected BaseNavigationElement()
Properties
AllowAnimation
Gets or sets a value indicating whether to use animation when changing its state.
AnimationEasingType
Gets or sets the animation easing type.
Declaration
public RadEasingType AnimationEasingType { get; set; }
Property Value
AnimationFrames
Gets or sets the animation frames.
AnimationInterval
Gets or sets the animation interval.
AutoHideButtonsDelay
Determines how long it takes to the navigation buttons to be hidden after the mouse leaves the control(in milliseconds). Used only when the ButtonsVisibility is VisibleOnMouseOver.
BindingSource
Gets or sets the binding source.
Declaration
public BindingSource BindingSource { get; set; }
Property Value
The binding source.
ButtonsVisibility
Determines whether and how to display the navigation buttons.
Declaration
public virtual ButtonsVisibility ButtonsVisibility { get; set; }
Property Value
ContentElement
Gets the content element.
Declaration
public virtual LightVisualElement ContentElement { get; protected set; }
Property Value
The content element.
IsAnimating
Gets a value indicating whether the control is currently animating.
Declaration
[Browsable(false)]
public bool IsAnimating { get; }
Property Value
IsInfiniteScrollingEnabled
Gets or sets a value indicating whether infinite scrolling from last to first item and vice versa is enabled.
Declaration
public bool IsInfiniteScrollingEnabled { get; set; }
Property Value
LayoutPanel
Gets the navigation element layout.
Declaration
public NavigationElementLayout LayoutPanel { get; }
Property Value
The navigation element layout.
NextButton
Gets the next button.
Declaration
public NavigationButtonElement NextButton { get; }
Property Value
The next button.
NumberOfPages
Gets or sets the number of pages.IfBindingSource is set, this property returns theCount.
Orientation
Gets or sets a value indicating how to orient the navigation buttons - horizontally or vertically.
Declaration
public Orientation Orientation { get; set; }
Property Value
PreviousButton
Gets the previous button.
Declaration
public NavigationButtonElement PreviousButton { get; }
Property Value
The previous button.
SelectedIndex
Gets or sets the index of the selected item.
Methods
AttachButtonEvents()
Attaches the events.
Declaration
protected virtual void AttachButtonEvents()
BindingSource_ListChanged(object, ListChangedEventArgs)
Declaration
protected virtual void BindingSource_ListChanged(object sender, ListChangedEventArgs e)
Parameters
sender
e
CanSelectNext()
Determines whether moving to next item is possible.
CanSelectPrevious()
Determines whether moving to previous item is possible.
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
CreateContentElement()
Declaration
protected abstract LightVisualElement CreateContentElement()
Returns
CreateLayoutPanel()
Declaration
protected virtual NavigationElementLayout CreateLayoutPanel()
Returns
CreateNextPageButton()
Declaration
protected virtual NavigationButtonElement CreateNextPageButton()
Returns
CreatePreviousPageButton()
Declaration
protected virtual NavigationButtonElement CreatePreviousPageButton()
Returns
DetachButtonEvents()
Unwires the buttons and text box events.
Declaration
protected virtual void DetachButtonEvents()
DisposeManagedResources()
Disposes of managed resources including cached images and SVG images when the element is being disposed.
Declaration
protected override void DisposeManagedResources()
Overrides
GetNextIndex()
Returns the next index taking into account whether infinite looping is enabled.
GetPreviousIndex()
Returns the previous index taking into account whether infinite looping is enabled.
InitializeFields()
Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.
Declaration
protected override void InitializeFields()
Overrides
NextButton_Click(object, EventArgs)
Handles the Click event of the NextButton.
OnAnimationFinished(AnimationStatusEventArgs)
Declaration
protected virtual void OnAnimationFinished(AnimationStatusEventArgs e)
Parameters
e
OnAnimationStarted(AnimationStatusEventArgs)
Declaration
protected virtual void OnAnimationStarted(AnimationStatusEventArgs e)
Parameters
e
OnBindingSourceChanged()
Declaration
protected virtual void OnBindingSourceChanged()
OnBindingSourceListChanged()
Declaration
protected virtual void OnBindingSourceListChanged()
OnKeyDown(KeyEventArgs)
Raises the KeyDown event.
Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
e
The key event arguments.
Overrides
OnLoaded()
Called when the element has been successfully loaded. That includes loading of all its children as well.
Declaration
protected override void OnLoaded()
Overrides
OnMouseEnter()
Declaration
protected virtual void OnMouseEnter()
OnMouseLeave()
Declaration
protected virtual void OnMouseLeave()
OnMouseWheel(MouseEventArgs)
Raises the MouseWheel event.
Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
e
The mouse event arguments.
Overrides
OnNumberOfPagesChanged()
Declaration
protected virtual void OnNumberOfPagesChanged()
OnPropertyChanged(RadPropertyChangedEventArgs)
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
e
Event arguments containing information about the property that changed.
Overrides
PreviousButton_Click(object, EventArgs)
Handles the Click event of the PreviousButton.
RaiseBubbleEvent(RadElement, RoutedEventArgs)
Raises routed events in the bubble phase, handling key events specifically.
Declaration
public override void RaiseBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
sender
The element that raised the event.
args
The routed event arguments.
Overrides
Select(int)
Selects the specified index.
Declaration
public virtual void Select(int index)
Parameters
index
The index to be selected.
Select(int, bool)
Selects the specified index.
SelectNext()
Moves the selected item to the next one.
Declaration
public void SelectNext()
SelectPrevious()
Moves the selected item to the previous one.
Declaration
public void SelectPrevious()
StartAnimation(RadProperty, object, object)
Declaration
protected virtual void StartAnimation(RadProperty animationProperty, object startValue, object endValue)
Parameters
animationProperty
startValue
endValue
StopAnimation()
Stops the currently running animation.
Declaration
public virtual void StopAnimation()
UpdateNavigationButtons()
Declaration
protected virtual void UpdateNavigationButtons()
UpdateSelectedIndex()
Updates the text box.
Declaration
protected virtual void UpdateSelectedIndex()
UpdateVisibility()
Updates the visibility.
Declaration
public virtual void UpdateVisibility()
UpdateVisualItems()
Declaration
protected abstract void UpdateVisualItems()
Events
AnimationFinished
Occurs when the animation is finished.
Declaration
public event AnimationFinishedEventHandler AnimationFinished
Event Value
AnimationStarted
Occurs when the animation is started.
Declaration
public event AnimationStartedEventHandler AnimationStarted
Event Value