WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridColumnBase - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridColumnBase

    Inheritance
    System.Object
    SfGridColumnBase<SfGridBase>
    GridColumnBase
    GridColumn
    TreeGridColumn
    Implements
    System.IDisposable
    Inherited Members
    SfGridColumnBase<SfGridBase>.Dispose()
    Namespace: Syncfusion.UI.Xaml.Grid
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public abstract class GridColumnBase : SfGridColumnBase<SfGridBase>, IDisposable

    Constructors

    GridColumnBase()

    Declaration
    protected GridColumnBase()

    Fields

    ActualWidthProperty

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

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

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

    AllowEditingProperty

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

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

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

    AllowFocusProperty

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

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

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

    AllowSortingProperty

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

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

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

    CellStyleProperty

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

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

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

    CellStyleSelectorProperty

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

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

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

    CellTemplateProperty

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

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

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

    CellTemplateSelectorProperty

    Identifies the Syncfusion.UI.Xaml.Grid.TreeGridColumn.CellTemplateSelector dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.TreeGridColumn.CellTemplateSelector dependency property.

    GridValidationModeProperty

    Identifies the Syncfusion.UI.Xaml.Grid.GridColumnBase.GridValidationMode dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.GridColumnBase.GridValidationMode dependency property.

    HeaderStyleProperty

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

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

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

    HeaderTemplateProperty

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

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

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

    HeaderTextProperty

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

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

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

    HeaderToolTipTemplateProperty

    Identifies the HeaderToolTipTemplate dependency property.

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

    The identifier for the HeaderToolTipTemplate dependency property.

    HorizontalHeaderContentAlignmentProperty

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

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

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

    IsHiddenProperty

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

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

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

    IsReadOnlyProperty

    Declaration
    public static readonly DependencyProperty IsReadOnlyProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MappingNameProperty

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

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

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

    MaximumWidthProperty

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

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

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

    MinimumWidthProperty

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

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

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

    PaddingProperty

    Identifies the Syncfusion.UI.Xaml.Grid.TreeGridColumn.Padding dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.TreeGridColumn.Padding dependency property.

    SetCellBoundToolTipProperty

    Identifies the SetCellBoundToolTip dependency property.

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

    The identifier for the SetCellBoundToolTip dependency property.

    SetCellBoundValueProperty

    Identifies the Syncfusion.UI.Xaml.Grid.TreeGridColumn.SetCellBoundValue dependency property.

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

    The identifier for the Syncfusion.UI.Xaml.Grid.TreeGridColumn.SetCellBoundValue dependency property.

    ShowHeaderToolTipProperty

    Identifies the ShowHeaderToolTip dependency property.

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

    The identifier for the ShowHeaderToolTip dependency property.

    ShowToolTipProperty

    Identifies the ShowToolTip dependency property.

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

    The identifier for the ShowToolTip dependency property.

    TextAlignmentProperty

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

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

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

    ToolTipTemplateProperty

    Identifies the ToolTipTemplate dependency property.

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

    The identifier for the ToolTipTemplate dependency property.

    ToolTipTemplateSelectorProperty

    Identifies the ToolTipTemplateSelector dependency property.

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

    The identifier for the ToolTipTemplateSelector dependency property.

    UpdateTriggerProperty

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

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

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

    VerticalAlignmentProperty

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

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

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

    WidthProperty

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

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

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

    Properties

    ActualWidth

    Gets the actual width of the column.

    Declaration
    [Cloneable(false)]
    public double ActualWidth { get; }
    Property Value
    Type Description
    System.Double

    The actual width of the column.

    AllowEditing

    Gets or sets a value that indicates whether user can edit the cells of the column in SfDataGrid control.

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

    true if the user can edit the cell of the column; otherwise, false. The default value is false.

    AllowFocus

    Gets or sets a value that indicates whether the cells of the column enabled for user interaction like selection, editing and etc.

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

    true if the column allows user interactions like selection and editing; otherwise, false. The default value is true.

    AllowSorting

    Gets or sets a value that indicates whether the user can sort the data by clicking on its header cell of column.

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

    true if the user can sort the data by clicking column header; otherwise, false. The default value is true.

    CellStyle

    Gets or sets the style applied all the cells in column.

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

    The style that is applied to all the record cells in column. The default value is null.

    Remarks

    To define a System.Windows.Style for a cell, specify a TargetType of GridCell.

    See Also
    CellStyle

    CellStyleSelector

    Gets or sets the style applied to record cell conditionally based on data in GridColumn.

    Declaration
    public StyleSelector CellStyleSelector { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.StyleSelector

    A System.Windows.Controls.StyleSelector object that chooses the style to cell based on data. The default value is null.

    Remarks

    To define a System.Windows.Style for a cell, specify a TargetType of GridCell.

    See Also
    CellStyleSelector

    CellTemplate

    Gets or sets the System.Windows.DataTemplate that is used to display the contents of a cell that is in display mode.

    Declaration
    public DataTemplate CellTemplate { 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 display mode. The default value is null.

    Remarks

    The decides whether the data context of the CellTemplate is based on Record or class.
    By default ,the Record is set as the DataContext for template. If SetCellBoundValue is true, the will be set. To define template for a cell that is in edit mode, use EditTemplate.

    CellTemplateSelector

    Gets or sets the System.Windows.DataTemplate by choosing a template based on data.

    Declaration
    public DataTemplateSelector CellTemplateSelector { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.DataTemplateSelector

    A custom System.Windows.Controls.DataTemplateSelector object that chooses the System.Windows.DataTemplate based on data. The default value is null.

    See Also
    Syncfusion.UI.Xaml.Grid.TreeGridColumn.CellTemplate

    DisplayBinding

    Gets or sets the data item to bind to display element of column.

    Declaration
    public BindingBase DisplayBinding { get; set; }
    Property Value
    Type Description
    System.Windows.Data.BindingBase

    The specified data item that displays in the column.

    Remarks

    You can format the binding by setting System.Windows.Data.BindingBase.StringFormat or System.Windows.Data.Binding.Converter.

    GridValidationMode

    Gets or sets a value to enable the built-in validation (IDataErrorInfo/DataAnnonations) to validate the user input and displays the error.

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

    One of the GridValidationMode enumeration that specifies how the cells are validated with in the column. The default mode is None.

    Remarks

    The GridValidationMode process the built-in validations when data object implements System.ComponentModel.IDataErrorInfo,System.ComponentModel.INotifyDataErrorInfo and System.ComponentModel.DataAnnotations. The validation can also be done using CurrentCellValidating and RowValidating events in SfDataGrid and SfTreeGrid.

    See Also
    GridValidationMode

    HeaderStyle

    Gets or sets the style applied to the header cell in GridColumn.

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

    The style that is applied to the header cell in GridColumn. The default value is null.

    Remarks

    To define a System.Windows.Style for a header cell, specify a TargetType of GridHeaderCellControl.

    See Also
    HeaderStyle

    HeaderTemplate

    Gets or sets System.Windows.DataTemplate that defines the visual representation of the header cell in GridColumn.

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

    The object that defines the visual representation of the header cell in GridColumn. The default value is null.

    See Also
    HeaderTemplate

    HeaderText

    Gets or sets the text that is displayed on the header cell of column.

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

    A string that is displayed on the header cell of column.

    HeaderToolTipTemplate

    Gets or sets System.Windows.DataTemplate that defines the visual representation of tool tip for header cell in corresponding column.

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

    The object that defines the visual representation of tool tip for header cell in corresponding column. The default value is null.

    See Also
    ShowHeaderToolTip

    HorizontalHeaderContentAlignment

    Gets or sets the horizontal alignment for the header content of the column.

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

    One of the System.Windows.HorizontalAlignment enumeration that aligns the header content horizontally.

    IsAutoGenerated

    Gets a value that determines whether the column is generated automatically.

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

    true if the column is generated automatically ; otherwise , false.

    IsHidden

    Gets or sets a value that indicates whether the column is hidden from the view.

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

    true if the column is hidden from the view ; otherwise, false/>. The default value ,false.

    IsReadOnly

    Gets or sets the value that determines if the user can change the text in the GridCell.

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

    trueif the GridCell is in read-only state; otherwise, false. The default value is false.

    Remarks

    If the GridCell is read-only state, no user input or edits are allowed, but programmatic changes can be made. The user can still select text, and the key events events are marked as handled. The difference between the AllowEditing and IsReadOnly behavior is user input. AllowEditing allows the user inputs but IsReadOnly won't allow.

    IsTemplate

    Denotes whether the column is type of GridTemplateColumn.

    Declaration
    protected bool IsTemplate { get; set; }
    Property Value
    Type Description
    System.Boolean

    MappingName

    Gets or sets the name to map the data member in the underlying data object to SfDataGrid .

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

    The name that maps the data member in the underlying data object. The default value is null.

    MaximumWidth

    Gets or sets the upper bound for the width of the column.

    Declaration
    public double MaximumWidth { get; set; }
    Property Value
    Type Description
    System.Double

    The maximum width constraint for the column .The default value is Double.NaN .

    MinimumWidth

    Gets or sets the lower bound for the width of the column.

    Declaration
    public double MinimumWidth { get; set; }
    Property Value
    Type Description
    System.Double

    The minimum width constraint of the column . The default value is Double.NaN .

    Padding

    Gets or sets the space between the edge of the cell and its content of the column.

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

    The space between the edge of the cell and its content in the column.

    SetCellBoundToolTip

    Gets or sets a value that indicates whether the data context of ToolTipTemplate is DataContextHelper instead of Record.

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

    true if data context of tool tip template is based on DataContextHelper class;otherwise ,false. The default value is false.

    Remarks

    The SetCellBoundToolTip allows you to bind value based on MappingName property. So, you can reuse the same template to more than one columns. with regardless of MappingName.

    SetCellBoundValue

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

    ShowHeaderToolTip

    Gets or sets value that indicates whether the tool tip should be displayed when mouse hovered on the header cell.

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

    true if the tool tip is enabled on the header cell of column; otherwise, false. The default value is false.

    ShowToolTip

    Gets or sets value that indicates whether the tool tip is enabled in a particular column.

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

    true if the tool tip is enabled in the column; otherwise, false. The default value is false.

    TextAlignment

    Gets or sets the horizontal alignment property for the text.

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

    One of the System.Windows.TextAlignment enumeration that specifies the horizontal alignment for the text. The default value System.Windows.TextAlignment

    ToolTipTemplate

    Gets or sets the System.Windows.DataTemplate that defines the visual representation of a tool tip for the record cell in a corresponding column.

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

    The object that defines the visual representation of tool tip for the record cell in corresponding column. The default value is null.

    Remarks

    The SetCellBoundToolTip decides whether the data context of the ToolTipTemplate is based on record or DataContextHelper class.
    By default, record will be the DataContext of ToolTipTemplate. If SetCellBoundValue is true, the DataContextHelper will be act as data context.

    Examples
    <syncfusion:SfDataGrid x:Name="dataGrid" AutoGenerateColumns="False" ItemsSource="{Binding Orders}" >
       <syncfusion:SfDataGrid.Resources>
           <local:StringToImageConverter x:Key="ImageConverter" />
           <DataTemplate x:Key="TemplateToolTip">
               <Image Height="100" Width="100" Source="{Binding CustomerID,Converter={StaticResource ImageConverter}}" />
           </DataTemplate>
       </syncfusion:SfDataGrid.Resources>
    
       <syncfusion:SfDataGrid.Columns>
           <syncfusion:GridTextColumn HeaderText="Order ID"  ShowToolTip="True" MappingName="OrderID" />
           <syncfusion:GridTextColumn HeaderText="Customer ID" ToolTipTemplate="{StaticResource TemplateToolTip}" ShowToolTip="True" MappingName="CustomerID" />
       </syncfusion:SfDataGrid.Columns>
    </syncfusion:SfDataGrid>

    ToolTipTemplateSelector

    Gets or sets the System.Windows.Controls.DataTemplateSelector based on custom logic for tool-tip content.

    Declaration
    public DataTemplateSelector ToolTipTemplateSelector { 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. The default value is null.

    Remarks

    By default, the DataContext of the template is underlying business object. If is true, then will be the DataContext.

    UpdateTrigger

    Gets or sets the timing of binding source updates in the column.

    Declaration
    public UpdateSourceTrigger UpdateTrigger { get; set; }
    Property Value
    Type Description
    System.Windows.Data.UpdateSourceTrigger

    One of the System.Windows.Data.UpdateSourceTrigger enumeration that specifies the timing of binding updates. The default value is System.Windows.Data.UpdateSourceTrigger.Default .

    ValueBinding

    Gets or sets the data item to bind to the edit element of column.

    Declaration
    public BindingBase ValueBinding { get; set; }
    Property Value
    Type Description
    System.Windows.Data.BindingBase

    The specified data item that displays the edit element of column.

    Remarks

    You can format the binding by setting System.Windows.Data.Binding.Converter.

    VerticalAlignment

    Gets or sets the vertical alignment for the cells of the column.

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

    One of the System.Windows.VerticalAlignment enumeration that specifies the vertical alignment of the column. The default is System.Windows.VerticalAlignment

    Width

    Gets or sets the width of column .

    Declaration
    public double Width { get; set; }
    Property Value
    Type Description
    System.Double

    The width of column.

    Methods

    CanEditCell()

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

    CreateInstanceCore()

    Declaration
    protected override Freezable CreateInstanceCore()
    Returns
    Type Description
    System.Windows.Freezable
    Overrides
    Syncfusion.UI.Xaml.Grid.SfGridColumnBase<Syncfusion.UI.Xaml.Grid.SfGridBase>.CreateInstanceCore()

    Dispose(Boolean)

    Disposes all the resources used by the GridColumnBase class.

    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
    Syncfusion.UI.Xaml.Grid.SfGridColumnBase<Syncfusion.UI.Xaml.Grid.SfGridBase>.Dispose(System.Boolean)

    GetTypeface(GridColumnBase, GridCell)

    Gets Typeface to render the content of GridCell.

    Declaration
    protected virtual Typeface GetTypeface(GridColumnBase gridColumn, GridCell gridCell)
    Parameters
    Type Name Description
    GridColumnBase gridColumn
    GridCell gridCell
    Returns
    Type Description
    System.Windows.Media.Typeface

    OnCellTemplateChanged(DependencyPropertyChangedEventArgs)

    Declaration
    protected virtual void OnCellTemplateChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs)

    Invoked when the dependency property is changed in column.

    Declaration
    protected virtual void OnCellTemplateSelectorChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

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

    OnUpdateBindingInfo(DependencyObject, DependencyPropertyChangedEventArgs)

    Updates the binding for the property changes associated with column.

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

    The dependency property that contains the property changes.

    System.Windows.DependencyPropertyChangedEventArgs e

    The System.DependencyPropertyChangedEventArgs instance that contains the data for various events.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when the currency decimal separator has empty string in GridCurrencyColumn.

    System.ArgumentOutOfRangeException

    Thrown when the currency positive pattern value is greater than 3 in GridCurrencyColumn.

    System.ArgumentOutOfRangeException

    Thrown when the currency negative pattern value is greater that 15 in GridCurrencyColumn.

    System.ArgumentException

    Thrown when the percent decimal separator has empty string in GridPercentColumn.

    System.ArgumentOutOfRangeException

    Thrown when the percent positive pattern value is greater than 3 in GridPercentColumn.

    System.ArgumentOutOfRangeException

    Thrown when the percent negative pattern value is greater that 11 in GridPercentColumn.

    System.ArgumentException

    Thrown when the number decimal separator has empty string in GridNumericColumn.

    System.ArgumentOutOfRangeException

    Thrown when the number negative pattern is greater than 4 in GridNumericColumn.

    SetDisplayBindingConverter()

    Sets the converter for the DisplayBinding of column.

    Declaration
    protected virtual void SetDisplayBindingConverter()
    Remarks

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

    SetValueBindingConverter()

    Sets the converter for the ValueBinding of column.

    Declaration
    protected virtual void SetValueBindingConverter()
    Remarks

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

    UpdateBindingBasedOnAllowEditing()

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

    Declaration
    protected virtual void UpdateBindingBasedOnAllowEditing()

    UpdateBindingForValidation(GridValidationMode)

    Updates the binding for GridValidationMode property changes in the column.

    Declaration
    public void UpdateBindingForValidation(GridValidationMode gridValidationMode)
    Parameters
    Type Name Description
    GridValidationMode gridValidationMode

    Specifies the corresponding validation mode for update binding.

    Implements

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