menu

ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridColumn - API Reference

    Show / Hide Table of Contents

    Class TreeGridColumn

    Inheritance
    System.Object
    TagHelper
    EJTagHelper
    TreeGridColumn
    Inherited Members
    EJTagHelper.GetList()
    EJTagHelper.GetSerializedProperties()
    EJTagHelper.GetScriptString()
    EJTagHelper.GetHtmlAttrString(IDictionary<String, Object>)
    EJTagHelper.TagName
    EJTagHelper.Id
    EJTagHelper.NameSpace
    EJTagHelper.ClassName
    EJTagHelper.IsFor
    EJTagHelper.IsChild
    EJTagHelper.IsComplex
    EJTagHelper.IsCollection
    EJTagHelper.ParentPropertyName
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.EJ2.TreeGrid
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class TreeGridColumn : EJTagHelper

    Constructors

    TreeGridColumn()

    Declaration
    public TreeGridColumn()

    Properties

    AllowEditing

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

    Declaration
    [HtmlAttributeName("allowEditing")]
    public bool AllowEditing { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    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
    [HtmlAttributeName("allowFiltering")]
    public bool AllowFiltering { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    AllowReordering

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

    Declaration
    [HtmlAttributeName("allowReordering")]
    public bool AllowReordering { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    AllowResizing

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

    Declaration
    [HtmlAttributeName("allowResizing")]
    public bool AllowResizing { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    AllowSorting

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

    Declaration
    [HtmlAttributeName("allowSorting")]
    public bool AllowSorting { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    ClipMode

    Defines the cell content's overflow mode. The available modes are

    also it will display tooltip while hover on ellipsis applied cell.

    Declaration
    [HtmlAttributeName("clipMode")]
    public ClipMode ClipMode { get; set; }
    Property Value
    Type Description
    ClipMode

    The default value is Syncfusion.EJ2.Grids.ClipMode.Ellipsis

    Columns

    Defines stacked columns

    Declaration
    [HtmlAttributeName("columns")]
    public object Columns { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    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
    [HtmlAttributeName("commands")]
    public object Commands { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    CustomAttributes

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

    Declaration
    [HtmlAttributeName("customAttributes")]
    public object CustomAttributes { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    DefaultValue

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

    Declaration
    [HtmlAttributeName("defaultValue")]
    public string DefaultValue { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    DisableHtmlEncode

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

    Declaration
    [HtmlAttributeName("disableHtmlEncode")]
    public bool DisableHtmlEncode { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    DisplayAsCheckBox

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

    Declaration
    [HtmlAttributeName("displayAsCheckBox")]
    public bool DisplayAsCheckBox { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    Edit

    Defines the IEditCell object to customize default edit cell.

    Declaration
    [HtmlAttributeName("edit")]
    public object Edit { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    EditType

    Defines the type of component for editing.

    Declaration
    [HtmlAttributeName("editType")]
    public string EditType { get; set; }
    Property Value
    Type Description
    System.String

    The default value is "stringedit"

    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
    [HtmlAttributeName("field")]
    public string Field { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Filter

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

    Declaration
    [HtmlAttributeName("filter")]
    public object Filter { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    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
    [HtmlAttributeName("filterBarTemplate")]
    public object FilterBarTemplate { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    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 number and date formats.

    Declaration
    [HtmlAttributeName("format")]
    public string Format { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Formatter

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

    Declaration
    [HtmlAttributeName("formatter")]
    public object Formatter { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    Freeze

    Defines which side the column need to freeze

    Declaration
    [HtmlAttributeName("freeze")]
    public FreezeDirection Freeze { get; set; }
    Property Value
    Type Description
    FreezeDirection

    The default value is Syncfusion.EJ2.Grids.FreezeDirection.None

    HeaderTemplate

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

    Declaration
    [HtmlAttributeName("headerTemplate")]
    public string HeaderTemplate { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    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
    [HtmlAttributeName("headerText")]
    public string HeaderText { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    HeaderTextAlign

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

    Declaration
    [HtmlAttributeName("headerTextAlign")]
    public TextAlign HeaderTextAlign { get; set; }
    Property Value
    Type Description
    TextAlign

    The default value is null

    HideAtMedia

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

    Declaration
    [HtmlAttributeName("hideAtMedia")]
    public string HideAtMedia { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    IsFrozen

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

    Declaration
    [HtmlAttributeName("isFrozen")]
    public bool IsFrozen { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    IsIdentity

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

    Declaration
    [HtmlAttributeName("isIdentity")]
    public bool IsIdentity { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    IsPrimaryKey

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

    Declaration
    [HtmlAttributeName("isPrimaryKey")]
    public bool IsPrimaryKey { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    LockColumn

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

    Declaration
    [HtmlAttributeName("lockColumn")]
    public bool LockColumn { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    MaxWidth

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

    Declaration
    [HtmlAttributeName("maxWidth")]
    public string MaxWidth { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    MinWidth

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

    Declaration
    [HtmlAttributeName("minWidth")]
    public string MinWidth { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    ShowCheckbox

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

    Declaration
    [HtmlAttributeName("showCheckbox")]
    public bool ShowCheckbox { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false

    ShowColumnMenu

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

    Declaration
    [HtmlAttributeName("showColumnMenu")]
    public bool ShowColumnMenu { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    ShowInColumnChooser

    If showInColumnChooser set to false, then hide the particular column in column chooser. By default all columns are displayed in column Chooser.

    Declaration
    [HtmlAttributeName("showInColumnChooser")]
    public bool ShowInColumnChooser { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    SortComparer

    Defines the sort comparer property.

    Declaration
    [HtmlAttributeName("sortComparer")]
    public object SortComparer { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    Template

    Defines the column template that renders customized element in each cell of the column. It accepts either template string or HTML element ID.

    Declaration
    [HtmlAttributeName("template")]
    public string Template { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    TextAlign

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

    Declaration
    [HtmlAttributeName("textAlign")]
    public TextAlign TextAlign { get; set; }
    Property Value
    Type Description
    TextAlign

    The default value is Syncfusion.EJ2.Grids.TextAlign.Left

    Type

    Defines the data type of the column.

    Declaration
    [HtmlAttributeName("type")]
    public string Type { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    Uid

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

    Declaration
    [HtmlAttributeName("uid")]
    public string Uid { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

    ValidationRules

    Defines rules to validate data before creating and updating.

    Declaration
    [HtmlAttributeName("validationRules")]
    public object ValidationRules { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    ValueAccessor

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

    Declaration
    [HtmlAttributeName("valueAccessor")]
    public object ValueAccessor { get; set; }
    Property Value
    Type Description
    System.Object

    The default value is null

    Visible

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

    Declaration
    [HtmlAttributeName("visible")]
    public bool Visible { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true

    Width

    Defines the width of the column in pixels or percentage.

    Declaration
    [HtmlAttributeName("width")]
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    The default value is null

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