Class RadPipsPager

Represents a control that enables navigation within linearly paginated content using visual pip indicators. Can be used as a navigation assistant for other controls such as the RadSlideView.

Inheritance
System.Object
RadControl
RadPipsPager
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadPipsPager : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadPipsPager()

Initializes a new instance of the RadPipsPager class with default settings.

Declaration
public RadPipsPager()

Properties

AllowAnimation

Gets or sets a value indicating whether to use animation when transitioning between pip selections.

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

AnimationEasingType

Gets or sets the easing type used for pip transition animations to control the acceleration and deceleration of the animation.

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

AnimationFrames

Gets or sets the number of frames used for pip transition animations.

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

AnimationInterval

Gets or sets the time interval in milliseconds between animation frames during pip transitions.

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

AutoHideButtonsDelay

Gets or sets the delay in milliseconds before the navigation buttons are hidden after the mouse leaves the control. Used only when the ButtonsVisibility is VisibleOnMouseOver.

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

AutoSize

This property is not relevant for this class.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BindingSource

Gets or sets the data source for data binding scenarios. When set, the control will automatically generate pips based on the data source items.

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

ButtonsVisibility

Gets or sets how the navigation buttons are displayed - whether they are always visible, hidden, or visible only on mouse over.

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

DefaultSize

Gets the default size of the RadPipsPager when a new instance is initialized.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

IsInfiniteScrollingEnabled

Gets or sets a value indicating whether infinite scrolling from the last pip to the first pip and vice versa is enabled.

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

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

NumberOfPages

Gets or sets the total number of pages in the pagination. If BindingSource is set, this property returns the System.Windows.Forms.BindingSource.Count.

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

Orientation

Gets or sets the orientation of the pip items - either horizontal or vertical arrangement.

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

PipsPagerElement

Gets the main pips pager element that handles the core functionality of the control.

Declaration
public RadPipsPagerElement PipsPagerElement { get; }
Property Value
RadPipsPagerElement

SelectedIndex

Gets or sets the zero-based index of the currently selected pip item.

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

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Methods

CanSelectNext()

Determines whether moving to the next pip is possible based on the current selection and infinite scrolling settings.

Declaration
public bool CanSelectNext()
Returns
System.Boolean

True if moving to the next pip is possible; otherwise, false

CanSelectPrevious()

Determines whether moving to the previous pip is possible based on the current selection and infinite scrolling settings.

Declaration
public bool CanSelectPrevious()
Returns
System.Boolean

True if moving to the previous pip is possible; otherwise, false

CreateAccessibilityInstance()

Creates the accessibility instance for this control to support screen readers and other accessibility tools.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

An System.Windows.Forms.AccessibleObject instance for this control

CreateChildItems(RadElement)

Creates the child items for this control by adding the main pips pager element to the parent container.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element that will contain the child items
Overrides

CreateRadPipsPagerElement()

Creates a new instance of the RadPipsPagerElement that will serve as the main element for this control.

Declaration
protected virtual RadPipsPagerElement CreateRadPipsPagerElement()
Returns
RadPipsPagerElement

A new RadPipsPagerElement instance

IsInputKey(Keys)

Determines whether the specified key is an input key that should be processed by the control for navigation purposes.

Declaration
protected override bool IsInputKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

The key data to evaluate
Returns
System.Boolean

True if the key is an input key (Left, Right, Up, Down arrows); otherwise, false
Overrides

OnGotFocus(EventArgs)

Handles the System.Windows.Forms.Control.GotFocus event by passing focus to the internal pips pager element.

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data
Overrides

Select(Int32)

Selects the pip at the specified index without animation.

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

The zero-based index of the pip to select

Select(Int32, Boolean)

Selects the pip at the specified index with an option to animate the transition.

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

The zero-based index of the pip to select
System.Boolean animate

A value indicating whether to animate the selection process

SelectNext()

Moves the selection to the next pip if possible.

Declaration
public void SelectNext()

SelectPrevious()

Moves the selection to the previous pip if possible.

Declaration
public void SelectPrevious()

UpdateVisibility()

Updates the visibility of navigation buttons and other visual elements based on the current state and settings.

Declaration
public virtual void UpdateVisibility()

Events

AnimationFinished

Occurs when a pip animation is finished.

Declaration
public event AnimationFinishedEventHandler AnimationFinished
Event Type
AnimationFinishedEventHandler

AnimationStarted

Occurs when a pip animation is started.

Declaration
public event AnimationStartedEventHandler AnimationStarted
Event Type
AnimationStartedEventHandler

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 CreatePipItem
Event Type
CreatePipItemEventHandler

SelectedIndexChanged

Occurs when the selected pip index has changed to a different pip item.

Declaration
public event SelectedPipChangedEventHandler SelectedIndexChanged
Event Type
SelectedPipChangedEventHandler

Extension Methods