Table of Contents

Class VirtualizingPanelBase

Namespace
WpfToolkit.Controls
Assembly
VirtualizingWrapPanel.dll

Base class for panels which are supporting virtualization.

public abstract class VirtualizingPanelBase : VirtualizingPanel, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IAddChild, IScrollInfo
Inheritance
VirtualizingPanelBase
Implements
Derived
Inherited Members

Fields

MouseWheelDeltaItemProperty 

public static readonly DependencyProperty MouseWheelDeltaItemProperty

Field Value

DependencyProperty

MouseWheelDeltaProperty 

public static readonly DependencyProperty MouseWheelDeltaProperty

Field Value

DependencyProperty

ScrollLineDeltaItemProperty 

public static readonly DependencyProperty ScrollLineDeltaItemProperty

Field Value

DependencyProperty

ScrollLineDeltaProperty 

public static readonly DependencyProperty ScrollLineDeltaProperty

Field Value

DependencyProperty

Properties

CanHorizontallyScroll

Gets or sets a value that indicates whether scrolling on the horizontal axis is possible.

public bool CanHorizontallyScroll { get; set; }

Property Value

bool

true if scrolling is possible; otherwise, false. This property has no default value.

CanVerticallyScroll

Gets or sets a value that indicates whether scrolling on the vertical axis is possible.

public bool CanVerticallyScroll { get; set; }

Property Value

bool

true if scrolling is possible; otherwise, false. This property has no default value.

Extent 

protected Size Extent { get; set; }

Property Value

Size

ExtentHeight

Gets the vertical size of the extent.

public double ExtentHeight { get; }

Property Value

double

A double that represents, in device independent pixels, the vertical size of the extent.This property has no default value.

ExtentWidth

Gets the horizontal size of the extent.

public double ExtentWidth { get; }

Property Value

double

A double that represents, in device independent pixels, the horizontal size of the extent. This property has no default value.

HorizontalOffset

Gets the horizontal offset of the scrolled content.

public double HorizontalOffset { get; }

Property Value

double

A double that represents, in device independent pixels, the horizontal offset. This property has no default value.

IsRecycling

Returns true if the panel is in VirtualizationMode.Recycling, otherwise false.

protected bool IsRecycling { get; }

Property Value

bool

IsVirtualizing 

protected bool IsVirtualizing { get; }

Property Value

bool

ItemContainerGenerator 

protected ItemContainerGenerator ItemContainerGenerator { get; }

Property Value

ItemContainerGenerator

Items 

protected ReadOnlyCollection<object> Items { get; }

Property Value

ReadOnlyCollection<object>

ItemsControl

The ItemsControl (e.g. ListView).

public ItemsControl ItemsControl { get; }

Property Value

ItemsControl

ItemsOwner

The ItemsControl (e.g. ListView) or if the ItemsControl is grouping a GroupItem.

protected DependencyObject ItemsOwner { get; }

Property Value

DependencyObject

MouseWheelDelta

Mouse wheel delta for pixel based scrolling. The default value is 48 dp.

public double MouseWheelDelta { get; set; }

Property Value

double

MouseWheelDeltaItem

Mouse wheel delta for item based scrolling. The default value is 3 items.

public int MouseWheelDeltaItem { get; set; }

Property Value

int

MouseWheelScrollDirection

The direction in which the panel scrolls when user turns the mouse wheel.

protected ScrollDirection MouseWheelScrollDirection { get; set; }

Property Value

ScrollDirection

RecyclingItemContainerGenerator 

protected IRecyclingItemContainerGenerator RecyclingItemContainerGenerator { get; }

Property Value

IRecyclingItemContainerGenerator

ScrollLineDelta

Scroll line delta for pixel based scrolling. The default value is 16 dp.

public double ScrollLineDelta { get; set; }

Property Value

double

ScrollLineDeltaItem

Scroll line delta for item based scrolling. The default value is 1 item.

public int ScrollLineDeltaItem { get; set; }

Property Value

int

ScrollOffset 

protected Point ScrollOffset { get; set; }

Property Value

Point

ScrollOwner

Gets or sets a ScrollViewer element that controls scrolling behavior.

public ScrollViewer? ScrollOwner { get; set; }

Property Value

ScrollViewer

A ScrollViewer element that controls scrolling behavior. This property has no default value.

ScrollUnit 

protected ScrollUnit ScrollUnit { get; }

Property Value

ScrollUnit

VerticalOffset

Gets the vertical offset of the scrolled content.

public double VerticalOffset { get; }

Property Value

double

A double that represents, in device independent pixels, the vertical offset of the scrolled content. Valid values are between zero and the ExtentHeight minus the ViewportHeight. This property has no default value.

ViewportHeight

Gets the vertical size of the viewport for this content.

public double ViewportHeight { get; }

Property Value

double

A double that represents, in device independent pixels, the vertical size of the viewport for this content. This property has no default value.

ViewportSize 

protected Size ViewportSize { get; set; }

Property Value

Size

ViewportWidth

Gets the horizontal size of the viewport for this content.

public double ViewportWidth { get; }

Property Value

double

A double that represents, in device independent pixels, the horizontal size of the viewport for this content. This property has no default value.

VirtualizationMode 

protected VirtualizationMode VirtualizationMode { get; }

Property Value

VirtualizationMode

Methods

GetLineDownScrollAmount() 

protected abstract double GetLineDownScrollAmount()

Returns

double

GetLineLeftScrollAmount() 

protected abstract double GetLineLeftScrollAmount()

Returns

double

GetLineRightScrollAmount() 

protected abstract double GetLineRightScrollAmount()

Returns

double

GetLineUpScrollAmount() 

protected abstract double GetLineUpScrollAmount()

Returns

double

GetMouseWheelDownScrollAmount() 

protected abstract double GetMouseWheelDownScrollAmount()

Returns

double

GetMouseWheelLeftScrollAmount() 

protected abstract double GetMouseWheelLeftScrollAmount()

Returns

double

GetMouseWheelRightScrollAmount() 

protected abstract double GetMouseWheelRightScrollAmount()

Returns

double

GetMouseWheelUpScrollAmount() 

protected abstract double GetMouseWheelUpScrollAmount()

Returns

double

GetPageDownScrollAmount() 

protected abstract double GetPageDownScrollAmount()

Returns

double

GetPageLeftScrollAmount() 

protected abstract double GetPageLeftScrollAmount()

Returns

double

GetPageRightScrollAmount() 

protected abstract double GetPageRightScrollAmount()

Returns

double

GetPageUpScrollAmount() 

protected abstract double GetPageUpScrollAmount()

Returns

double

LineDown()

Scrolls down within content by one logical unit.

public void LineDown()

LineLeft()

Scrolls left within content by one logical unit.

public void LineLeft()

LineRight()

Scrolls right within content by one logical unit.

public void LineRight()

LineUp()

Scrolls up within content by one logical unit.

public void LineUp()

MakeVisible(Visual, Rect)

Forces content to scroll until the coordinate space of a Visual object is visible.

public virtual Rect MakeVisible(Visual visual, Rect rectangle)

Parameters

visual Visual

A Visual that becomes visible.

rectangle Rect

A bounding rectangle that identifies the coordinate space to make visible.

Returns

Rect

A Rect that is visible.

MouseWheelDown()

Scrolls down within content after a user clicks the wheel button on a mouse.

public void MouseWheelDown()

MouseWheelLeft()

Scrolls left within content after a user clicks the wheel button on a mouse.

public void MouseWheelLeft()

MouseWheelRight()

Scrolls right within content after a user clicks the wheel button on a mouse.

public void MouseWheelRight()

MouseWheelUp()

Scrolls up within content after a user clicks the wheel button on a mouse.

public void MouseWheelUp()

PageDown()

Scrolls down within content by one page.

public void PageDown()

PageLeft()

Scrolls left within content by one page.

public void PageLeft()

PageRight()

Scrolls right within content by one page.

public void PageRight()

PageUp()

Scrolls up within content by one page.

public void PageUp()

SetHorizontalOffset(double)

Sets the amount of horizontal offset.

public void SetHorizontalOffset(double offset)

Parameters

offset double

The degree to which content is horizontally offset from the containing viewport.

SetVerticalOffset(double)

Sets the amount of vertical offset.

public void SetVerticalOffset(double offset)

Parameters

offset double

The degree to which content is vertically offset from the containing viewport.

ShouldIgnoreMeasure() 

protected bool ShouldIgnoreMeasure()

Returns

bool
Edit this page