Syncfusion.Grid.Windows
Members 


Syncfusion.Windows.Forms.Grid Namespace : GridDataBoundTreeCellRenderer Class

GridDataBoundTreeCellRenderer Class

Implements the renderer part for an expandable row header cell in a GridDataBoundGrid. The The expandable row header cell will display a '+' for expanded rows and a '-' for collapsed rows with treelines similar to a TreeControl.
Object Model
GridDataBoundTreeCellRenderer ClassGridCurrentCell ClassGridStyleInfo ClassGridCellButton ClassIGridDropDownContainer InterfaceIGridDropDownCellImp InterfaceIGridDropDownCellImp InterfaceGridControlBase ClassGridCellModelBase ClassGridStyleInfo Class
Syntax
Remarks
Defines the renderer part of a expandable row header cell. A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridDataBoundTreeCellRenderer if several views display the same GridModel.

The GridDataBoundGrid registers "DataBoundRowExpandCell" as identifier in GridStyleInfo.CellType of a cells GridStyleInfo to associate this cell type with a cell.

The following table lists some characteristics about the DataBoundRowExpandCell cell type:

Item Description
CellType DataBoundRowExpandCell
Renderer GridDataBoundTreeCellRenderer
Model GridDataBoundTreeCellModel
XP Themes Support No
Interactive Click Only
Floating Support No
Base Type GridCellRendererBase

The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class:

PropertyName Description
GridStyleInfo.BaseStyle (System.String) The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
GridStyleInfo.Borders (GridBordersInfo) Top, left, bottom, and right border settings. To hide grid lines for a certain cell, you can set the GridBorder.Style of the specific edge to be GridBorderStyle.None. By default, the right and bottom borders are initialized to GridBorderStyle.Standard and borders are drawn as specified in the GridModelOptions.DefaultGridBorderStyle property of a GridModel instance. (Default: GridBordersInfo.Default)
GridStyleInfo.CellAppearance (GridCellAppearance) When set to GridCellAppearance.Flat, the header will be drawn with slightly raised edges typical for cell headers. If the grid is XP Themes enabled the headers will be drawn with XP Themes look. If you specify Sunken or Raised, the header will be drawn with sunken or raised edges and not XP Themed. (Default: GridCellAppearance.Flat)
GridStyleInfo.CellType (System.String) DataBoundRowExpandCell (Default: Text Box)
GridStyleInfo.Enabled (System.Boolean) Specifies if the cell can be activated as the3 current cell when the user clicks onto the header. Usually you do not want a header to be activated as the current cell unless you want to have editing capabilities such as allowing users to rename header text in place. Such renaming functionality needs to be implemented in a derived class. (Default: True)
GridStyleInfo.Error (System.String) Holds error information if a value could not be converted to the System.Type specified with GridStyleInfo.CellValueType. (Default: String.Empty)
GridStyleInfo.Interior (Syncfusion.Drawing.BrushInfo) Lets you specify a solid backcolor, gradient, or pattern style with both back and forecolor for a cell's background. If the grid is XP Themes enabled, this color will be ignored and the header will be drawn with default XP Themes header background. (Default: SystemColors.Window)
GridStyleInfo.TextColor (System.Drawing.Color) Lets you specify the color of the icon. (Default: SystemColors.WindowText)
GridStyleInfo.TextMargins (GridMarginsInfo) When drawing this header cell this specifies the minimum empty area between the text rectangle without borders and the icon. The icon will be centered inside the remaining rectangle. (Default: GridMarginsInfo.Default)

Inheritance Hierarchy

System.Object
   Syncfusion.ComponentModel.NonFinalizeDisposable
      Syncfusion.Windows.Forms.Grid.GridCellRendererBase
         Syncfusion.Windows.Forms.Grid.GridStaticCellRenderer
            Syncfusion.Windows.Forms.Grid.GridTextBoxCellRenderer
               Syncfusion.Windows.Forms.Grid.GridDataBoundTreeCellRenderer

AssemblyVersion

Syncfusion.Grid.Windows: 18.2460.0.44

See Also