Class TreeGridStackedColumn

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

TreeGridStackedColumn

Namespace: Syncfusion.EJ2.TreeGrid

Assembly: Syncfusion.EJ2.dll

Syntax

public class TreeGridStackedColumn : EJTagHelper

Constructors

TreeGridStackedColumn()

Declaration

public TreeGridStackedColumn()

Properties

AllowEditing

Controls whether editing is permitted for the column. By default, all columns are editable.

Declaration

public bool AllowEditing { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowFiltering

Controls whether the column supports filtering. If set to false, users cannot filter data by this column.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowReordering

Enables or disables the reordering of this column via drag-and-drop. Allows for dynamic column adjustments.

Declaration

public bool AllowReordering { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowResizing

Determines if this column can be resized. If false, the column size is fixed.

Declaration

public bool AllowResizing { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowSorting

Specifies whether sorting is enabled for this column. Set to false to prevent sort actions.

Declaration

public bool AllowSorting { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ClipMode

Determines how overflow content is handled within a cell. Options include: Clip: Truncates the content. Ellipsis: Shows ellipsis for overflow. EllipsisWithTooltip: Shows ellipsis and tooltip on hover.

Declaration

public ClipMode ClipMode { get; set; }

Property Value

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

Columns

Defines stacked columns

Declaration

public object Columns { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Commands

Provides built-in command button options for cells. Options include Edit, Delete, Save, and Cancel. Custom command button implementations are possible.

Declaration

public object Commands { get; set; }

Property Value

Type	Description
System.Object	The default value is null

CustomAttributes

Enables the addition of CSS styles and attributes for the content cells in a particular column.

Declaration

public object CustomAttributes { get; set; }

Property Value

Type	Description
System.Object	The default value is null

DefaultValue

Sets default values when new records are added to the TreeGrid involving this column.

Declaration

public string DefaultValue { get; set; }

Property Value

Type	Description
System.String	The default value is null

DisableHtmlEncode

If set to true, the HTML content within header and content cells is encoded to prevent injection attacks.

Declaration

public bool DisableHtmlEncode { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

DisplayAsCheckBox

Displays the column value as a checkbox instead of a Boolean value when set to true.

Declaration

public bool DisplayAsCheckBox { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Edit

Allows customizing the default edit cell through the IEditCell object for more control over editing.

Declaration

public object Edit { get; set; }

Property Value

Type	Description
System.Object	The default value is null

EditType

Specifies the component type used for editing cells within this column.

Declaration

public string EditType { get; set; }

Property Value

Type	Description
System.String	The default value is "stringedit"

Field

Specifies the field name in the data source to which the column is bound. This field is used for operations like sorting and filtering. The field name must be a valid JavaScript identifier, beginning with a letter and avoiding spaces and special characters.

Declaration

public string Field { get; set; }

Property Value

Type	Description
System.String	The default value is null

Filter

Customizes filter options for the column, enabling specialized filtering functionality.

Declaration

public object Filter { get; set; }

Property Value

Type	Description
System.Object	The default value is null

FilterBarTemplate

Allows for a custom component within the filter bar, facilitating advanced filter interfaces. Includes create and read functions for custom component management.

Declaration

public object FilterBarTemplate { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Format

Formats the displayed value of the column without affecting the underlying data. Supports standard and custom formats for numbers and dates.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String	The default value is null

Formatter

Allows for custom cell content formatting using an external method, executed prior to rendering.

Declaration

public object Formatter { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Freeze

Determines which side (left, right, or center) the column should be frozen on.

Declaration

public FreezeDirection Freeze { get; set; }

Property Value

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

HeaderTemplate

Customizes the header content with a template, defined as a string or an HTML element ID.

Declaration

public string HeaderTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

HeaderText

Specifies the text displayed in the column header. If omitted, the field value is used as the header text.

Declaration

public string HeaderText { get; set; }

Property Value

Type	Description
System.String	The default value is null

HeaderTextAlign

Aligns the text in the column header. By default, the alignment corresponds to other content alignments.

Declaration

public TextAlign HeaderTextAlign { get; set; }

Property Value

Type	Description
TextAlign	The default value is null

HideAtMedia

Adjusts column visibility based on Media Queries. Accepts valid CSS media query strings for responsive adjustments.

Declaration

public string HideAtMedia { get; set; }

Property Value

Type	Description
System.String	The default value is null

IsFrozen

Allows the column to be frozen, keeping it stationary while scrolling horizontally through the grid.

Declaration

public bool IsFrozen { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IsIdentity

Identifies the column as an identity column in database terms, if set to true.

Declaration

public bool IsIdentity { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IsPrimaryKey

Identifies the column as a primary key if set to true, enforcing uniqueness.

Declaration

public bool IsPrimaryKey { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

LockColumn

Prevents column reordering when set to true, locking the column into a set position.

Declaration

public bool LockColumn { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

MaxWidth

Defines the maximum allowable width of the column in pixels or as a percentage, preventing resizing beyond this limit.

Declaration

public string MaxWidth { get; set; }

Property Value

Type	Description
System.String	The default value is null

MinWidth

Determines the minimum width of the column in pixels or percentage. This ensures the column does not shrink below this size.

Declaration

public string MinWidth { get; set; }

Property Value

Type	Description
System.String	The default value is null

ShowCheckbox

Displays checkboxes in the column when enabled, allowing for selections and certain operations.

Declaration

public bool ShowCheckbox { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ShowColumnMenu

Decides if the column menu should be available, providing options for column customization.

Declaration

public bool ShowColumnMenu { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ShowInColumnChooser

Determines whether the column should appear in the Column Chooser. Set to false to exclude it.

Declaration

public bool ShowInColumnChooser { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

SortComparer

Provides a custom sort comparer property to control how sorting is handled for this column's data.

Declaration

public object SortComparer { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Template

Customizes the rendering of cell content using either a template string or HTML element ID.

Declaration

public string Template { get; set; }

Property Value

Type	Description
System.String	The default value is null

TextAlign

Specifies the horizontal alignment for the column content and header. Options include alignment to the left, center, or right.

Declaration

public TextAlign TextAlign { get; set; }

Property Value

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

Type

Defines the type of data stored in the column, which may be string, number, date, or other types.

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String	The default value is null

Uid

Retrieves the unique identifier for the column. This UID is used internally to reference and manipulate the column.

Declaration

public string Uid { get; set; }

Property Value

Type	Description
System.String	The default value is null

ValidationRules

Establishes validation rules to ensure data integrity during creation and updates.

Declaration

public object ValidationRules { get; set; }

Property Value

Type	Description
System.Object	The default value is null

ValueAccessor

Applies custom cell values using an external function, allowing for dynamic display adjustments.

Declaration

public object ValueAccessor { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Visible

Toggles the visibility of the column. Set to false to hide the column from view. Columns are visible by default.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Width

Sets the column's width in pixels or as a percentage. This defines how the column will occupy space in the grid.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is null