Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridColumn - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TreeGridColumn

    Configures Tree Grid column

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    SfDataBoundComponent
    TreeGridColumn
    Implements
    System.IDisposable
    Inherited Members
    SfDataBoundComponent.SetDataManager<T>(Object)
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    Namespace: Syncfusion.Blazor.TreeGrid
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class TreeGridColumn : SfDataBoundComponent, ISfCircularComponent, IDisposable

    Constructors

    TreeGridColumn()

    Declaration
    public TreeGridColumn()

    Properties

    AllowAdding

    If AllowAdding set to false, then it disables add operation of a particular column. By default all columns are editable.

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

    AllowEditing

    If AllowEditing set to false, then it disables editing of a particular column. By default all columns are editable.

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

    AllowFiltering

    If AllowFiltering set to false, then it disables filtering option and filter bar element of a particular column. By default all columns are filterable.

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

    AllowReordering

    If AllowReordering set to false, then it disables reorder of a particular column. By default all columns can be reorder.

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

    AllowResizing

    If AllowResizing set to false, it disables resize option of a particular column.

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

    AllowSorting

    If AllowSorting set to false, then it disables sorting option of a particular column. By default all columns are sortable.

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

    ClipMode

    Defines the cell content's overflow mode. The available modes are Clip - Truncates the cell content when it overflows its area. Ellipsis - Displays ellipsis when the cell content overflows its area. EllipsisWithTooltip - Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell.

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

    Columns

    Used to render multiple header rows(stacked headers) on TreeGrid header.

    Declaration
    public List<TreeGridColumn> Columns { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<TreeGridColumn>

    Commands

    Commands provides an option to display command buttons in every cell. The available built-in command buttons are Edit - Edit the record. Delete - Delete the record. Save - Save the record. Cancel - Cancel the edit state.

    Declaration
    public List<TreeGridCommandColumn> Commands { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<TreeGridCommandColumn>

    CustomAttributes

    The CSS styles and attributes of the content cells of a particular column can be customized.

    Declaration
    public IDictionary<string, object> CustomAttributes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    DefaultValue

    Defines default values for the component when adding a new record to the TreeGrid.

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

    DisableHtmlEncode

    If DisableHtmlEncode is set to true, it encodes the HTML of the header and content cells.

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

    DisplayAsCheckBox

    If DisplayAsCheckBox is set to true, it displays the column value as a check box instead of Boolean value.

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

    Edit

    Defines the object to customize default cell editors. The following types can be used to customize default editors.

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

    EditorSettings

    Defines the object to customize default cell editors. The following types can be used to customize default editors.
    NumericEditCellParams - Customizes the default numerictextbox editor.
    DropDownEditCellParams - Customizes the default dropdown editor.
    DateEditCellParams - Customizes the default datepicker editor.
    BooleanEditCellParams - Customizes the default checkbox editor.

    Declaration
    public IEditorSettings EditorSettings { get; set; }
    Property Value
    Type Description
    IEditorSettings

    EditTemplate

    Defines the cell edit template that is used as editor for a particular column. It accepts either template string or HTML element ID.

    Declaration
    public RenderFragment<object> EditTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>

    EditType

    Defines the type of component for editing.

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

    Field

    Defines the field name of column which is mapped with mapping name of DataSource. The bounded columns can be sort, filter etc., The Field name must be a valid JavaScript identifier, the first character must be an alphabet and should not contain spaces and special characters.

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

    Filter

    Defines the filter options to customize filtering for the particular column.

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

    FilterBarTemplate

    The FilterBarTemplate is used to add a custom component instead of default input component for filter bar. It have create and read functions. create: It is used for creating custom components. read: It is used to perform custom filter action.

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

    FilterItemTemplate

    Defines the Checkbox Item template that renders customized element/value in each checkbox of the Filter column.

    Declaration
    public RenderFragment<object> FilterItemTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>
    Remarks

    The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type FilterItemTemplateContext.

    FilterSettings

    Defines the filter options to customize filtering for the particular column.

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

    FilterTemplate

    Defines the filter template/UI that is used as filter for a particular column. It accepts either template string or HTML element ID.

    Declaration
    public RenderFragment<object> FilterTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>

    Format

    It is used to change display value with the given format and does not affect the original data. Gets the format from the user which can be standard or custom

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

    Formatter

    Defines the method which is used to achieve custom formatting from an external function. This function triggers before rendering of each cell.

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

    HeaderTemplate

    Defines the header template as string or HTML element ID which is used to add customized element in the column header.

    Declaration
    public RenderFragment<object> HeaderTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>

    HeaderText

    Defines the header text of column which is used to display in column header. If HeaderText is not defined, then field name value will be assigned to header text.

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

    HeaderTextAlign

    Define the alignment of column header which is used to align the text of column header.

    Declaration
    public TextAlign HeaderTextAlign { get; set; }
    Property Value
    Type Description
    TextAlign

    HideAtMedia

    Column visibility can change based on Media Queries. HideAtMedia accepts only valid Media Queries.

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

    Index

    Gets the unique identifier value of the column. It is used to get the object.

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

    IsFrozen

    You can use this property to freeze selected columns in grid.

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

    IsIdentity

    If IsIdentity is set to true, then this column is considered as identity column.

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

    IsPrimaryKey

    If IsPrimaryKey is set to true, considers this column as the primary key constraint.

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

    LockColumn

    If LockColumn is set to true, then it disables Reordering of a particular column. The locked column will be moved to first position.

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

    MaxWidth

    Defines the maximum width of the column in pixels or percentage, which will restrict resizing beyond this pixels or percentage.

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

    MinWidth

    Defines the minimum width of the column in pixels or percentage.

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

    ShowCheckbox

    If ShowCheckbox is set to true, then the checkboxes will be displayed in particular column.

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

    ShowColumnMenu

    If ShowColumnMenu is set to false, then it disable the column menu of a particular column. By default column menu will show for all columns

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

    ShowInColumnChooser

    If ShowInColumnChooser is set to false, then hides the particular column in column chooser. By default all columns are displayed in column Chooser.

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

    SortComparer

    Defines the sort comparer property.

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

    Template

    Defines the column template that renders customized element in each cell of the column.

    Declaration
    public RenderFragment<object> Template { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>

    TextAlign

    Defines the alignment of the column in both header and content cells.

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

    Type

    Defines the data type of the column.

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

    Uid

    Gets the unique identifier value of the column. It is used to get the object.

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

    ValidationRules

    Defines rules to validate data before creating and updating. The validation rules can be set as instance of ValidationRules.

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

    ValueAccessor

    Defines the method used to apply custom cell values from external function and display this on each cell rendered.

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

    Visible

    If Visible is set to false, hides the particular column. By default, columns are displayed.

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

    Width

    Defines the width of the column in pixels or percentage.

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

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnParametersSetAsync()

    SetVisibility(Boolean)

    Declaration
    public void SetVisibility(bool visibility)
    Parameters
    Type Name Description
    System.Boolean visibility

    Implements

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