New to Telerik UI for WinFormsStart a free 30-day trial

Represent item scroller

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Type Parameters:

T

Syntax:

C#
public class ItemScroller<T> : IEnumerable, IDisposable

Inheritance: objectItemScroller<T>

Derived Classes: PdfItemScrollerChatMessagesViewItemScrollerDetailListViewColumnScrollerGanttViewTextViewColumnScrollerGanttViewTimelineScrollerIconListViewScrollerPivotGridScrollerPivotGroupNodeScrollerRowScrollerVirtualGridItemScroller...

Implements: IDisposableIEnumerable

Constructors

C#
public ItemScroller()

Fields

C#
protected int cachedScrollOffset
C#
protected int currentItemWidth
C#
protected bool scrollbarChanged

Properties

When set to true, allows the scroller to scroll through the items when the scrollbar is not visible.

C#
public bool AllowHiddenScrolling { get; set; }

Gets or sets a value indicating whether scrolling is asynchronous.

C#
public bool AsynchronousScrolling { get; set; }
Property Value:

true if [asynchronous scrolling]; otherwise, false.

Gets or sets the client size.

C#
public SizeF ClientSize { get; set; }
Property Value:

The size of the client.

Gets or sets the element provider.

C#
public IVirtualizedElementProvider<T> ElementProvider { get; set; }
Property Value:

The element provider.

Gets or sets the item height.

C#
public int ItemHeight { get; set; }
Property Value:

The height of the item.

Gets or sets the item spacing.

C#
public int ItemSpacing { get; set; }
Property Value:

The item spacing.

Gets the max width of item.

C#
public int MaxItemWidth { get; }
Property Value:

The width of the max item.

Gets the position.

C#
public object Position { get; }
Property Value:

The position.

Gets or sets the associated scrollbar.

C#
public RadScrollBarElement Scrollbar { get; set; }
Property Value:

The scrollbar.

Gets or sets the scroll mode.

C#
public ItemScrollerScrollModes ScrollMode { get; set; }
Property Value:

The scroll mode.

Gets or sets the scroll offset.

C#
public int ScrollOffset { get; set; }
Property Value:

The scroll offset.

Gets or sets the state of the scroll.

C#
public ScrollState ScrollState { get; set; }
Property Value:

The state of the scroll.

Gets or sets the tool tip.

C#
public ToolTip ToolTip { get; protected set; }
Property Value:

The tool tip.

Gets or sets the associated traverser.

C#
public ITraverser<T> Traverser { get; set; }
Property Value:

The traverser.

Methods

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

C#
public void Dispose()

Implements: IDisposable.Dispose()

Releases unmanaged and - optionally - managed resources.

C#
protected virtual void Dispose(bool disposing)
Parameters:disposingbool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Determines the traverser's current item index

C#
protected virtual int GetCurrentItemIndex()
Returns:

int

The Index of the current item

Gets the height of the scroll.

C#
public virtual int GetScrollHeight(T item)
Parameters:itemT

The item.

Returns:

int

Determines the ToolTip text

C#
protected virtual string GetToolTipText()
Returns:

string

Returns the ToolTip's text

Hides scroller's tooltip

C#
protected virtual void HideToolTip()

Determines whether the scrollbar is currently at or near the maximum scroll position (bottom for vertical, right for horizontal).

C#
public virtual bool IsScrolledToEnd()
Returns:

bool

true if scrolled to the end or no scrollbar is needed; otherwise, false.

Raises the event.

C#
protected virtual void OnScrollerUpdated(EventArgs e)
Parameters:eEventArgs

The EventArgs instance containing the event data.

Called when tool tip text is needed.

C#
protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters:senderobject

The sender.

eToolTipTextNeededEventArgs

The ToolTipTextNeededEventArgs instance containing the event data.

Scrolls down to specified position.

C#
protected virtual bool ScrollDown(int step)
Parameters:stepint

The step.

Returns:

bool

Scrolls to specified position.

C#
protected virtual bool ScrollTo(int position)
Parameters:positionint

The position.

Returns:

bool

Scrolls to begin.

C#
protected virtual bool ScrollToBegin()
Returns:

bool

Scrolls to end.

C#
protected virtual bool ScrollToEnd()
Returns:

bool

Scrolls to item.

C#
public virtual bool ScrollToItem(T item, bool checkScrollVisibility)
Parameters:itemT

The item.

checkScrollVisibilitybool

if set to true scroll visibility is checked before processing scrolling.

Returns:

bool

Scrolls to item.

C#
public virtual bool ScrollToItem(T item)
Parameters:itemT

The item.

Returns:

bool

Scrolls the scrollbar to the maximum scroll position (bottom for vertical, right for horizontal).

C#
public virtual void ScrollToMaxValue()

Scrolls up.

C#
protected virtual bool ScrollUp(int step)
Parameters:stepint

The step.

Returns:

bool

Sets the scroll bar visibility.

C#
protected void SetScrollBarVisibility()

Shows scroller's tool tip

C#
protected virtual void ShowToolTip()

Updates the on scroll.

C#
protected virtual bool UpdateOnScroll(ScrollEventArgs e)
Parameters:eScrollEventArgs

The ScrollEventArgs instance containing the event data.

Returns:

bool

Updates the scroll range.

C#
public virtual void UpdateScrollRange()

Updates the scroll range with concrete range.

C#
public virtual void UpdateScrollRange(int maximum, bool updateScrollValue)
Parameters:maximumint

The maximum.

updateScrollValuebool

if set to true [update scroll value].

Updates the scroll step.

C#
public virtual void UpdateScrollStep()

Updates the scroll value.

C#
public virtual void UpdateScrollValue()

Events

Occurs when the scroller is updated.

C#
public event EventHandler ScrollerUpdated

Occurs when tool tip text is needed.

C#
public event ToolTipTextNeededEventHandler ToolTipTextNeeded