Class

RadPipsPager

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

Declaration

public RadPipsPager()

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

Declaration

public bool AllowAnimation { get; set; }

Property Value

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

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

Declaration

public int AnimationFrames { get; set; }

Property Value

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

Declaration

public int AnimationInterval { get; set; }

Property Value

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

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

[Browsable(true)]
public BindingSource BindingSource { get; set; }

Property Value

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

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

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

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

Gets or sets the size of the individual pip items displayed in the control.

Declaration

public Size ItemSize { get; set; }

Property Value

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

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

Declaration

public int NumberOfPages { get; set; }

Property Value

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

Declaration

public Orientation Orientation { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public RadPipsPagerElement PipsPagerElement { get; }

Property Value

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

Declaration

public int SelectedIndex { get; set; }

Property Value

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

Declaration

public bool CanSelectNext()

Returns

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

Declaration

public bool CanSelectPrevious()

Returns

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

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

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

Overrides RadControl.CreateChildItems(RadElement)

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

Declaration

protected virtual RadPipsPagerElement CreateRadPipsPagerElement()

Returns

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

Returns

Overrides RadControl.IsInputKey(Keys)

Handles the GotFocus event by passing focus to the internal pips pager element.

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides RadControl.OnGotFocus(EventArgs)

Selects the pip at the specified index without animation.

Declaration

public void Select(int index)

Parameters

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

Declaration

public void Select(int index, bool animate)

Parameters

Moves the selection to the next pip if possible.

Declaration

public void SelectNext()

Moves the selection to the previous pip if possible.

Declaration

public void SelectPrevious()

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

Declaration

public virtual void UpdateVisibility()

Occurs when a pip animation is finished.

Declaration

public event AnimationFinishedEventHandler AnimationFinished

Event Value

Occurs when a pip animation is started.

Declaration

public event AnimationStartedEventHandler AnimationStarted

Event Value

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 Value

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

Declaration

public event SelectedPipChangedEventHandler SelectedIndexChanged

Event Value