Class DataColumnBase

Represents a class that provides the base implementation of Data columns in SfDataGrid.

Inheritance
System.Object
DataColumnBase
DataColumn
SpannedDataColumn
Implements
System.ComponentModel.INotifyPropertyChanged
System.IComparable
System.IDisposable
Namespace: Syncfusion.UI.Xaml.DataGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public abstract class DataColumnBase : Object, IColumnElement, IElement, INotifyPropertyChanged, IComparable, IDisposable

Constructors

DataColumnBase()

Declaration
protected DataColumnBase()

Properties

ColumnElement

Gets or sets the columnElement value.

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 or sets the ColumnSpan value.

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

Element

Gets the base element for Windows runtime UI objects.

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

GridCellRegion

Gets or Sets the GridCellRegion value.

Declaration
public GridCellRegion GridCellRegion { get; set; }
Property Value
Type
GridCellRegion

GridColumn

Gets or sets the GridColumn.

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

GridUnBoundRowEventsArgs

which holds the UnBoudnRowCell proeprties.

Declaration
public GridUnboundRowEventsArgs GridUnBoundRowEventsArgs { get; }
Property Value
Type
GridUnboundRowEventsArgs

IndentColumnType

Gets or sets the type of Indent column.

Declaration
public IndentColumnType IndentColumnType { get; set; }
Property Value
Type
IndentColumnType

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 current cell is in editing or not.

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

IsSelectedColumn

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

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

IsSpannedColumn

Gets a value indicating whether the column is spanned or not.

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

Renderer

Gets or sets the IGridCellRenderer.

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

RowIndex

Gets or sets the row index.

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

RowSpan

Gets or sets the RowSpan value.

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

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 DataColumnBase class.

Declaration
public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the DataColumnBase 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.

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

OnPropertyChanged(String)

Invoked when the specified property changed.

Declaration
public void OnPropertyChanged(string propertyName)
Parameters
Type Name Description
System.String propertyName

The specified property.

SetBindings(UIElement)

Sets the binding of the specified columnElement.

Declaration
protected void SetBindings(UIElement columnElement)
Parameters
Type Name Description
Microsoft.UI.Xaml.UIElement columnElement

The specified column element.

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(Object)

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(object dataContext)
Parameters
Type Name Description
System.Object dataContext

Events

PropertyChanged

Occurs when a property changed.

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

Implements

System.ComponentModel.INotifyPropertyChanged
System.IComparable
System.IDisposable