Class TreeDataColumnBase

Represents a class that provides the base implementation for Data columns in SfTreeGrid.

Inheritance
System.Object
TreeDataColumnBase
TreeDataColumn
Implements
System.ComponentModel.INotifyPropertyChanged
System.IComparable
System.IDisposable
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public abstract class TreeDataColumnBase : Object, ITreeDataColumnElement, IElement, INotifyPropertyChanged, IComparable, IDisposable

Constructors

TreeDataColumnBase()

Declaration
protected TreeDataColumnBase()

Properties

ColumnElement

Gets or sets the column element.

Declaration
public FrameworkElement ColumnElement { get; }
Property Value
Type
Microsoft.UI.Xaml.FrameworkElement

ColumnIndex

Gets or sets the column index.

Declaration
public int ColumnIndex { get; }
Property Value
Type
System.Int32

ColumnSpan

Gets the ColumnSpan

Declaration
public int ColumnSpan { get; }
Property Value
Type
System.Int32

ColumnType

Gets or sets the column type.

Declaration
public TreeColumnType ColumnType { get; set; }
Property Value
Type
TreeColumnType

DataRow

Gets or sets the Data row.

Declaration
protected TreeDataRowBase DataRow { get; set; }
Property Value
Type
TreeDataRowBase

Element

Gets the FrameWork element.

Declaration
public FrameworkElement Element { get; }
Property Value
Type
Microsoft.UI.Xaml.FrameworkElement

Index

Gets the Index.

Declaration
public int Index { get; }
Property Value
Type
System.Int32

IsCurrentCell

Gets or sets a value indicating whether the current cell selection is visible or not..

Declaration
public bool IsCurrentCell { get; set; }
Property Value
Type Description
System.Boolean

true if this instance ; otherwise, false.

IsEditing

Gets or sets a value indicating whether the column is in editing or not.

Declaration
public bool IsEditing { get; }
Property Value
Type
System.Boolean

Renderer

Gets or sets the renderer.

Declaration
public ITreeGridCellRenderer Renderer { get; }
Property Value
Type
ITreeGridCellRenderer

RowIndex

Gets or sets the Row index.

Declaration
public int RowIndex { get; }
Property Value
Type
System.Int32

RowSpan

Gets the RowSpan of the Column

Declaration
public int RowSpan { get; }
Property Value
Type
System.Int32

TreeGridColumn

Gets or sets the TreeGridColumn.

Declaration
public TreeGridColumn TreeGridColumn { get; }
Property Value
Type
TreeGridColumn

Methods

CompareTo(Object)

Compares this instance to a specified object.

Declaration
public int CompareTo(object obj)
Parameters
Type Name Description
System.Object obj

The specified object.
Returns
Type Description
System.Int32

An integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.

Dispose()

Disposes all the resources used by the TreeDataColumnBase class.

Declaration
public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the TreeDataColumnBase class.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Indicates whether the call is from Dispose method or from a finalizer.

OnInitializeColumnElement(Object, Boolean)

Prepares the Column element based on the Visible column

Declaration
protected abstract FrameworkElement OnInitializeColumnElement(object dataContext, bool IsInEdit)
Parameters
Type Name Description
System.Object dataContext
System.Boolean IsInEdit
Returns
Type
Microsoft.UI.Xaml.FrameworkElement

UpdateBinding(Object, Boolean)

Method which is update the binding and style information of the cell when we recycle the cell for scrolling.

Declaration
public abstract void UpdateBinding(object dataContext, bool updateCellStyle = true)
Parameters
Type Name Description
System.Object dataContext
System.Boolean updateCellStyle

UpdateCellStyle()

When we scroll the Grid vertically row's will be recycled. While recycling we need to update the style info of all the cell's in old row. This property change call back will update the style info of all the cell element when the row index changed.

Declaration
public abstract void UpdateCellStyle()

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged
System.IComparable
System.IDisposable