Class GridTemplateColumn

Represents a column that contains template-specified cell content

Inheritance
System.Object
SfGridColumnBase<SfGridBase>
GridColumnBase
GridColumn
GridTextColumnBase
GridTemplateColumn
GridCheckBoxSelectorColumn
GridUnBoundColumn
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class GridTemplateColumn : GridTextColumnBase, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinition

Constructors

GridTemplateColumn()

Initializes a new instance of the GridTemplateColumn class.

Declaration
public GridTemplateColumn()

Fields

EditTemplateProperty

Identifies the EditTemplate dependency property.

Declaration
public static readonly DependencyProperty EditTemplateProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the EditTemplate dependency property.

EditTemplateSelectorProperty

Identifies the EditTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty EditTemplateSelectorProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the EditTemplateSelector dependency property.

HorizontalAlignmentProperty

Identifies the HorizontalAlignment dependency property.

Declaration
public static readonly DependencyProperty HorizontalAlignmentProperty
Field Value
Type
System.Windows.DependencyProperty
Remarks

The identifier for the HorizontalAlignment dependency property.

Properties

EditTemplate

Gets or sets the System.Windows.DataTemplate to load in editing mode.

Declaration
public DataTemplate EditTemplate { get; set; }
Property Value
Type Description
System.Windows.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 decides whether the data context of the EditTemplate is based on Record or DataContextHelper class.
By default, Record will be the DataContext for template. If SetCellBoundValue is true, DataContextHelper will be the data context.

See Also

EditTemplateSelector

Gets or sets the System.Windows.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
System.Windows.Controls.DataTemplateSelector

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

HorizontalAlignment

Gets or sets the horizontal alignment for the column.

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

One of the System.Windows.HorizontalAlignment enumeration that specifies the horizontal alignment of the column. The default value is System.Windows.HorizontalAlignment.

Methods

CanEditCell(Int32)

Determines whether the cells in GridTemplateColumn can be edited.

Declaration
protected override bool CanEditCell(int rowIndex = -1)
Parameters
Type Name Description
System.Int32 rowIndex

The corresponding rowIndex of the editable cell.
Returns
Type Description
System.Boolean

Returns true if the template column has loaded with EditTemplate or EditTemplateSelector. If the GridTemplateColumn loaded with , 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 dependency property value changed in the GridTemplateColumn.

Declaration
public static void OnEditTemplateChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyObject d

The DependencyObject that contains the GridTemplateColumn.
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs that contains the data for the EditTemplate property changes.

OnEditTemplateSelectorChanged(DependencyObject, DependencyPropertyChangedEventArgs)

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

Declaration
public static void OnEditTemplateSelectorChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyObject d

The DependencyObject that contains the GridTemplateColumn.
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs that contains the data for the EditTemplateSelector property changes.

SetDisplayBindingConverter()

Sets the converter for the of GridTemplateColumn.

Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks

You can override this method to specify the converter for .

UpdateBindingBasedOnAllowEditing()

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

Declaration
protected override void UpdateBindingBasedOnAllowEditing()
Overrides

Implements

System.IDisposable