Class BaseNavigationElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
BaseNavigationElement
RadPipsPagerElement
RadSlideViewElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI.Navigation
Assembly: Telerik.WinControls.UI.dll

Syntax

public abstract class BaseNavigationElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

BaseNavigationElement()

Declaration
protected BaseNavigationElement()

Properties

AllowAnimation

Gets or sets a value indicating whether to use animation when changing its state.

Declaration
public virtual bool AllowAnimation { get; set; }
Property Value
System.Boolean

AnimationEasingType

Gets or sets the animation easing type.

Declaration
public RadEasingType AnimationEasingType { get; set; }
Property Value
RadEasingType

AnimationFrames

Gets or sets the animation frames.

Declaration
public virtual int AnimationFrames { get; set; }
Property Value
System.Int32

AnimationInterval

Gets or sets the animation interval.

Declaration
public int AnimationInterval { get; set; }
Property Value
System.Int32

AreButtonsOverContent

Declaration
protected bool AreButtonsOverContent { get; }
Property Value
System.Boolean

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.

Declaration
public int AutoHideButtonsDelay { get; set; }
Property Value
System.Int32

BindingSource

Gets or sets the binding source.

Declaration
public BindingSource BindingSource { get; set; }
Property Value
System.Windows.Forms.BindingSource

The binding source.

ButtonsVisibility

Determines whether and how to display the navigation buttons.

Declaration
public virtual ButtonsVisibility ButtonsVisibility { get; set; }
Property Value
ButtonsVisibility

ContentElement

Gets the content element.

Declaration
public virtual LightVisualElement ContentElement { get; protected set; }
Property Value
LightVisualElement

The content element.

IsAnimating

Gets a value indicating whether the control is currently animating.

Declaration
public bool IsAnimating { get; }
Property Value
System.Boolean

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
System.Boolean

LayoutPanel

Gets the navigation element layout.

Declaration
public NavigationElementLayout LayoutPanel { get; }
Property Value
NavigationElementLayout

The navigation element layout.

NextButton

Gets the next button.

Declaration
public NavigationButtonElement NextButton { get; }
Property Value
NavigationButtonElement

The next button.

NumberOfPages

Gets or sets the number of pages.IfBindingSource is set, this property returns theSystem.Windows.Forms.BindingSource.Count.

Declaration
public int NumberOfPages { get; set; }
Property Value
System.Int32

Orientation

Gets or sets a value indicating how to orient the navigation buttons - horizontally or vertically.

Declaration
public Orientation Orientation { get; set; }
Property Value
System.Windows.Forms.Orientation

PreviousButton

Gets the previous button.

Declaration
public NavigationButtonElement PreviousButton { get; }
Property Value
NavigationButtonElement

The previous button.

SelectedIndex

Gets or sets the index of the selected item.

Declaration
public int SelectedIndex { get; set; }
Property Value
System.Int32

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
System.Object sender

System.ComponentModel.ListChangedEventArgs e

BindingSource_PositionChanged(Object, EventArgs)

Declaration
protected virtual void BindingSource_PositionChanged(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

CanSelectNext()

Determines whether moving to next item is possible.

Declaration
public bool CanSelectNext()
Returns
System.Boolean

CanSelectPrevious()

Determines whether moving to previous item is possible.

Declaration
public bool CanSelectPrevious()
Returns
System.Boolean

CoerceIndex(Int32)

Declaration
protected int CoerceIndex(int index)
Parameters
System.Int32 index

Returns
System.Int32

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateContentElement()

Declaration
protected abstract LightVisualElement CreateContentElement()
Returns
LightVisualElement

CreateLayoutPanel()

Declaration
protected virtual NavigationElementLayout CreateLayoutPanel()
Returns
NavigationElementLayout

CreateNextPageButton()

Declaration
protected virtual NavigationButtonElement CreateNextPageButton()
Returns
NavigationButtonElement

CreatePreviousPageButton()

Declaration
protected virtual NavigationButtonElement CreatePreviousPageButton()
Returns
NavigationButtonElement

DetachButtonEvents()

Unwires the buttons and text box events.

Declaration
protected virtual void DetachButtonEvents()

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

GetNextIndex()

Returns the next index taking into account whether infinite looping is enabled.

Declaration
protected virtual int GetNextIndex()
Returns
System.Int32

GetPreviousIndex()

Returns the previous index taking into account whether infinite looping is enabled.

Declaration
protected virtual int GetPreviousIndex()
Returns
System.Int32

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

NextButton_Click(Object, EventArgs)

Handles the Click event of the NextButton.

Declaration
protected virtual void NextButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event.
System.EventArgs e

The System.EventArgs instance containing the event data.

OnAnimationFinished(AnimationStatusEventArgs)

Declaration
protected virtual void OnAnimationFinished(AnimationStatusEventArgs e)
Parameters
AnimationStatusEventArgs e

OnAnimationStarted(AnimationStatusEventArgs)

Declaration
protected virtual void OnAnimationStarted(AnimationStatusEventArgs e)
Parameters
AnimationStatusEventArgs e

OnBindingSourceChanged()

Declaration
protected virtual void OnBindingSourceChanged()

OnBindingSourceListChanged()

Declaration
protected virtual void OnBindingSourceListChanged()

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

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)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnNumberOfPagesChanged()

Declaration
protected virtual void OnNumberOfPagesChanged()

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

PreviousButton_Click(Object, EventArgs)

Handles the Click event of the PreviousButton.

Declaration
protected virtual void PreviousButton_Click(object sender, EventArgs e)
Parameters
System.Object sender

The source of the event.
System.EventArgs e

The System.EventArgs instance containing the event data.

RaiseBubbleEvent(RadElement, RoutedEventArgs)

Declaration
public override void RaiseBubbleEvent(RadElement sender, RoutedEventArgs args)
Parameters
RadElement sender

RoutedEventArgs args

Overrides

Select(Int32)

Selects the specified index.

Declaration
public virtual void Select(int index)
Parameters
System.Int32 index

The index to be selected.

Select(Int32, Boolean)

Selects the specified index.

Declaration
public virtual void Select(int index, bool animate)
Parameters
System.Int32 index

The index to be selected.
System.Boolean animate

Determines whether to animate the selection process.

SelectCore(Int32, Int32, Boolean)

Declaration
protected abstract void SelectCore(int oldIndex, int newIndex, bool animate)
Parameters
System.Int32 oldIndex

System.Int32 newIndex

System.Boolean animate

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
RadProperty animationProperty

System.Object startValue

System.Object 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 Type
AnimationFinishedEventHandler

AnimationStarted

Occurs when the animation is started.

Declaration
public event AnimationStartedEventHandler AnimationStarted
Event Type
AnimationStartedEventHandler

Extension Methods