Class TreeGridColumn

Provides the base functionalities for all the column types in SfTreeGrid.

Inheritance
System.Object
ColumnBase<SfGridBase>
GridColumnBase
TreeGridColumn
TreeGridCheckBoxColumn
TreeGridComboBoxColumn
TreeGridTextColumnBase
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public abstract class TreeGridColumn : GridColumnBase, IDisposable, IFilterDefinition

Constructors

TreeGridColumn()

Declaration
protected TreeGridColumn()

Fields

AllowBlankFiltersProperty

Identifies the AllowBlankFilters dependency. property.

Declaration
public static readonly DependencyProperty AllowBlankFiltersProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the AllowBlankFilters dependency property.

AllowDraggingProperty

Identifies the AllowDragging dependency. property.

Declaration
public static readonly DependencyProperty AllowDraggingProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the AllowDragging dependency property.

AllowFilteringProperty

Identifies the AllowFiltering dependency. property.

Declaration
public static readonly DependencyProperty AllowFilteringProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the AllowFiltering dependency property.

AllowResizingProperty

Identifies the AllowResizing dependency. property.

Declaration
public static readonly DependencyProperty AllowResizingProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the AllowResizing dependency property.

ColumnWidthModeProperty

Identifies the ColumnWidthMode dependency. property.

Declaration
public static readonly DependencyProperty ColumnWidthModeProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ColumnWidthMode dependency property.

FilterPopupStyleProperty

Identifies the FilterPopupStyle dependency property.

Declaration
public static readonly DependencyProperty FilterPopupStyleProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the FilterPopupStyle dependency property.

FilterPopupTemplateProperty

Identifies the FilterPopupTemplate dependency. property.

Declaration
public static readonly DependencyProperty FilterPopupTemplateProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the FilterPopupTemplate dependency property.

ImmediateUpdateColumnFilterProperty

Identifies the ImmediateUpdateColumnFilter dependency property.

Declaration
public static readonly DependencyProperty ImmediateUpdateColumnFilterProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ImmediateUpdateColumnFilter dependency property.

Properties

AllowBlankFilters

Get or sets a value that indicates whether the blank values are allowed for filtering in column.

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

true if the blank values are allowed for filtering in column; otherwise, false. The default value is true.
See Also

AllowDragging

Gets or sets a value that indicates whether the user can rearrange the columns.

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

true if the user can re arrange the columns; otherwise, false. The default value is false .
See Also

AllowFiltering

Gets or sets a value that indicates whether UI filtering is enabled in TreeGridColumn.

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

True if UI filtering is enabled; otherwise false. The default value is false.
Remarks

This property will takes higher priority than AllowFiltering property. The filtering operation can be canceled or customized through FilterChanging and FilterChanged events in SfDataGrid.

See Also

AllowResizing

Gets or sets a value that indicates whether the user can resize the column.

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

true if the user can adjust the column width; otherwise, false. The default value is false .
Remarks

This property will takes higher priority than AllowResizingColumns property.

See Also

CellType

Gets the cell type of the column which denotes renderer associated with column.

Declaration
public string CellType { get; }
Property Value
Type Description
System.String

A string that represents the cell type of the column.

ColumnFilter

Gets or sets a value that decides whether to filter based on display value or based on MappingName.

Declaration
public ColumnFilter ColumnFilter { get; set; }
Property Value
Type Description
ColumnFilter

One of the ColumnFilter enumeration that decides how the items should populated for the filter control in the column.
See Also

ColumnMemberType

Gets or sets the member type to load the appropriate filter type to the FilterControl.

Declaration
public Type ColumnMemberType { get; set; }
Property Value
Type Description
System.Type

The type that loads the appropriate AdvancedFilterType to AdvancedFilterControl in column.
See Also

ColumnWidthMode

Gets or sets the value that indicates how the column width is determined.

Declaration
public ColumnWidthMode ColumnWidthMode { get; set; }
Property Value
Type Description
ColumnWidthMode

One of the ColumnWidthMode enumeration that adjust the column width. The default value is None.
Remarks

This property will takes higher priority than ColumnWidthMode property.

FilterBehavior

Gets or sets a value that decides whether filter value should be considered as string type or its underlying type while filtering.

Declaration
public FilterBehavior FilterBehavior { get; set; }
Property Value
Type Description
FilterBehavior

One of the FilterBehavior enumeration that specifies the filter behavior of the column.
Remarks

The Advanced Filter UI will be loaded based on this property.

See Also

FilteredFrom

Gets a value that determines whether the column is filtered from Check box filter UI or Advanced filter in UI Filtering.

Declaration
public FilteredFrom FilteredFrom { get; }
Property Value
Type Description
FilteredFrom

One of FilteredFrom enumeration that specifies when the column is from .
See Also

FilterPopupStyle

Gets or sets the style applied to the filter popup in TreeGridColumn.

Declaration
public Style FilterPopupStyle { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.Style

The style that is applied to the filter pop-up in TreeGridColumn. The default value is null.
Remarks

This property will takes higher priority than FilterPopupStyle property. To define a Microsoft.UI.Xaml.Style for filter pop-up, specify a TargetType of TreeGridFilterControl.

See Also

FilterPopupTemplate

Gets or sets Microsoft.UI.Xaml.DataTemplate that defines the visual representation of the filter pop-up in TreeGridColumn.

Declaration
public DataTemplate FilterPopupTemplate { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.DataTemplate

The object that defines the visual representation of the filter pop-up in TreeGridColumn. The default value is null.
Remarks

This property will takes higher priority than FilterPopupTemplate property.

See Also

FilterPredicates

Gets the collection of FilterPredicate added to the column.

Declaration
public ObservableCollection<FilterPredicate> FilterPredicates { get; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<FilterPredicate>

ImmediateUpdateColumnFilter

Gets or sets a value that indicates whether the data is automatically filtered as soon as the user selects or types value in the filter pop-up of column.

Declaration
public bool ImmediateUpdateColumnFilter { get; set; }
Property Value
Type
System.Boolean
See Also

TreeGrid

Gets the reference to the SfTreeGrid control.

Declaration
protected SfTreeGrid TreeGrid { get; }
Property Value
Type
SfTreeGrid

Methods

CanAllowSpinOnMouseScroll()

Determines whether to increment and decrement the cell value in mouse wheel and up,down arrow key is pressed.

Declaration
protected virtual bool CanAllowSpinOnMouseScroll()
Returns
Type Description
System.Boolean

Returns true if the cell value can be rotated using mouse wheel or up and down arrow key ; otherwise false .

CanFocus()

Determines whether the corresponding column can receive focus.

Declaration
protected virtual bool CanFocus()
Returns
Type Description
System.Boolean

Returns true if the column is loaded with editor in its CellTemplate.

Dispose(Boolean)

Releases all resources used by the SfTreeGrid and Columns.

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

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

OnCellTemplateChanged(DependencyPropertyChangedEventArgs)

Invoked when the CellTemplate dependency property value changed in the column.

Declaration
protected override void OnCellTemplateChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs e

The Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs that contains data for CellTemplate dependency property changes.
Overrides

OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs)

Invoked when the CellTemplateSelector dependency property is changed in column.

Declaration
protected override void OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs e

The Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs that contains data for the CellTemplateSelector dependency property changes.
Overrides

SetCellType(String)

Sets the cell type which indicates the renderer for the column.

Declaration
protected void SetCellType(string cellType)
Parameters
Type Name Description
System.String cellType

Specifies the corresponding cell type of the column.

UpdateBindingBasedOnAllowEditing()

Updates the binding based on the allowediting.

Declaration
protected override void UpdateBindingBasedOnAllowEditing()
Overrides

Implements

System.IDisposable