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
protected BaseNavigationElement()
Properties
Gets or sets a value indicating whether to use animation when changing its state.
public virtual bool AllowAnimation { get; set; }
Gets or sets the animation easing type.
public RadEasingType AnimationEasingType { get; set; }
Gets or sets the animation frames.
public virtual int AnimationFrames { get; set; }
Gets or sets the animation interval.
public int AnimationInterval { get; set; }
protected bool AreButtonsOverContent { get; }
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.
public int AutoHideButtonsDelay { get; set; }
Gets or sets the binding source.
public BindingSource BindingSource { get; set; }
The binding source.
Determines whether and how to display the navigation buttons.
public virtual ButtonsVisibility ButtonsVisibility { get; set; }
Gets the content element.
public virtual LightVisualElement ContentElement { get; protected set; }
The content element.
Gets a value indicating whether the control is currently animating.
[Browsable(false)]
public bool IsAnimating { get; }
Gets or sets a value indicating whether infinite scrolling from last to first item and vice versa is enabled.
public bool IsInfiniteScrollingEnabled { get; set; }
Gets the navigation element layout.
public NavigationElementLayout LayoutPanel { get; }
The navigation element layout.
Gets the next button.
public NavigationButtonElement NextButton { get; }
The next button.
Gets or sets the number of pages.IfBindingSource is set, this property returns theCount.
public int NumberOfPages { get; set; }
Gets or sets a value indicating how to orient the navigation buttons - horizontally or vertically.
public Orientation Orientation { get; set; }
Gets the previous button.
public NavigationButtonElement PreviousButton { get; }
The previous button.
Gets or sets the index of the selected item.
public int SelectedIndex { get; set; }
Methods
Attaches the events.
protected virtual void AttachButtonEvents()
protected virtual void BindingSource_ListChanged(object sender, ListChangedEventArgs e)
Determines whether moving to next item is possible.
Determines whether moving to previous item is possible.
Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()
Overrides:
protected virtual NavigationButtonElement CreateNextPageButton()
protected virtual NavigationButtonElement CreatePreviousPageButton()
Unwires the buttons and text box events.
protected virtual void DetachButtonEvents()
Disposes of managed resources including cached images and SVG images when the element is being disposed.
protected override void DisposeManagedResources()
Overrides:
Returns the next index taking into account whether infinite looping is enabled.
Returns the previous index taking into account whether infinite looping is enabled.
Initializes the internal fields and components of the LightVisualElement. This method sets up text primitives, image primitives, and layout management components.
protected override void InitializeFields()
Overrides:
Handles the Click event of the NextButton.
protected virtual void OnAnimationFinished(AnimationStatusEventArgs e)
protected virtual void OnAnimationStarted(AnimationStatusEventArgs e)
protected virtual void OnBindingSourceChanged()
protected virtual void OnBindingSourceListChanged()
Raises the KeyDown event.
protected override void OnKeyDown(KeyEventArgs e)
The key event arguments.
Overrides:
Called when the element has been successfully loaded. That includes loading of all its children as well.
protected override void OnLoaded()
Overrides:
protected virtual void OnMouseEnter()
protected virtual void OnMouseLeave()
Raises the MouseWheel event.
protected override void OnMouseWheel(MouseEventArgs e)
The mouse event arguments.
Overrides:
protected virtual void OnNumberOfPagesChanged()
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Event arguments containing information about the property that changed.
Overrides:
Handles the Click event of the PreviousButton.
Raises routed events in the bubble phase, handling key events specifically.
public override void RaiseBubbleEvent(RadElement sender, RoutedEventArgs args)
The element that raised the event.
argsRoutedEventArgsThe routed event arguments.
Overrides:
Selects the specified index.
Moves the selected item to the next one.
public void SelectNext()
Moves the selected item to the previous one.
public void SelectPrevious()
protected virtual void StartAnimation(RadProperty animationProperty, object startValue, object endValue)
Stops the currently running animation.
public virtual void StopAnimation()
protected virtual void UpdateNavigationButtons()
Updates the text box.
protected virtual void UpdateSelectedIndex()
Updates the visibility.
public virtual void UpdateVisibility()
protected abstract void UpdateVisualItems()
Events
Occurs when the animation is finished.
public event AnimationFinishedEventHandler AnimationFinished
Occurs when the animation is started.
public event AnimationStartedEventHandler AnimationStarted