Class TreeGridPanel
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class TreeGridPanel : Panel, IDisposable
Constructors
TreeGridPanel()
Declaration
public TreeGridPanel()
Fields
HortizontalScrollBarOffsetProperty
The hortizontal offset property
Declaration
public static readonly DependencyProperty HortizontalScrollBarOffsetProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
VerticalScrollBarOffsetProperty
The vertical offset property
Declaration
public static readonly DependencyProperty VerticalScrollBarOffsetProperty
Field Value
Type |
---|
Microsoft.UI.Xaml.DependencyProperty |
Properties
CanHorizontallyScroll
Gets or sets a value indicating whether the scrollbar can be horizontally scrolled or not.
Declaration
public bool CanHorizontallyScroll { get; set; }
Property Value
Type |
---|
System.Boolean |
CanVerticallyScroll
Gets or sets a value indicating whether the scrollbar can be vertically scrolled or not.
Declaration
public bool CanVerticallyScroll { get; set; }
Property Value
Type |
---|
System.Boolean |
ColumnCount
Declaration
public int ColumnCount { get; set; }
Property Value
Type |
---|
System.Int32 |
ColumnWidths
Declaration
public IPaddedEditableLineSizeHost ColumnWidths { get; }
Property Value
ExtentHeight
Gets the extent height.
Declaration
public double ExtentHeight { get; }
Property Value
Type |
---|
System.Double |
ExtentWidth
Gets the extent width.
Declaration
public double ExtentWidth { get; }
Property Value
Type |
---|
System.Double |
FooterColumns
Declaration
public int FooterColumns { get; set; }
Property Value
Type |
---|
System.Int32 |
FooterRows
Declaration
public int FooterRows { get; set; }
Property Value
Type |
---|
System.Int32 |
FrozenColumns
Declaration
public int FrozenColumns { get; set; }
Property Value
Type |
---|
System.Int32 |
FrozenRows
Declaration
public int FrozenRows { get; set; }
Property Value
Type |
---|
System.Int32 |
HorizontalOffset
Gets the Horizontal offset.
Declaration
public double HorizontalOffset { get; }
Property Value
Type |
---|
System.Double |
HorizontalPadding
Declaration
public double HorizontalPadding { get; set; }
Property Value
Type |
---|
System.Double |
HorizontalPixelScroll
Declaration
public bool HorizontalPixelScroll { get; set; }
Property Value
Type |
---|
System.Boolean |
HortizontalScrollBarOffset
Gets or sets the hortizontal offset.
Declaration
public double HortizontalScrollBarOffset { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The hortizontal offset. |
HScrollBar
Declaration
public ScrollInfo HScrollBar { get; }
Property Value
Type |
---|
ScrollInfo |
RowCount
Declaration
public int RowCount { get; set; }
Property Value
Type |
---|
System.Int32 |
RowGenerator
Declaration
public ITreeGridRowGenerator RowGenerator { get; }
Property Value
RowHeights
Declaration
public IPaddedEditableLineSizeHost RowHeights { get; }
Property Value
ScrollColumns
Declaration
public ScrollAxisBase ScrollColumns { get; }
Property Value
Type |
---|
ScrollAxisBase |
ScrollOwner
Gets or sets the scroll viewer.
Declaration
public ScrollViewer ScrollOwner { get; set; }
Property Value
Type |
---|
Microsoft.UI.Xaml.Controls.ScrollViewer |
ScrollRows
Declaration
public ScrollAxisBase ScrollRows { get; }
Property Value
Type |
---|
ScrollAxisBase |
VerticalOffset
Gets the vertical offset.
Declaration
public double VerticalOffset { get; }
Property Value
Type |
---|
System.Double |
VerticalPadding
Declaration
public double VerticalPadding { get; set; }
Property Value
Type |
---|
System.Double |
VerticalPixelScroll
Declaration
public bool VerticalPixelScroll { get; set; }
Property Value
Type |
---|
System.Boolean |
VerticalScrollBarOffset
Gets or sets the vertical offset.
Declaration
public double VerticalScrollBarOffset { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The vertical offset. |
ViewportHeight
Gets the height of view port.
Declaration
public double ViewportHeight { get; }
Property Value
Type |
---|
System.Double |
ViewportWidth
Gets the width of view port.
Declaration
public double ViewportWidth { get; }
Property Value
Type |
---|
System.Double |
VScrollBar
Declaration
public ScrollInfo VScrollBar { get; }
Property Value
Type |
---|
ScrollInfo |
Methods
ArrangeOverride(Size)
Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
Type | Name | Description |
---|---|---|
Windows.Foundation.Size | finalSize |
Returns
Type |
---|
Windows.Foundation.Size |
CreateScrollAxis(Orientation, Boolean, IScrollBar, ILineSizeHost)
Declaration
protected virtual ScrollAxisBase CreateScrollAxis(Orientation orientation, bool pixelScroll, IScrollBar scrollBar, ILineSizeHost lineSizes)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.UI.Xaml.Controls.Orientation | orientation | |
System.Boolean | pixelScroll | |
IScrollBar | scrollBar | |
ILineSizeHost | lineSizes |
Returns
Type |
---|
ScrollAxisBase |
Dispose()
Disposes all the resources used by the TreeGridPanel class.
Declaration
public void Dispose()
Dispose(Boolean)
Disposes all the resources used by the TreeGridPanel class.
Declaration
protected virtual void Dispose(bool isDisposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isDisposing | Indicates whether the call is from Dispose method or from a finalizer. |
InsertColumns(Int32, Int32)
Declaration
public void InsertColumns(int insertAtColumnIndex, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | insertAtColumnIndex | |
System.Int32 | count |
InsertRows(Int32, Int32)
Declaration
public void InsertRows(int insertAtRowIndex, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | insertAtRowIndex | |
System.Int32 | count |
InvalidateMeasureInfo()
Invalidates the measurement.
Declaration
public void InvalidateMeasureInfo()
LineDown()
Scrolls the ScrollViewer content downward by one line.
Declaration
public void LineDown()
LineLeft()
Scrolls the ScrollViewer content to the left by a predetermined amount.
Declaration
public void LineLeft()
LineRight()
Scrolls the ScrollViewer content to the right by a predetermined amount.
Declaration
public void LineRight()
LineUp()
Scrolls the ScrollViewer content upward by one line.
Declaration
public void LineUp()
MakeVisible(UIElement, Rect)
Forces content to scroll until the coordinate space of a Visual object is visible.
Declaration
public Rect MakeVisible(UIElement visual, Rect rectangle)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.UI.Xaml.UIElement | visual | The visual that becomes visible. |
Windows.Foundation.Rect | rectangle | The bounding rectangle that identifies the coordinate space to make visible. |
Returns
Type | Description |
---|---|
Windows.Foundation.Rect | A rectangle that represents the visible region. |
MeasureOverride(Size)
Provides the behaviour for the "Measure" pass of the layout cycle.
Declaration
protected override Size MeasureOverride(Size constraint)
Parameters
Type | Name | Description |
---|---|---|
Windows.Foundation.Size | constraint | The available size that this object can give to child objects.Infinity can be specified as a value to indicate that the object will to size whatever the content is available. |
Returns
Type | Description |
---|---|
Windows.Foundation.Size | The Size that this object determines it needs during layout,based on its calculations of the allocated sizes for child objects or based on other considerations such as a fixed container size. |
MouseWheelDown()
Invoked to scroll downwards.
Declaration
public void MouseWheelDown()
MouseWheelLeft()
Invoked to scroll leftwards.
Declaration
public void MouseWheelLeft()
MouseWheelRight()
Invoked to scroll rightwards.
Declaration
public void MouseWheelRight()
MouseWheelUp()
Invoked to scroll upwards.
Declaration
public void MouseWheelUp()
OnContainerKeyDown(Object, KeyRoutedEventArgs)
Declaration
protected virtual void OnContainerKeyDown(object sender, KeyRoutedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
Microsoft.UI.Xaml.Input.KeyRoutedEventArgs | e |
OnCreateColumnWidths()
Declaration
protected virtual IPaddedEditableLineSizeHost OnCreateColumnWidths()
Returns
OnCreateRowHeights()
Declaration
protected virtual IPaddedEditableLineSizeHost OnCreateRowHeights()
Returns
PageDown()
Scrolls the ScrollViewer content downward by one page.
Declaration
public void PageDown()
PageLeft()
Scrolls the ScrollViewer content to the left by one page.
Declaration
public void PageLeft()
PageRight()
Scrolls the ScrollViewer content to the right by one page.
Declaration
public void PageRight()
PageUp()
Scrolls the ScrollViewer content upward by one page.
Declaration
public void PageUp()
PointToCellRowColumnIndex(Point, Boolean)
Determines the cell under the mouse location.
Declaration
public RowColumnIndex PointToCellRowColumnIndex(Point p, bool allowOutSideLines = false)
Parameters
Type | Name | Description |
---|---|---|
Windows.Foundation.Point | p | The point in client coordinates. |
System.Boolean | allowOutSideLines |
Returns
Type | Description |
---|---|
RowColumnIndex | The cells row and column index under the mouse location. |
RangeToRect(ScrollAxisRegion, ScrollAxisRegion, RowColumnIndex, Boolean, Boolean)
For internal use.
Declaration
public Rect RangeToRect(ScrollAxisRegion rowRegion, ScrollAxisRegion columnRegion, RowColumnIndex rowcolumn, bool allowEstimatesForOutOfViewRows, bool allowEstimatesForOutOfViewColumns)
Parameters
Type | Name | Description |
---|---|---|
ScrollAxisRegion | rowRegion | Scroll axis region for row. |
ScrollAxisRegion | columnRegion | Scroll axis region for column. |
RowColumnIndex | rowcolumn | TheRowColumnIndex. |
System.Boolean | allowEstimatesForOutOfViewRows | If set to true, allows estimate for out of view rows. |
System.Boolean | allowEstimatesForOutOfViewColumns | If set to true, allows estimate for out of view columns. |
Returns
Type | Description |
---|---|
Windows.Foundation.Rect | Visible rectangle for the given range. |
RemoveColumns(Int32, Int32)
Declaration
public void RemoveColumns(int removeAtColumnIndex, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | removeAtColumnIndex | |
System.Int32 | count |
RemoveRows(Int32, Int32)
Declaration
public void RemoveRows(int removeAtRowIndex, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | removeAtRowIndex | |
System.Int32 | count |
SetHorizontalOffset(Double)
Sets the Horizontal offset value.
Declaration
public void SetHorizontalOffset(double offset)
Parameters
Type | Name | Description |
---|---|---|
System.Double | offset |
SetVerticalOffset(Double)
Sets the Vertical offset value.
Declaration
public void SetVerticalOffset(double offset)
Parameters
Type | Name | Description |
---|---|---|
System.Double | offset | The corresponding offset. |
UpdateAxis(Size)
Updates available size to Renderer
Declaration
public void UpdateAxis(Size availableSize)
Parameters
Type | Name | Description |
---|---|---|
Windows.Foundation.Size | availableSize | The available size |