ClassItemScroller<T>
Represent item scroller
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Type Parameters:
T
Syntax:
public class ItemScroller<T> : IEnumerable, IDisposableInheritance: objectItemScroller<T>
Derived Classes:
Implements:
Constructors
ItemScroller()
Declaration
public ItemScroller()Fields
Properties
AllowHiddenScrolling
When set to true, allows the scroller to scroll through the items when the scrollbar is not visible.
AsynchronousScrolling
Gets or sets a value indicating whether scrolling is asynchronous.
Declaration
public bool AsynchronousScrolling { get; set; }Property Value
true if [asynchronous scrolling]; otherwise, false.
ClientSize
Gets or sets the client size.
Declaration
public SizeF ClientSize { get; set; }Property Value
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
The height of the item.
ItemSpacing
Gets or sets the item spacing.
Declaration
public int ItemSpacing { get; set; }Property Value
The item spacing.
MaxItemWidth
Gets the max width of item.
Declaration
public int MaxItemWidth { get; }Property Value
The width of the max item.
Position
Gets the position.
ScrollMode
Gets or sets the scroll mode.
Declaration
public ItemScrollerScrollModes ScrollMode { get; set; }Property Value
The scroll mode.
ScrollOffset
Gets or sets the scroll offset.
Declaration
public int ScrollOffset { get; set; }Property Value
The scroll offset.
ScrollState
Gets or sets the state of the scroll.
Declaration
public ScrollState ScrollState { get; set; }Property Value
The state of the scroll.
Scrollbar
Gets or sets the associated scrollbar.
Declaration
public RadScrollBarElement Scrollbar { get; set; }Property Value
The scrollbar.
ToolTip
Gets or sets the tool tip.
Declaration
public ToolTip ToolTip { get; protected set; }Property Value
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
Dispose(bool)
Releases unmanaged and - optionally - managed resources.
Declaration
protected virtual void Dispose(bool disposing)Parameters
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
The Index of the current item
GetScrollHeight(T)
Gets the height of the scroll.
Declaration
public virtual int GetScrollHeight(T item)Parameters
item
T
The item.
Returns
GetToolTipText()
Determines the ToolTip text
Declaration
protected virtual string GetToolTipText()Returns
Returns the ToolTip's text
HideToolTip()
Hides scroller's tooltip
Declaration
protected virtual void HideToolTip()OnScrollerUpdated(EventArgs)
Raises the event.
OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)
Called when tool tip text is needed.
Declaration
protected virtual void OnToolTipTextNeeded(object sender, ToolTipTextNeededEventArgs e)Parameters
sender
The sender.
e
The ToolTipTextNeededEventArgs instance containing the event data.
ScrollDown(int)
Scrolls down to specified position.
ScrollTo(int)
Scrolls to specified position.
ScrollToBegin()
Scrolls to begin.
ScrollToEnd()
Scrolls to end.
ScrollToItem(T)
Scrolls to item.
Declaration
public virtual bool ScrollToItem(T item)Parameters
item
T
The item.
Returns
ScrollToItem(T, bool)
Scrolls to item.
ScrollUp(int)
Scrolls up.
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
e
The ScrollEventArgs instance containing the event data.
Returns
UpdateScrollRange()
Updates the scroll range.
Declaration
public virtual void UpdateScrollRange()UpdateScrollRange(int, bool)
Updates the scroll range with concrete range.
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.
ToolTipTextNeeded
Occurs when tool tip text is needed.
Declaration
public event ToolTipTextNeededEventHandler ToolTipTextNeededEvent Value