Class TreeGridTemplateColumn

Represents a column that contains template-specified cell content

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

Constructors

TreeGridTemplateColumn()

Initializes a new instance of the TreeGridTemplateColumn class.

Declaration
public TreeGridTemplateColumn()

Fields

EditTemplateProperty

Identifies the EditTemplate dependency property.

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

The identifier for the EditTemplate dependency property.

EditTemplateSelectorProperty

Identifies the EditTemplateSelector dependency property.

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

The identifier for the EditTemplateSelector dependency property.

Properties

EditTemplate

Gets or sets the Microsoft.UI.Xaml.DataTemplate to load in editing mode.

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

The template that is used to display the contents of cell in a column that is in editing mode. The default is null.
Remarks

The SetCellBoundValue decides whether the data context of the EditTemplate is based on Record or Syncfusion.UI.Xaml.TreeGrid.Renderers.TreeGridDataContextHelper class.
By default, Record will be the DataContext for template. If SetCellBoundValue is true, Syncfusion.UI.Xaml.TreeGrid.Renderers.TreeGridDataContextHelper will be the data context.

Examples
<treeGrid:SfTreeGrid Name = "treeGrid"
               ChildPropertyName="ReportsTo"
               ItemsSource="{Binding Employees}"
               ParentPropertyName="ID">
   <treeGrid:SfTreeGrid.Columns>
       <treeGrid:TreeGridTemplateColumn MappingName = "FirstName" HeaderText="First Name">
           <treeGrid:TreeGridTemplateColumn.CellTemplate>
               <DataTemplate>
                   <TextBlock Text = "{Binding FirstName}" />
               </ DataTemplate >
           </ treeGrid:TreeGridTemplateColumn.CellTemplate>
           <treeGrid:TreeGridTemplateColumn.EditTemplate>
               <DataTemplate>
                   <TextBox Text = "{Binding FirstName}" />
               </ DataTemplate >
           </ treeGrid:TreeGridTemplateColumn.EditTemplate>
       </treeGrid:TreeGridTemplateColumn>
   </treeGrid:SfTreeGrid.Columns>
</treeGrid:SfTreeGrid>
See Also

EditTemplateSelector

Gets or sets the Microsoft.UI.Xaml.DataTemplate by choosing a template based on bound data objects and data-bound element in editing mode.

Declaration
public DataTemplateSelector EditTemplateSelector { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.Controls.DataTemplateSelector

A custom Microsoft.UI.Xaml.Controls.DataTemplateSelector object that provides logic and returns a Microsoft.UI.Xaml.DataTemplate that is in edit mode of column. The default is null.
See Also

Methods

CanEditCell()

Determines whether the cells in TreeGridTemplateColumn can be edited.

Declaration
protected override bool CanEditCell()
Returns
Type Description
System.Boolean

Returns true if the template column has loaded with EditTemplate or EditTemplateSelector. If the TreeGridTemplateColumn loaded with CellTemplate , returns false.
Overrides

CanFocus()

Determines whether the GridTemplateColumn can receive focus.

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

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

OnEditTemplateChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Dependency call back for EditTemplate property. Invoked when the EditTemplate dependency property value changed in the TreeGridTemplateColumn.

Declaration
public static void OnEditTemplateChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.DependencyObject d

The DependencyObject that contains the TreeGridTemplateColumn.
Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs e

The Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs that contains the data for the EditTemplate property changes.

OnEditTemplateSelectorChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Dependency call back for EditTemplateSelector property. Invoked when the EditTemplateSelector dependency property value changed in the TreeGridTemplateColumn.

Declaration
public static void OnEditTemplateSelectorChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.DependencyObject d

The DependencyObject that contains the TreeGridTemplateColumn.
Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs e

The Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs that contains the data for the EditTemplateSelector property changes.

SetDisplayBindingConverter()

Sets the converter for the DisplayBinding of TreeGridTemplateColumn.

Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks

You can override this method to specify the converter for DisplayBinding.

UpdateBindingBasedOnAllowEditing()

Updates the binding for the AllowEdit property changes in the TreeGridTemplateColumn.

Declaration
protected override void UpdateBindingBasedOnAllowEditing()
Overrides

Implements

System.IDisposable