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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Data Controls")]
public class RadPipsPager : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadPipsPager...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadPipsPager class with default settings.
public RadPipsPager()Properties
Gets or sets a value indicating whether to use animation when transitioning between pip selections.
public bool AllowAnimation { get; set; }Gets or sets the easing type used for pip transition animations to control the acceleration and deceleration of the animation.
public RadEasingType AnimationEasingType { get; set; }Gets or sets the number of frames used for pip transition animations.
public int AnimationFrames { get; set; }Gets or sets the time interval in milliseconds between animation frames during pip transitions.
public int AnimationInterval { get; set; }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.
public int AutoHideButtonsDelay { get; set; }Gets or sets the data source for data binding scenarios. When set, the control will automatically generate pips based on the data source items.
[Browsable(true)]
public BindingSource BindingSource { get; set; }Gets or sets how the navigation buttons are displayed - whether they are always visible, hidden, or visible only on mouse over.
public ButtonsVisibility ButtonsVisibility { get; set; }Gets the default size of the RadPipsPager when a new instance is initialized.
protected override Size DefaultSize { get; }Overrides:
Gets or sets a value indicating whether infinite scrolling from the last pip to the first pip and vice versa is enabled.
public bool IsInfiniteScrollingEnabled { get; set; }Gets or sets the size of the individual pip items displayed in the control.
public Size ItemSize { get; set; }Gets or sets the maximum number of visible pip items displayed in the control at any given time.
public int MaxVisiblePips { get; set; }Gets or sets the total number of pages in the pagination. If BindingSource is set, this property returns the Count.
public int NumberOfPages { get; set; }Gets or sets the orientation of the pip items - either horizontal or vertical arrangement.
public Orientation Orientation { get; set; }Gets the main pips pager element that handles the core functionality of the control.
[Browsable(false)]
public RadPipsPagerElement PipsPagerElement { get; }Gets or sets the zero-based index of the currently selected pip item.
public int SelectedIndex { get; set; }Methods
Determines whether moving to the next pip is possible based on the current selection and infinite scrolling settings.
public bool CanSelectNext()True if moving to the next pip is possible; otherwise, false
Determines whether moving to the previous pip is possible based on the current selection and infinite scrolling settings.
public bool CanSelectPrevious()True if moving to the previous pip is possible; otherwise, false
Creates the accessibility instance for this control to support screen readers and other accessibility tools.
protected override AccessibleObject CreateAccessibilityInstance()An AccessibleObject instance for this control
Overrides:
Creates the child items for this control by adding the main pips pager element to the parent container.
protected override void CreateChildItems(RadElement parent)The parent element that will contain the child items
Overrides:
Creates a new instance of the RadPipsPagerElement that will serve as the main element for this control.
protected virtual RadPipsPagerElement CreateRadPipsPagerElement()A new RadPipsPagerElement instance
Determines whether the specified key is an input key that should be processed by the control for navigation purposes.
Selects the pip at the specified index without animation.
Moves the selection to the next pip if possible.
public void SelectNext()Moves the selection to the previous pip if possible.
public void SelectPrevious()Updates the visibility of navigation buttons and other visual elements based on the current state and settings.
public virtual void UpdateVisibility()Events
Occurs when a pip animation is finished.
public event AnimationFinishedEventHandler AnimationFinishedOccurs when a pip animation is started.
public event AnimationStartedEventHandler AnimationStartedOccurs 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.
public event CreatePipItemEventHandler CreatePipItemOccurs when the selected pip index has changed to a different pip item.
public event SelectedPipChangedEventHandler SelectedIndexChanged