Class ListBoxPanel

Represents a virtualized panel with smooth scrolling.

Inheritance
System.Object
ListBoxPanel
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.dll

Syntax

public class ListBoxPanel : VirtualizingPanel, IScrollInfo, IPanelKeyboardHelper

Constructors

ListBoxPanel()

Initializes a new instance of the ListBoxPanel class.

Declaration
public ListBoxPanel()

Fields

ChildDefaultLengthProperty

Represents the ChildDefaultLength property.

Declaration
public static readonly DependencyProperty ChildDefaultLengthProperty
Field Value
System.Windows.DependencyProperty

Properties

CanHorizontallyScroll

FeedsPanel reacts to this property by changing its child measurement algorithm. If scrolling in a dimension, infinite space is allowed the child; otherwise, available size is preserved.

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

CanVerticallyScroll

FeedsPanel reacts to this property by changing its child measurement algorithm. If scrolling in a dimension, infinite space is allowed the child; otherwise, available size is preserved.

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

ChildDefaultLength

Gets or sets the expected length (width or height) for the items of the panel. This is a dependency property.

Declaration
public double ChildDefaultLength { get; set; }
Property Value
System.Double

Remarks

The value of this property should be as close as possible to the header height of the TreeViewItem.

ExtentHeight

ExtentHeight contains the vertical size of the scrolled content element in 1/96".

Declaration
public double ExtentHeight { get; }
Property Value
System.Double

ExtentWidth

ExtentWidth contains the horizontal size of the scrolled content element in 1/96".

Declaration
public double ExtentWidth { get; }
Property Value
System.Double

HorizontalOffset

HorizontalOffset is the horizontal offset of the scrolled content in 1/96".

Declaration
public double HorizontalOffset { get; }
Property Value
System.Double

ScrollOwner

ScrollOwner is the container that controls any scrollbars, headers, etc... that are dependant on this IScrollInfo's properties.

Declaration
public ScrollViewer ScrollOwner { get; set; }
Property Value
System.Windows.Controls.ScrollViewer

VerticalOffset

VerticalOffset is the vertical offset of the scrolled content in 1/96".

Declaration
public double VerticalOffset { get; }
Property Value
System.Double

ViewportHeight

ViewportHeight contains the vertical size of content's visible range in 1/96" .

Declaration
public double ViewportHeight { get; }
Property Value
System.Double

ViewportWidth

ViewportWidth contains the horizontal size of content's visible range in 1/96".

Declaration
public double ViewportWidth { get; }
Property Value
System.Double

Methods

ArrangeOverride(Size)

Arranges the override.

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
System.Windows.Size finalSize

Size of the arrange.
Returns
System.Windows.Size

BringIndexIntoView(Int32)

Generates the item at the specified index and calls BringIntoView on it.

Declaration
protected override void BringIndexIntoView(int index)
Parameters
System.Int32 index

Specify the item index that should become visible.
Exceptions
System.ArgumentOutOfRangeException

Thrown if index is out of range.

LineDown()

Scroll content by one line to the bottom. Subclasses can override this method and call SetVerticalOffset to change the behavior of what "line" means.

Declaration
public virtual void LineDown()

LineLeft()

Scroll content by one line to the left. Subclasses can override this method and call SetHorizontalOffset to change the behavior of what "line" means.

Declaration
public virtual void LineLeft()

LineRight()

Scroll content by one line to the right. Subclasses can override this method and call SetHorizontalOffset to change the behavior of what "line" means.

Declaration
public virtual void LineRight()

LineUp()

Scroll content by one line to the top. Subclasses can override this method and call SetVerticalOffset to change the behavior of what "line" means.

Declaration
public virtual void LineUp()

MakeVisible(Visual, Rect)

FeedsPanel implementation of System.Windows.Controls.Primitives.IScrollInfo.MakeVisible(System.Windows.Media.Visual,System.Windows.Rect).

Declaration
public Rect MakeVisible(Visual visual, Rect rectangle)
Parameters
System.Windows.Media.Visual visual

System.Windows.Rect rectangle

Returns
System.Windows.Rect

Remarks

The goal is to change offsets to bring the child into view, and return a rectangle in our space to make visible. The rectangle we return is in the physical dimension the input target rectangle transformed into our pace. In the logical dimension, it is our immediate child's rectangle.

MeasureOverride(Size)

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the System.Windows.FrameworkElement-derived class.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

Returns
System.Windows.Size

MouseWheelDown()

Scroll content by one page to the bottom. Subclasses can override this method and call SetVerticalOffset to change the behavior of the mouse wheel increment.

Declaration
public virtual void MouseWheelDown()

MouseWheelLeft()

Scroll content by one page to the left. Subclasses can override this method and call SetHorizontalOffset to change the behavior of the mouse wheel increment.

Declaration
public virtual void MouseWheelLeft()

MouseWheelRight()

Scroll content by one page to the right. Subclasses can override this method and call SetHorizontalOffset to change the behavior of the mouse wheel increment.

Declaration
public virtual void MouseWheelRight()

MouseWheelUp()

Scroll content by one page to the top. Subclasses can override this method and call SetVerticalOffset to change the behavior of the mouse wheel increment.

Declaration
public virtual void MouseWheelUp()

OnClearChildren()

Called when the UI collection of children is cleared by the base Panel class.

Declaration
protected override void OnClearChildren()

OnItemsChanged(Object, ItemsChangedEventArgs)

Called when the Items collection associated with the containing ItemsControl changes.

Declaration
protected override void OnItemsChanged(object sender, ItemsChangedEventArgs args)
Parameters
System.Object sender

Sender.
System.Windows.Controls.Primitives.ItemsChangedEventArgs args

Event arguments.

PageDown()

Scroll content by one page to the bottom. Subclasses can override this method and call SetVerticalOffset to change the behavior of what "page" means.

Declaration
public virtual void PageDown()

PageLeft()

Scroll content by one page to the left. Subclasses can override this method and call SetHorizontalOffset to change the behavior of what "page" means.

Declaration
public virtual void PageLeft()

PageRight()

Scroll content by one page to the right. Subclasses can override this method and call SetHorizontalOffset to change the behavior of what "page" means.

Declaration
public virtual void PageRight()

PageUp()

Scroll content by one page to the top. Subclasses can override this method and call SetVerticalOffset to change the behavior of what "page" means.

Declaration
public virtual void PageUp()

SetHorizontalOffset(Double)

Set the HorizontalOffset to the passed value.

Declaration
public void SetHorizontalOffset(double offset)
Parameters
System.Double offset

SetVerticalOffset(Double)

Set the VerticalOffset to the passed value.

Declaration
public void SetVerticalOffset(double offset)
Parameters
System.Double offset

Extension Methods