WinUI

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridTemplateColumn

    Show / Hide Table of Contents

    Class GridTemplateColumn

    Represents a column that contains template-specified cell content

    Inheritance
    System.Object
    ColumnBase<SfGridBase>
    GridColumnBase
    GridColumn
    GridTextColumnBase
    GridTemplateColumn
    GridCheckBoxSelectorColumn
    GridUnboundColumn
    Implements
    System.IDisposable
    INotifyDependencyPropertyChanged
    IFilterDefinition
    Inherited Members
    GridTextColumnBase.TextTrimmingProperty
    GridTextColumnBase.TextWrappingProperty
    GridTextColumnBase.TextTrimming
    GridTextColumnBase.TextWrapping
    GridColumn.FilterRowCellStyleProperty
    GridColumn.UseBindingValueProperty
    GridColumn.ColumnWidthModeProperty
    GridColumn.AllowDraggingProperty
    GridColumn.AllowGroupingProperty
    GridColumn.AllowResizingProperty
    GridColumn.AllowFilteringProperty
    GridColumn.ImmediateUpdateColumnFilterProperty
    GridColumn.FilterRowOptionsVisibilityProperty
    GridColumn.FilterRowConditionProperty
    GridColumn.FilterPopupStyleProperty
    GridColumn.FilterPopupTemplateProperty
    GridColumn.AllowBlankFiltersProperty
    GridColumn.FilterRowTextProperty
    GridColumn.IsCaseSensitiveFilterRowProperty
    GridColumn.GroupModeProperty
    GridColumn.SortModeProperty
    GridColumn.OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs)
    GridColumn.OnCellTemplateChanged(DependencyPropertyChangedEventArgs)
    GridColumn.CanAllowSpinOnMouseScroll()
    GridColumn.Dispose(Boolean)
    GridColumn.GetRowFilterType()
    GridColumn.GetFilterRowOptionsVisibility()
    GridColumn.SetCellType(String)
    GridColumn.IsHiddenColumn()
    GridColumn.CanEndEditColumn()
    GridColumn.SetFilterRowText(String)
    GridColumn.OnDependencyPropertyChanged(String, DependencyPropertyChangedEventArgs)
    GridColumn.ColumnMemberType
    GridColumn.FilterRowCellStyle
    GridColumn.UseBindingValue
    GridColumn.ColumnWidthMode
    GridColumn.AllowDragging
    GridColumn.AllowGrouping
    GridColumn.AllowResizing
    GridColumn.AllowFiltering
    GridColumn.ImmediateUpdateColumnFilter
    GridColumn.FilterRowOptionsVisibility
    GridColumn.FilterRowCondition
    GridColumn.FilterPopupStyle
    GridColumn.FilterPopupTemplate
    GridColumn.AllowBlankFilters
    GridColumn.FilterRowText
    GridColumn.IsCaseSensitiveFilterRow
    GridColumn.GroupMode
    GridColumn.SortMode
    GridColumn.CellType
    GridColumn.FilteredFrom
    GridColumn.DataGrid
    GridColumn.FilterPredicates
    GridColumn.FilterBehavior
    GridColumn.ColumnFilter
    GridColumn.FilterRowEditorType
    GridColumnBase.ActualWidthProperty
    GridColumnBase.MappingNameProperty
    GridColumnBase.HeaderTextProperty
    GridColumnBase.AllowEditingProperty
    GridColumnBase.IsReadOnlyProperty
    GridColumnBase.DataValidationModeProperty
    GridColumnBase.UpdateTriggerProperty
    GridColumnBase.PaddingProperty
    GridColumnBase.AllowFocusProperty
    GridColumnBase.HeaderTemplateProperty
    GridColumnBase.CellTemplateProperty
    GridColumnBase.SetCellBoundValueProperty
    GridColumnBase.CellTemplateSelectorProperty
    GridColumnBase.CellStyleProperty
    GridColumnBase.CellStyleSelectorProperty
    GridColumnBase.HeaderStyleProperty
    GridColumnBase.AllowSortingProperty
    GridColumnBase.VerticalAlignmentProperty
    GridColumnBase.TextAlignmentProperty
    GridColumnBase.HorizontalHeaderContentAlignmentProperty
    GridColumnBase.WidthProperty
    GridColumnBase.IsHiddenProperty
    GridColumnBase.MaximumWidthProperty
    GridColumnBase.MinimumWidthProperty
    GridColumnBase.ShowHeaderToolTipProperty
    GridColumnBase.ToolTipTemplateProperty
    GridColumnBase.HeaderToolTipTemplateProperty
    GridColumnBase.ToolTipTemplateSelectorProperty
    GridColumnBase.ShowToolTipProperty
    GridColumnBase.SetCellBoundToolTipProperty
    GridColumnBase.OnUpdateBindingInfo(DependencyObject, DependencyPropertyChangedEventArgs)
    GridColumnBase.SetValueBindingConverter()
    GridColumnBase.CanEditCell()
    GridColumnBase.UpdateBindingForValidation(GridValidationMode)
    GridColumnBase.IsAutoGenerated
    GridColumnBase.IsTemplate
    GridColumnBase.ActualWidth
    GridColumnBase.MappingName
    GridColumnBase.HeaderText
    GridColumnBase.AllowEditing
    GridColumnBase.IsReadOnly
    GridColumnBase.DataValidationMode
    GridColumnBase.UpdateTrigger
    GridColumnBase.Padding
    GridColumnBase.AllowFocus
    GridColumnBase.HeaderTemplate
    GridColumnBase.CellTemplate
    GridColumnBase.SetCellBoundValue
    GridColumnBase.CellTemplateSelector
    GridColumnBase.CellStyle
    GridColumnBase.CellStyleSelector
    GridColumnBase.HeaderStyle
    GridColumnBase.AllowSorting
    GridColumnBase.VerticalAlignment
    GridColumnBase.TextAlignment
    GridColumnBase.HorizontalHeaderContentAlignment
    GridColumnBase.Width
    GridColumnBase.IsHidden
    GridColumnBase.MaximumWidth
    GridColumnBase.MinimumWidth
    GridColumnBase.ValueBinding
    GridColumnBase.DisplayBinding
    GridColumnBase.ShowHeaderToolTip
    GridColumnBase.ToolTipTemplate
    GridColumnBase.HeaderToolTipTemplate
    GridColumnBase.ToolTipTemplateSelector
    GridColumnBase.ShowToolTip
    GridColumnBase.SetCellBoundToolTip
    ColumnBase<SfGridBase>.Dispose()
    Namespace: Syncfusion.UI.Xaml.DataGrid
    Assembly: Syncfusion.Grid.WinUI.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 Description
    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 Description
    Microsoft.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the EditTemplateSelector dependency property.

    HorizontalAlignmentProperty

    Identifies the HorizontalAlignment dependency property.

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

    The identifier for the HorizontalAlignment 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.DataGrid.Renderers.DataContextHelper class.
    By default, Record will be the DataContext for template. If SetCellBoundValue is true, Syncfusion.UI.Xaml.DataGrid.Renderers.DataContextHelper will be the data context.

    Examples
    <syncfusion:SfDataGrid x:Name="dataGrid"                                                                       
                          AutoGenerateColumns="False" 
                          ItemsSource="{Binding Orders}">
       <syncfusion:SfDataGrid.Columns>
           <syncfusion:GridTemplateColumn MappingName="CustomerID">           
               <syncfusion:GridTemplateColumn.CellTemplate>
                   <DataTemplate>
                       <TextBlock Text="{Binding CustomerID}" />
                   </DataTemplate>
               </syncfusion:GridTemplateColumn.CellTemplate>
               <syncfusion:GridTemplateColumn.EditTemplate>
                   <DataTemplate>
                       <TextBox Text="{Binding CustomerID, Mode=TwoWay}" />
                   </DataTemplate>
               </syncfusion:GridTemplateColumn.EditTemplate>        
               </syncfusion:GridTemplateColumn>       
       </syncfusion:SfDataGrid.Columns>
    </syncfusion:SfDataGrid>
    See Also
    CellTemplateSelector
    CellTemplate

    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.

    Examples
    public class CustomEditTemplateSelector : DataTemplateSelector
    {
       protected override DataTemplate SelectTemplateCore(object item, DependencyObject container)
       {
    
           if (item == null)
               return null;
    
           var data = item as OrderInfo;
           if (data.OrderID % 2 == 0)
               return Appliaction.Current.Resources["AlternateEditTemplate"] as DataTemplate;
           else
               return Application.Current.Resources["DefaultEditTemplate"] as DataTemplate;
       }
    }
    <Page.Resources>    
       <local:CustomEditTemplateSelector x:Key="editTemplateSelector" />
    </Page.Resources>
    <syncfusion:SfDataGrid x:Name="dataGrid"                                                                       
                          AutoGenerateColumns="False" 
                          ItemsSource="{Binding Orders}">
       <syncfusion:SfDataGrid.Columns>
           <syncfusion:GridTemplateColumn MappingName = "OrderID"
                                          EditTemplateSelector="{StaticResource editTemplateSelector}"/>
       </syncfusion:SfDataGrid.Columns>
    </syncfusion:SfDataGrid>
    See Also
    EditTemplate
    CellTemplateSelector
    CellTemplate

    HorizontalAlignment

    Gets or sets the horizontal alignment for the column .

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

    One of the Microsoft.UI.Xaml.HorizontalAlignment enumeration that specifies the horizontal alignment of the column. The default value is Microsoft.UI.Xaml.HorizontalAlignment.Stretch.

    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 CellTemplate ,returns false.

    Overrides
    GridColumn.CanEditCell(Int32)

    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
    GridColumn.CanFocus()

    OnEditTemplateChanged(DependencyObject, DependencyPropertyChangedEventArgs)

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

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

    The DependencyObject that contains the GridTemplateColumn.

    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 GridTemplateColumn.

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

    The DependencyObject that contains the GridTemplateColumn.

    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 GridTemplateColumn.

    Declaration
    protected override void SetDisplayBindingConverter()
    Overrides
    GridTextColumnBase.SetDisplayBindingConverter()
    Remarks

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

    UpdateBindingBasedOnAllowEditing()

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

    Declaration
    protected override void UpdateBindingBasedOnAllowEditing()
    Overrides
    GridColumn.UpdateBindingBasedOnAllowEditing()

    Implements

    System.IDisposable
    INotifyDependencyPropertyChanged
    IFilterDefinition
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved