Class
ItemScroller<T>

Represent item scroller

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Type Parameters:

T

Syntax:

cs-api-definition
public class ItemScroller<T> : IEnumerable, IDisposable

Inheritance: objectItemScroller<T>

Derived Classes: PdfItemScrollerChatMessagesViewItemScrollerDetailListViewColumnScrollerGanttViewTextViewColumnScrollerGanttViewTimelineScrollerIconListViewScrollerPivotGridScrollerPivotGroupNodeScrollerRowScrollerVirtualGridItemScroller

Implements: IDisposableIEnumerable

Constructors

ItemScroller()

Declaration

cs-api-definition
public ItemScroller()

Fields

cachedScrollOffset

Declaration

cs-api-definition
protected int cachedScrollOffset

Field Value

int

currentItemWidth

Declaration

cs-api-definition
protected int currentItemWidth

Field Value

int

scrollbarChanged

Declaration

cs-api-definition
protected bool scrollbarChanged

Field Value

bool

Properties

AllowHiddenScrolling

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

Declaration

cs-api-definition
public bool AllowHiddenScrolling { get; set; }

Property Value

bool

AsynchronousScrolling

Gets or sets a value indicating whether scrolling is asynchronous.

Declaration

cs-api-definition
public bool AsynchronousScrolling { get; set; }

Property Value

bool

true if [asynchronous scrolling]; otherwise, false.

ClientSize

Gets or sets the client size.

Declaration

cs-api-definition
public SizeF ClientSize { get; set; }

Property Value

SizeF

The size of the client.

ElementProvider

Gets or sets the element provider.

Declaration

cs-api-definition
public IVirtualizedElementProvider<T> ElementProvider { get; set; }

Property Value

IVirtualizedElementProvider<T>

The element provider.

ItemHeight

Gets or sets the item height.

Declaration

cs-api-definition
public int ItemHeight { get; set; }

Property Value

int

The height of the item.

ItemSpacing

Gets or sets the item spacing.

Declaration

cs-api-definition
public int ItemSpacing { get; set; }

Property Value

int

The item spacing.

MaxItemWidth

Gets the max width of item.

Declaration

cs-api-definition
public int MaxItemWidth { get; }

Property Value

int

The width of the max item.

Position

Gets the position.

Declaration

cs-api-definition
public object Position { get; }

Property Value

object

The position.

ScrollMode

Gets or sets the scroll mode.

Declaration

cs-api-definition
public ItemScrollerScrollModes ScrollMode { get; set; }

Property Value

ItemScrollerScrollModes

The scroll mode.

ScrollOffset

Gets or sets the scroll offset.

Declaration

cs-api-definition
public int ScrollOffset { get; set; }

Property Value

int

The scroll offset.

ScrollState

Gets or sets the state of the scroll.

Declaration

cs-api-definition
public ScrollState ScrollState { get; set; }

Property Value

ScrollState

The state of the scroll.

Scrollbar

Gets or sets the associated scrollbar.

Declaration

cs-api-definition
public RadScrollBarElement Scrollbar { get; set; }

Property Value

RadScrollBarElement

The scrollbar.

ToolTip

Gets or sets the tool tip.

Declaration

cs-api-definition
public ToolTip ToolTip { get; protected set; }

Property Value

ToolTip

The tool tip.

Traverser

Gets or sets the associated traverser.

Declaration

cs-api-definition
public ITraverser<T> Traverser { get; set; }

Property Value

ITraverser<T>

The traverser.

Methods

Dispose()

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

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

Declaration

cs-api-definition
protected virtual void Dispose(bool disposing)

Parameters

disposing

bool

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

GetCurrentItemIndex()

Determines the traverser's current item index

Declaration

cs-api-definition
protected virtual int GetCurrentItemIndex()

Returns

int

The Index of the current item

GetScrollHeight(T)

Gets the height of the scroll.

Declaration

cs-api-definition
public virtual int GetScrollHeight(T item)

Parameters

item

T

The item.

Returns

int

GetToolTipText()

Determines the ToolTip text

Declaration

cs-api-definition
protected virtual string GetToolTipText()

Returns

string

Returns the ToolTip's text

HideToolTip()

Hides scroller's tooltip

Declaration

cs-api-definition
protected virtual void HideToolTip()

IsScrolledToEnd()

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

Declaration

cs-api-definition
public virtual bool IsScrolledToEnd()

Returns

bool

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

OnScrollerUpdated(EventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnScrollerUpdated(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)

Called when tool tip text is needed.

Declaration

cs-api-definition
protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)

Parameters

sender

object

The sender.

e

ToolTipTextNeededEventArgs

The ToolTipTextNeededEventArgs instance containing the event data.

ScrollDown(int)

Scrolls down to specified position.

Declaration

cs-api-definition
protected virtual bool ScrollDown(int step)

Parameters

step

int

The step.

Returns

bool

ScrollTo(int)

Scrolls to specified position.

Declaration

cs-api-definition
protected virtual bool ScrollTo(int position)

Parameters

position

int

The position.

Returns

bool

ScrollToBegin()

Scrolls to begin.

Declaration

cs-api-definition
protected virtual bool ScrollToBegin()

Returns

bool

ScrollToEnd()

Scrolls to end.

Declaration

cs-api-definition
protected virtual bool ScrollToEnd()

Returns

bool

ScrollToItem(T)

Scrolls to item.

Declaration

cs-api-definition
public virtual bool ScrollToItem(T item)

Parameters

item

T

The item.

Returns

bool

ScrollToItem(T, bool)

Scrolls to item.

Declaration

cs-api-definition
public virtual bool ScrollToItem(T item, bool checkScrollVisibility)

Parameters

item

T

The item.

checkScrollVisibility

bool

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

Returns

bool

ScrollToMaxValue()

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

Declaration

cs-api-definition
public virtual void ScrollToMaxValue()

ScrollUp(int)

Scrolls up.

Declaration

cs-api-definition
protected virtual bool ScrollUp(int step)

Parameters

step

int

The step.

Returns

bool

SetScrollBarVisibility()

Sets the scroll bar visibility.

Declaration

cs-api-definition
protected void SetScrollBarVisibility()

ShowToolTip()

Shows scroller's tool tip

Declaration

cs-api-definition
protected virtual void ShowToolTip()

UpdateOnScroll(ScrollEventArgs)

Updates the on scroll.

Declaration

cs-api-definition
protected virtual bool UpdateOnScroll(ScrollEventArgs e)

Parameters

e

ScrollEventArgs

The ScrollEventArgs instance containing the event data.

Returns

bool

UpdateScrollRange()

Updates the scroll range.

Declaration

cs-api-definition
public virtual void UpdateScrollRange()

UpdateScrollRange(int, bool)

Updates the scroll range with concrete range.

Declaration

cs-api-definition
public virtual void UpdateScrollRange(int maximum, bool updateScrollValue)

Parameters

maximum

int

The maximum.

updateScrollValue

bool

if set to true [update scroll value].

UpdateScrollStep()

Updates the scroll step.

Declaration

cs-api-definition
public virtual void UpdateScrollStep()

UpdateScrollValue()

Updates the scroll value.

Declaration

cs-api-definition
public virtual void UpdateScrollValue()

Events

ScrollerUpdated

Occurs when the scroller is updated.

Declaration

cs-api-definition
public event EventHandler ScrollerUpdated

Event Value

EventHandler

ToolTipTextNeeded

Occurs when tool tip text is needed.

Declaration

cs-api-definition
public event ToolTipTextNeededEventHandler ToolTipTextNeeded

Event Value

ToolTipTextNeededEventHandler