UWP

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridColumn - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridColumn

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

    Inheritance
    System.Object
    SfGridColumnBase<SfGridBase>
    GridColumnBase
    GridColumn
    GridCheckBoxColumn
    GridComboBoxColumn
    GridImageColumn
    GridTextColumnBase
    GridToggleSwitchColumn
    GridUpDownColumn
    Implements
    System.IDisposable
    INotifyDependencyPropertyChanged
    IFilterDefinition
    Inherited Members
    GridColumnBase.ActualWidthProperty
    GridColumnBase.MappingNameProperty
    GridColumnBase.HeaderTextProperty
    GridColumnBase.AllowEditingProperty
    GridColumnBase.IsReadOnlyProperty
    GridColumnBase.GridValidationModeProperty
    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.GridValidationMode
    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
    SfGridColumnBase<SfGridBase>.Dispose()
    Namespace: Syncfusion.UI.Xaml.Grid
    Assembly: Syncfusion.SfGrid.UWP.dll
    Syntax
    [ClassReference(IsReviewed = false)]
    public abstract class GridColumn : GridColumnBase, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinition

    Constructors

    GridColumn()

    Declaration
    protected GridColumn()

    Fields

    AllowBlankFiltersProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.AllowBlankFilters dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.AllowBlankFilters dependency property.

    AllowDraggingProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.AllowDragging dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.AllowDragging dependency property.

    AllowFilteringProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.AllowFiltering dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.AllowFiltering dependency property.

    AllowGroupingProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.AllowGrouping dependency property.

    Declaration
    public static readonly DependencyProperty AllowGroupingProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.AllowGrouping dependency property.

    AllowResizingProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.AllowResizing dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.AllowResizing dependency property.

    ColumnSizerProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.ColumnSizer dependency property.

    Declaration
    public static readonly DependencyProperty ColumnSizerProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.ColumnSizer dependency property.

    FilterPopupStyleProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.FilterPopupStyle dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.FilterPopupStyle dependency property.

    FilterPopupTemplateProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.FilterPopupTemplate dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.FilterPopupTemplate dependency property.

    FilterRowCellStyleProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowCellStyle dependency property.

    Declaration
    public static readonly DependencyProperty FilterRowCellStyleProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowCellStyle dependency property.

    FilterRowConditionProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowCondition dependency property.

    Declaration
    public static readonly DependencyProperty FilterRowConditionProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowCondition dependency property.

    FilterRowOptionsVisibilityProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowOptionsVisibility dependency property.

    Declaration
    public static readonly DependencyProperty FilterRowOptionsVisibilityProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowOptionsVisibility dependency property.

    FilterRowTextProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowText dependency property.

    Declaration
    public static readonly DependencyProperty FilterRowTextProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.FilterRowText dependency property.

    GroupModeProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.GroupMode dependency property.

    Declaration
    public static readonly DependencyProperty GroupModeProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.GroupMode dependency property.

    ImmediateUpdateColumnFilterProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.ImmediateUpdateColumnFilter dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.ImmediateUpdateColumnFilter dependency property.

    IsCaseSensitiveFilterRowProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.IsCaseSensitiveFilterRow dependency property.

    Declaration
    public static readonly DependencyProperty IsCaseSensitiveFilterRowProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.IsCaseSensitiveFilterRow dependency property.

    SortModeProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.SortMode dependency property.

    Declaration
    public static readonly DependencyProperty SortModeProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.SortMode dependency property.

    UseBindingValueProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumn.UseBindingValue dependency property.

    Declaration
    public static readonly DependencyProperty UseBindingValueProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty
    Remarks

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumn.UseBindingValue 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 false.

    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
    AllowDraggingColumns

    AllowFiltering

    Gets or sets a value that indicates whether to enable UI Filtering in column header to filter the column.

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

    true if the UI filtering is enabled in the column ; otherwise, false.The default value is false.

    See Also
    AllowFiltering

    AllowGrouping

    Gets or sets a value indicates whether the user can drag and drop the column to GroupDropArea.

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

    true if the user can drag and drop the column to GroupDropArea; otherwise, false. The default value is true .

    See Also
    AllowGrouping

    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 .

    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 populated for the filter control in the column. By default, the filter value is populated based on property.

    ColumnMemberType

    Gets or sets the member type to load the appropriate AdvancedFilterType to AdvancedFilterControl .

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

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

    Remarks

    By default, the AdvancedFilterControl loads TextFilter , when the underlying data source is dynamic. So , you can decide the appropriate AdvancedFilterType by using this property based on its member type. For example, the TextFilter for string type , NumberFilter for numeric type and the DateFilter for DateTime type of member.

    ColumnSizer

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

    Declaration
    public GridLengthUnitType ColumnSizer { get; set; }
    Property Value
    Type Description
    GridLengthUnitType

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

    DataGrid

    Gets the reference to the SfDataGrid control.

    Declaration
    protected SfDataGrid DataGrid { get; }
    Property Value
    Type Description
    SfDataGrid

    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 enumeration that specifies the filter behavior of the column.

    Remarks

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

    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; set; }
    Property Value
    Type Description
    FilteredFrom

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

    FilterPopupStyle

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

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

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

    Remarks

    To define a for filter pop-up, specify a TargetType of GridFilterControl.

    See Also
    FilterPopupStyle

    FilterPopupTemplate

    Gets or sets that defines the visual representation of the filter pop-up in GridColumn.

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

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

    See Also
    FilterPopupTemplate

    FilterPredicates

    Gets the collection of FilterPredicate in the column.

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

    The collection of filter predicate in the column.

    FilterRowCellStyle

    Gets or sets the style applied to the FilterRow cell of the column.

    Declaration
    public Style FilterRowCellStyle { get; set; }
    Property Value
    Type Description
    Windows.UI.Xaml.Style

    The style that is applied to the FilterRow cell of the column. The default value is null.

    Remarks

    To define a for a FilterRow cell, specify a TargetType of GridFilterRowCell.

    FilterRowCondition

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

    FilterRowEditorType

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

    FilterRowOptionsVisibility

    Gets or sets a value that indicates whether the FilterRowOptions button is visible in the GridFilterRowCell.

    Declaration
    public Visibility FilterRowOptionsVisibility { get; set; }
    Property Value
    Type Description
    Windows.UI.Xaml.Visibility

    One of the enumeration that specifies the FilterRowOptions button visiblity in GridFilterRowCell; The default value is Visibility.Visible .

    FilterRowText

    Gets the filtered value of the particular column where the filtering has been applied through FilterRow.

    Declaration
    public object FilterRowText { get; protected set; }
    Property Value
    Type Description
    System.Object

    The filtered value that is applied FilterRow in the particular column.

    GroupMode

    Gets or sets a value that decides whether grouping is processed based on display value or edit value of column.

    Declaration
    public DataReflectionMode GroupMode { get; set; }
    Property Value
    Type Description
    DataReflectionMode

    Default Default mode performs default grouping operation based on value. Display Display mode performs grouping operation based on display value of column. Value Value mode performs grouping operation based on actual value of column.

    Remarks

    Group key is set based on property.

    ImmediateUpdateColumnFilter

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

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

    true if the data is filtered automatically ; otherwise false .The default value is false.

    IsCaseSensitiveFilterRow

    Gets or sets value that indicates whether the case sensitive filtering is enabled on FilterRowCell of a particular column.

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

    true if the case sensitive filtering is enabled on the FilterRowCell of a column; otherwise , false. The default value is false.

    SortMode

    Gets or sets a value that decides whether sorting is processed based on display value or edit value of column.

    Declaration
    public DataReflectionMode SortMode { get; set; }
    Property Value
    Type Description
    DataReflectionMode

    Default Default mode performs default sorting operation based on value. Display Display mode performs sorting operation based on display value of column. Value Value mode performs sorting operation based on actual value of column.

    UseBindingValue

    Gets or sets a value that indicates whether the binding gets property value from column wrapper instead of reflecting value from the item properties.

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

    true if the property value gets from column wrapper; otherwise, false . The default value is false.

    Remarks

    This property helps to perform sorting , filtering ,grouping operations on complex or indexer properties.

    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 .

    CanEditCell(Int32)

    Determines whether the column is editable.

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

    Returns true if all the cells with in the column is editable .

    CanEndEditColumn()

    Checks whether the column is boolean type or not.

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

    false

    Remarks

    override this method in corresponding boolean column and returns true.

    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 SfDataGrid and Columns.

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

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

    Overrides
    GridColumnBase.Dispose(Boolean)

    GetFilterRowOptionsVisibility()

    Gets the value that indicates the visibility of FilterOption button.

    Declaration
    protected virtual Visibility GetFilterRowOptionsVisibility()
    Returns
    Type Description
    Windows.UI.Xaml.Visibility

    Returns Visible if FilterOptions is required for the particular FilterRowCell.

    GetRowFilterType()

    Gets the AdvancedFilterType of the parituclar column

    Declaration
    protected virtual string GetRowFilterType()
    Returns
    Type Description
    System.String

    Returns the editor type which need to be load in GridFilterRowCell.

    IsHiddenColumn()

    Determines whether the corresponding column is hidden or not.

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

    Returns true if the column is hidden or width is zero otherwise false.

    OnCellTemplateChanged(DependencyPropertyChangedEventArgs)

    Invoked when the dependency property value changed in the column.

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

    The that contains data for CellTemplate dependency property changes.

    Overrides
    GridColumnBase.OnCellTemplateChanged(DependencyPropertyChangedEventArgs)

    OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs)

    Invoked when the CellTemplateSelector dependency property is changed in column.

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

    The that contains data for the CellTemplateSelector dependency property changes.

    Overrides
    GridColumnBase.OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs)

    OnDependencyPropertyChanged(String, DependencyPropertyChangedEventArgs)

    Invoked whenever the value of any dependency property in the column has been updated.

    Declaration
    public void OnDependencyPropertyChanged(string propertyName, DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.String propertyName

    The property name that has changed in column.

    Windows.UI.Xaml.DependencyPropertyChangedEventArgs e

    that contains the data for various dependency property changed events.

    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.

    SetDisplayBindingConverter()

    Sets the converter for the DisplayBinding of column.

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

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

    SetFilterRowText(String)

    Set the FilterRowText while applying the Filtered from FilterRow

    Declaration
    protected virtual void SetFilterRowText(string filterRowText)
    Parameters
    Type Name Description
    System.String filterRowText

    FilterText of that column

    UpdateBindingBasedOnAllowEditing()

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

    Implements

    System.IDisposable
    INotifyDependencyPropertyChanged
    IFilterDefinition

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved