Documentation

Class ItemScroller<T>

Represent item scroller

Inheritance
System.Object
ItemScroller<T>
PdfItemScroller
ChatMessagesViewItemScroller
DetailListViewColumnScroller
GanttViewTextViewColumnScroller
GanttViewTimelineScroller
IconListViewScroller
PivotGridScroller
PivotGroupNodeScroller
RowScroller
VirtualGridItemScroller
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class ItemScroller<T> : IEnumerable, IDisposable
Type Parameters
T

Constructors

ItemScroller()

Declaration
public ItemScroller()

Fields

cachedScrollOffset

Declaration
protected int cachedScrollOffset
Field Value
System.Int32

currentItemWidth

Declaration
protected int currentItemWidth
Field Value
System.Int32

scrollbarChanged

Declaration
protected bool scrollbarChanged
Field Value
System.Boolean

Properties

AllowHiddenScrolling

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

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

AsynchronousScrolling

Gets or sets a value indicating whether scrolling is asynchronous.

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

true if [asynchronous scrolling]; otherwise, false.

ClientSize

Gets or sets the client size.

Declaration
public SizeF ClientSize { get; set; }
Property Value
System.Drawing.SizeF

The size of the client.

ElementProvider

Gets or sets the element provider.

Declaration
public IVirtualizedElementProvider<T> ElementProvider { get; set; }
Property Value
IVirtualizedElementProvider<T>

The element provider.

ItemHeight

Gets or sets the item height.

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

The height of the item.

ItemSpacing

Gets or sets the item spacing.

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

The item spacing.

MaxItemWidth

Gets the max width of item.

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

The width of the max item.

Position

Gets the position.

Declaration
public object Position { get; }
Property Value
System.Object

The position.

Scrollbar

Gets or sets the associated scrollbar.

Declaration
public RadScrollBarElement Scrollbar { get; set; }
Property Value
RadScrollBarElement

The scrollbar.

ScrollMode

Gets or sets the scroll mode.

Declaration
public ItemScrollerScrollModes ScrollMode { get; set; }
Property Value
ItemScrollerScrollModes

The scroll mode.

ScrollOffset

Gets or sets the scroll offset.

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

The scroll offset.

ScrollState

Gets or sets the state of the scroll.

Declaration
public ScrollState ScrollState { get; set; }
Property Value
ScrollState

The state of the scroll.

ToolTip

Gets or sets the tool tip.

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

The tool tip.

Traverser

Gets or sets the associated traverser.

Declaration
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
public void Dispose()
Implements
System.IDisposable.Dispose()

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
System.Boolean disposing

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

GetCurrentItemIndex()

Determines the traverser's current item index

Declaration
protected virtual int GetCurrentItemIndex()
Returns
System.Int32

The Index of the current item

GetScrollHeight(T)

Gets the height of the scroll.

Declaration
public virtual int GetScrollHeight(T item)
Parameters
T item

The item.
Returns
System.Int32

GetToolTipText()

Determines the ToolTip text

Declaration
protected virtual string GetToolTipText()
Returns
System.String

Returns the ToolTip's text

HideToolTip()

Hides scroller's tooltip

Declaration
protected virtual void HideToolTip()

OnScrollerUpdated(EventArgs)

Raises the ScrollerUpdated event.

Declaration
protected virtual void OnScrollerUpdated(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnToolTipTextNeeded(Object, ToolTipTextNeededEventArgs)

Called when tool tip text is needed.

Declaration
protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)
Parameters
System.Object sender

The sender.
ToolTipTextNeededEventArgs e

The ToolTipTextNeededEventArgs instance containing the event data.

ScrollDown(Int32)

Scrolls down to specified position.

Declaration
protected virtual bool ScrollDown(int step)
Parameters
System.Int32 step

The step.
Returns
System.Boolean

ScrollTo(Int32)

Scrolls to specified position.

Declaration
protected virtual bool ScrollTo(int position)
Parameters
System.Int32 position

The position.
Returns
System.Boolean

ScrollToBegin()

Scrolls to begin.

Declaration
protected virtual bool ScrollToBegin()
Returns
System.Boolean

ScrollToEnd()

Scrolls to end.

Declaration
protected virtual bool ScrollToEnd()
Returns
System.Boolean

ScrollToItem(T)

Scrolls to item.

Declaration
public virtual bool ScrollToItem(T item)
Parameters
T item

The item.
Returns
System.Boolean

ScrollToItem(T, Boolean)

Scrolls to item.

Declaration
public virtual bool ScrollToItem(T item, bool checkScrollVisibility)
Parameters
T item

The item.
System.Boolean checkScrollVisibility

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

ScrollUp(Int32)

Scrolls up.

Declaration
protected virtual bool ScrollUp(int step)
Parameters
System.Int32 step

The step.
Returns
System.Boolean

SetScrollBarVisibility()

Sets the scroll bar visibility.

Declaration
protected void SetScrollBarVisibility()

ShowToolTip()

Shows scroller's tool tip

Declaration
protected virtual void ShowToolTip()

UpdateOnScroll(ScrollEventArgs)

Updates the on scroll.

Declaration
protected virtual bool UpdateOnScroll(ScrollEventArgs e)
Parameters
System.Windows.Forms.ScrollEventArgs e

The System.Windows.Forms.ScrollEventArgs instance containing the event data.
Returns
System.Boolean

UpdateScrollRange()

Updates the scroll range.

Declaration
public virtual void UpdateScrollRange()

UpdateScrollRange(Int32, Boolean)

Updates the scroll range with concrete range.

Declaration
public virtual void UpdateScrollRange(int width, bool updateScrollValue)
Parameters
System.Int32 width

The width.
System.Boolean updateScrollValue

if set to true [update scroll value].

UpdateScrollStep()

Updates the scroll step.

Declaration
public virtual void UpdateScrollStep()

UpdateScrollValue()

Updates the scroll value.

Declaration
public virtual void UpdateScrollValue()

Events

ScrollerUpdated

Occurs when the scroller is updated.

Declaration
public event EventHandler ScrollerUpdated
Event Type
System.EventHandler

ToolTipTextNeeded

Occurs when tool tip text is needed.

Declaration
public event ToolTipTextNeededEventHandler ToolTipTextNeeded
Event Type
ToolTipTextNeededEventHandler

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
System.Collections.IEnumerator

Implements
System.Collections.IEnumerable.GetEnumerator()

Extension Methods