Class TreeNodesContainerBase

This is a scrollable node container base that holds the item elements. And handles the arrange and measure logic of all elements.

Inheritance

System.Object

TreeNodesContainerBase

TreeNodeContainer

Implements

System.Windows.Controls.Primitives.IScrollInfo

Namespace: Syncfusion.UI.Xaml.TreeView

Assembly: Syncfusion.SfTreeView.WPF.dll

Syntax

public class TreeNodesContainerBase : Panel, IScrollInfo

Properties

CanHorizontallyScroll

Gets or sets a value indicating whether gets or sets a value that indicates whether the TreeNodeContainer can scroll horizontally.

Declaration

public bool CanHorizontallyScroll { get; set; }

Property Value

Type	Description
System.Boolean	true if th TreeNodeContainer scrolled horizontally; otherwise, false;

CanVerticallyScroll

Gets or sets a value indicating whether gets or sets a value that indicates whether the TreeNodeContainer can scroll vertically.

Declaration

public bool CanVerticallyScroll { get; set; }

Property Value

Type	Description
System.Boolean	true if the TreeNodeContainer scrolled vertically; otherwise, false;

ExtentHeight

Gets the vertical size of the extent.

Declaration

public double ExtentHeight { get; }

Property Value

Type
System.Double

ExtentWidth

Gets the horizontal size of the extent.

Declaration

public double ExtentWidth { get; }

Property Value

Type
System.Double

HorizontalOffset

Gets the horizontal offset.

Declaration

public double HorizontalOffset { get; }

Property Value

Type
System.Double

HScrollBar

Gets the horizontal scrollbar.

Declaration

public ScrollInfo HScrollBar { get; }

Property Value

Type
ScrollInfo

ScrollOwner

Gets or sets a reference to the System.Windows.Controls.ScrollViewer instance.

Declaration

public ScrollViewer ScrollOwner { get; set; }

Property Value

Type
System.Windows.Controls.ScrollViewer

ScrollRows

Gets or sets a reference to the ScrollAxisBase instance which contains the information of row lines.

Declaration

public ScrollAxisBase ScrollRows { get; }

Property Value

Type
ScrollAxisBase

VerticalOffset

Gets the vertical offset.

Declaration

public double VerticalOffset { get; }

Property Value

Type
System.Double

ViewportHeight

Gets the vertical size of the viewport.

Declaration

public double ViewportHeight { get; }

Property Value

Type
System.Double

ViewportWidth

Gets the horizontal size of the viewport.

Declaration

public double ViewportWidth { get; }

Property Value

Type
System.Double

VScrollBar

Gets the vertical scrollbar.

Declaration

public ScrollInfo VScrollBar { get; }

Property Value

Type
ScrollInfo

Methods

CreateScrollAxis(Boolean, IScrollBar, ILineSizeHost)

Creates a new instance of ScrollAxisBase.

Declaration

protected virtual ScrollAxisBase CreateScrollAxis(bool pixelScroll, IScrollBar scrollBar, ILineSizeHost lineSizes)

Parameters

Type	Name	Description
System.Boolean	pixelScroll	A boolean value denoting pixel or line scrolling.
IScrollBar	scrollBar	The scroll bar.
ILineSizeHost	lineSizes	The line sizes.

Returns

Type	Description
ScrollAxisBase	Returns the ScrollAxisBase.

Dispose()

Dispose all the allocated resources.

Declaration

public void Dispose()

Dispose(Boolean)

Dispose the instances, if parameter is true.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Represents the boolean value for disposing objects.

LineDown()

Scrolls the content of TreeNodesContainerBase down by one line.

Declaration

public void LineDown()

LineLeft()

Scrolls the content of TreeNodesContainerBase to left by one line.

Declaration

public void LineLeft()

LineRight()

Scrolls the content of TreeNodesContainerBase to right by one line.

Declaration

public void LineRight()

LineUp()

Scrolls the content of TreeNodesContainerBase up by one line.

Declaration

public void LineUp()

MakeVisible(Visual, Rect)

Scrolls to the specified coordinates and makes that part of a System.Windows.Media.Visual visible.

Declaration

public Rect MakeVisible(Visual visual, Rect rectangle)

Parameters

Type	Name	Description
System.Windows.Media.Visual	visual	The System.Windows.Media.Visual that becomes visible.
System.Windows.Rect	rectangle	The System.Windows.Rect that represents coordinate space within a visual.

Returns

Type	Description
System.Windows.Rect	Returns the rectangle.

MouseWheelDown()

Scrolls the content of TreeNodesContainerBase logically downward in response to a downward click of the mouse wheel button.

Declaration

public void MouseWheelDown()

MouseWheelLeft()

Scrolls the content of TreeNodesContainerBase logically to left in response to a left click of the mouse wheel button.

Declaration

public void MouseWheelLeft()

MouseWheelRight()

Scrolls the content of TreeNodesContainerBase logically to right in response to a right click of the mouse wheel button.

Declaration

public void MouseWheelRight()

MouseWheelUp()

Scrolls the content of TreeNodesContainerBase logically upward in response to a upward click of the mouse wheel button.

Declaration

public void MouseWheelUp()

PageDown()

Scrolls the content of TreeNodesContainerBase downward by one page.

Declaration

public void PageDown()

PageLeft()

Scrolls the content of TreeNodesContainerBase to the left by one page.

Declaration

public void PageLeft()

PageRight()

Scrolls the content of TreeNodesContainerBase to the right by one page.

Declaration

public void PageRight()

PageUp()

Scrolls the content of TreeNodesContainerBase upward by one page.

Declaration

public void PageUp()

SetHorizontalOffset(Double)

Sets the amount of horizontal offset.

Declaration

public void SetHorizontalOffset(double offset)

Parameters

Type	Name	Description
System.Double	offset	The degree to which content is horizontally offset from the containing viewport.

SetVerticalOffset(Double)

Sets the amount of vertical offset.

Declaration

public void SetVerticalOffset(double offset)

Parameters

Type	Name	Description
System.Double	offset	The degree to which content is vertically offset from the containing viewport.

Implements

System.Windows.Controls.Primitives.IScrollInfo