Class
ListBoxPanel

Represents a virtualized panel with smooth scrolling.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.dll

Syntax:

cs-api-definition
public class ListBoxPanel : VirtualizingPanel, IScrollInfo

Inheritance: objectListBoxPanel

Implements: IScrollInfo

Constructors

ListBoxPanel()

Initializes a new instance of the ListBoxPanel class.

Declaration

cs-api-definition
public ListBoxPanel()

Fields

ChildDefaultLengthProperty

Represents the ChildDefaultLength property.

Declaration

cs-api-definition
public static readonly DependencyProperty ChildDefaultLengthProperty

Field Value

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

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

Property Value

bool

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

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

Property Value

bool

ChildDefaultLength

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

Declaration

cs-api-definition
public double ChildDefaultLength { get; set; }

Property Value

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

cs-api-definition
public double ExtentHeight { get; }

Property Value

double

ExtentWidth

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

Declaration

cs-api-definition
public double ExtentWidth { get; }

Property Value

double

HorizontalOffset

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

Declaration

cs-api-definition
public double HorizontalOffset { get; }

Property Value

double

ScrollOwner

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

Declaration

cs-api-definition
public ScrollViewer ScrollOwner { get; set; }

Property Value

ScrollViewer

VerticalOffset

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

Declaration

cs-api-definition
public double VerticalOffset { get; }

Property Value

double

ViewportHeight

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

Declaration

cs-api-definition
public double ViewportHeight { get; }

Property Value

double

ViewportWidth

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

Declaration

cs-api-definition
public double ViewportWidth { get; }

Property Value

double

Methods

ArrangeOverride(Size)

Arranges the override.

Declaration

cs-api-definition
protected override Size ArrangeOverride(Size finalSize)

Parameters

finalSize

Size

Size of the arrange.

Returns

Size

BringIndexIntoView(int)

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

Declaration

cs-api-definition
protected override void BringIndexIntoView(int index)

Parameters

index

int

Specify the item index that should become visible.

Exceptions

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

cs-api-definition
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

cs-api-definition
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

cs-api-definition
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

cs-api-definition
public virtual void LineUp()

MakeVisible(Visual, Rect)

FeedsPanel implementation of .

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "TransformToVisual throws a general exception.")]
public Rect MakeVisible(Visual visual, Rect rectangle)

Parameters

visual

Visual

rectangle

Rect

Returns

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

cs-api-definition
protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize

Size

Returns

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

cs-api-definition
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

cs-api-definition
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

cs-api-definition
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

cs-api-definition
public virtual void MouseWheelUp()

OnClearChildren()

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

Declaration

cs-api-definition
protected override void OnClearChildren()

OnItemsChanged(object, ItemsChangedEventArgs)

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

Declaration

cs-api-definition
protected override void OnItemsChanged(object sender, ItemsChangedEventArgs args)

Parameters

sender

object

Sender.

args

ItemsChangedEventArgs

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

cs-api-definition
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

cs-api-definition
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

cs-api-definition
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

cs-api-definition
public virtual void PageUp()

SetHorizontalOffset(double)

Set the HorizontalOffset to the passed value.

Declaration

cs-api-definition
public void SetHorizontalOffset(double offset)

Parameters

offset

double

SetVerticalOffset(double)

Set the VerticalOffset to the passed value.

Declaration

cs-api-definition
public void SetVerticalOffset(double offset)

Parameters

offset

double