Class RadPipsPager

Represents a control that enables navigation within linearly paginated content. 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.

Declaration
public RadPipsPager()

Properties

AllowAnimation

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

Declaration
public 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 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

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

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.

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

ButtonsVisibility

Determines whether and how to display the navigation buttons.

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

Determines whether infinite scrolling from last to first pip item and vice versa is enabled.

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

ItemSize

Gets or sets size of the items(pips).

Declaration
public Size ItemSize { get; set; }
Property Value
System.Drawing.Size

MaxVisiblePips

Gets or sets the number of visible pips displayed in the control.

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

NumberOfPages

Gets or sets the number of pages. 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 a value indicating how to orientate the pips - horizontally or vertically.

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

PipsPagerElement

Gets the main pips pager element.

Declaration
public RadPipsPagerElement PipsPagerElement { get; }
Property Value
RadPipsPagerElement

SelectedIndex

Gets or sets the index of the selected pips pager 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 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

CreateAccessibilityInstance()

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

CreateChildItems(RadElement)

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

Overrides

CreateRadPipsPagerElement()

Declaration
protected virtual RadPipsPagerElement CreateRadPipsPagerElement()
Returns
RadPipsPagerElement

IsInputKey(Keys)

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

Returns
System.Boolean

Overrides

OnGotFocus(EventArgs)

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

Overrides

Select(Int32)

Selects the specified index.

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

The index to be selected.

Select(Int32, Boolean)

Selects the specified index.

Declaration
public 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.

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()

UpdateVisibility()

Updates the visibility.

Declaration
public virtual void UpdateVisibility()

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

CreatePipItem

Occurs when a new pips pager item is created. Suitable to modify or replace the pip.

Declaration
public event CreatePipItemEventHandler CreatePipItem
Event Type
CreatePipItemEventHandler

SelectedIndexChanged

Occurs when selected index has changed.

Declaration
public event SelectedPipChangedEventHandler SelectedIndexChanged
Event Type
SelectedPipChangedEventHandler

Extension Methods