Class RadPipsPagerElement
Represents the main element of the RadPipsPager control, providing core functionality for pip-based navigation with animation support, visual layout management, and event handling.
Inheritance
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll
Syntax
public class RadPipsPagerElement : BaseNavigationElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderConstructors
RadPipsPagerElement()
Initializes a new instance of the RadPipsPagerElement class with default settings.
Declaration
public RadPipsPagerElement()Properties
AnimationFrames
Gets or sets the number of frames used for pip transition animations.
Declaration
public override int AnimationFrames { get; set; }Property Value
|
System.Int32
|
Overrides
ContentElement
This property is not relevant for this class. Use the PipsContainer property instead.
Declaration
public override LightVisualElement ContentElement { get; protected set; }Property Value
|
LightVisualElement
|
Overrides
ItemSize
Gets or sets the size of the individual pip items displayed in the control.
Declaration
public Size ItemSize { get; set; }Property Value
|
System.Drawing.Size
|
MaxVisiblePips
Gets or sets the maximum number of visible pip items displayed in the control at any given time.
Declaration
public int MaxVisiblePips { get; set; }Property Value
|
System.Int32
|
PipsContainer
Gets the pips container element that is responsible for displaying and managing the pip items layout.
Declaration
public PipsContainer PipsContainer { get; }Property Value
|
PipsContainer
|
Methods
CreateChildElements()
Creates and configures the child elements including the pips container and initializes the visible pips display.
Declaration
protected override void CreateChildElements()Overrides
CreateContentElement()
Creates and returns the content element that serves as the container for pip items.
Declaration
protected override LightVisualElement CreateContentElement()Returns
|
LightVisualElement
A PipsContainer instance that manages the layout and display of pip items |
Overrides
CreatePipsContainer()
Creates a new instance of the PipsContainer that will manage the pip items layout and animation.
Declaration
protected virtual PipsContainer CreatePipsContainer()Returns
|
PipsContainer
A new PipsContainer instance configured for this pips pager element |
InitializeFields()
Initializes the default field values for the RadPipsPagerElement instance.
Declaration
protected override void InitializeFields()Overrides
OnAnimationFinished(AnimationStatusEventArgs)
Handles the completion of animation by clearing non-visible pip items to clean up the display.
Declaration
protected override void OnAnimationFinished(AnimationStatusEventArgs e)Parameters
|
AnimationStatusEventArgs
e
The animation status event arguments |
Overrides
OnBindingSourceListChanged()
Handles changes to the binding source list by updating the visible pips to reflect the new data state.
Declaration
protected override void OnBindingSourceListChanged()Overrides
OnCreatePipItem(CreatePipItemEventArgs)
Raises the CreatePipItem event to allow customization of newly created pip items.
Declaration
protected virtual void OnCreatePipItem(CreatePipItemEventArgs args)Parameters
|
CreatePipItemEventArgs
args
The event arguments containing the pip item that can be customized |
OnNumberOfPagesChanged()
Handles changes to the number of pages by updating the visible pips display accordingly.
Declaration
protected override void OnNumberOfPagesChanged()Overrides
OnSelectedIndexChanged(SelectedPipChangedEventArgs)
Raises the SelectedIndexChanged event when the selected pip index changes.
Declaration
protected virtual void OnSelectedIndexChanged(SelectedPipChangedEventArgs args)Parameters
|
SelectedPipChangedEventArgs
args
The event arguments containing information about the selection change |
ResetVisualPips()
Removes all existing pip items from the container and creates new visual pip items based on the current state and visible range.
Declaration
public virtual void ResetVisualPips()SelectCore(Int32, Int32, Boolean)
Handles the core selection logic including pip creation, animation processing, and event firing when the selected index changes.
Declaration
protected override void SelectCore(int oldIndex, int newIndex, bool animate)Parameters
|
System.Int32
oldIndex
The previously selected index |
|
System.Int32
newIndex
The newly selected index |
|
System.Boolean
animate
Whether to animate the transition between pip selections |
Overrides
UpdateVisiblePips()
Updates the visual pip count, calculates the start index, resets visual pips, and updates the selected index if necessary to maintain consistency.
Declaration
public virtual void UpdateVisiblePips()UpdateVisualItems()
Updates the visual items by refreshing the pip display to reflect current state.
Declaration
protected override void UpdateVisualItems()Overrides
Events
CreatePipItem
Occurs when a new pip item is created during the rendering process. This event is suitable for modifying or replacing the pip with custom content or styling.
Declaration
public event CreatePipItemEventHandler CreatePipItemEvent Type
|
CreatePipItemEventHandler
|
SelectedIndexChanged
Occurs when the selected pip index has changed to a different pip item.
Declaration
public event SelectedPipChangedEventHandler SelectedIndexChangedEvent Type
|
SelectedPipChangedEventHandler
|
