Class TreeGridStyle
Represents the style for SfTreeGrid control.
Inheritance
Namespace: Syncfusion.Maui.TreeGrid
Assembly: Syncfusion.Maui.TreeGrid.dll
Syntax
public class TreeGridStyle : Element, IThemeElement
Constructors
TreeGridStyle()
Initializes a new instance of the TreeGridStyle class.
Declaration
public TreeGridStyle()
Fields
ExpanderIconColorProperty
Identifies the GroupIconColor Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty ExpanderIconColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
FreezePaneLineColorProperty
Identifies the FreezePaneLineColor Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty FreezePaneLineColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
FreezePaneLineStrokeThicknessProperty
Identifies the FreezePaneLineStrokeThickness bindable property.
Declaration
public static readonly BindableProperty FreezePaneLineStrokeThicknessProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
Remarks
The FreezePaneLineStrokeThickness property determines the stroke thickness of the freeze pane line that visually separates frozen rows or columns from the scrollable area in the data grid.
GridLineColorProperty
Identifies the GridLineColor Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty GridLineColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
GridLineStrokeThicknessProperty
Identifies the GridLineStrokeThickness Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty GridLineStrokeThicknessProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
HeaderGridLineColorProperty
Identifies the HeaderGridLineColor bindable property.
Declaration
public static readonly BindableProperty HeaderGridLineColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
Remarks
The HeaderGridLineColor The property specifies the grid line color of the column header and stacked header cells.
HeaderGridLineStrokeThicknessProperty
Identifies the HeaderGridLineStrokeThickness bindable property.
Declaration
public static readonly BindableProperty HeaderGridLineStrokeThicknessProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
Remarks
The HeaderGridLineStrokeThickness property determines the stroke thickness of the column header and stacked header cells.
HeaderRowBackgroundProperty
Identifies the HeaderRowBackground Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty HeaderRowBackgroundProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
HeaderRowFontAttributesProperty
Identifies the HeaderFontAttributes Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty HeaderRowFontAttributesProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
HeaderRowFontFamilyProperty
Identifies the HeaderFontFamily Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty HeaderRowFontFamilyProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
HeaderRowFontSizeProperty
Identifies the HeaderFontSize Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty HeaderRowFontSizeProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
HeaderRowTextColorProperty
Identifies the HeaderRowTextColor Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty HeaderRowTextColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
RowBackgroundProperty
Identifies the RowBackground Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty RowBackgroundProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
RowFontAttributesProperty
Identifies the RowFontAttributes Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty RowFontAttributesProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
RowFontFamilyProperty
Identifies the RowFontFamily Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty RowFontFamilyProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
RowFontSizeProperty
Identifies the RowFontSize Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty RowFontSizeProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
RowTextColorProperty
Identifies the RowTextColor Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty RowTextColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
SelectedRowTextColorProperty
Identifies the SelectedRowTextColor Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty SelectedRowTextColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
SelectionBackgroundProperty
Identifies the SelectionBackground Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty SelectionBackgroundProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
SortIconColorProperty
Identifies the SortIconColor Microsoft.Maui.Controls.BindableProperty.
Declaration
public static readonly BindableProperty SortIconColorProperty
Field Value
| Type |
|---|
| Microsoft.Maui.Controls.BindableProperty |
Properties
ExpanderIconColor
Gets or sets the master-details view expander icon color.
Declaration
public Color ExpanderIconColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
FreezePaneLineColor
Gets or sets the color of the line which indicates the frozen pane.
Declaration
public Color FreezePaneLineColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
Remarks
This is applicable for both the frozen column and row.
FreezePaneLineStrokeThickness
Gets or sets the stroke thickness of the freeze pane line in the data grid.
Declaration
public int FreezePaneLineStrokeThickness { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | It accepts System.Int32 values, and the default thickness is 1. |
Remarks
This property allows you to customize the appearance of the freeze pane line by adjusting its stroke thickness. The freeze pane line visually separates frozen rows or columns from the scrollable area in the grid.
Examples
Here is an example of how to set the FreezePaneLineStrokeThickness property.
[XAML///
<local:SfTreeGrid>
<local:SfTreeGrid.DefaultStyle>
<local:TreeGridStyle FreezePaneLineStrokeThickness="2" />
</local:SfTreeGrid.DefaultStyle>
</local:SfTreeGrid>
]]]
</code>
C#
<code>
<![CDATA[
var treeGrid = new SfTreeGrid();
TreeGridStyle style = new TreeGridStyle() { FreezePaneLineStrokeThickness = 2 };
treeGrid.DefaultStyle = style;
GridLineColor
Gets or sets the color for the grid lines.
Declaration
public Color GridLineColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
GridLineStrokeThickness
Gets or sets the stroke thickness of the grid lines.
Declaration
public float GridLineStrokeThickness { get; set; }
Property Value
| Type |
|---|
| System.Single |
HeaderGridLineColor
Gets or sets the color for the grid lines of the column header cells.
Declaration
public Color HeaderGridLineColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
HeaderGridLineStrokeThickness
Gets or sets the stroke thickness of the grid lines of the column header cells.
Declaration
public float HeaderGridLineStrokeThickness { get; set; }
Property Value
| Type |
|---|
| System.Single |
HeaderRowBackground
Gets or sets the background for the header row.
Declaration
public Brush HeaderRowBackground { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Controls.Brush |
HeaderRowFontAttributes
Gets or sets the font attributes of the header row.
Declaration
public FontAttributes HeaderRowFontAttributes { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Controls.FontAttributes |
HeaderRowFontFamily
Gets or sets the font family of the header row.
Declaration
public string HeaderRowFontFamily { get; set; }
Property Value
| Type |
|---|
| System.String |
HeaderRowFontSize
Gets or sets the font size of the header row.
Declaration
public double HeaderRowFontSize { get; set; }
Property Value
| Type |
|---|
| System.Double |
HeaderRowTextColor
Gets or sets the text color of the header row.
Declaration
public Color HeaderRowTextColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
RowBackground
Gets or sets the background of the data rows.
Declaration
public Brush RowBackground { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Controls.Brush |
RowFontAttributes
Gets or sets the font attributes of the data rows.
Declaration
public FontAttributes RowFontAttributes { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Controls.FontAttributes |
RowFontFamily
Gets or sets the font family of the data rows.
Declaration
public string RowFontFamily { get; set; }
Property Value
| Type |
|---|
| System.String |
RowFontSize
Gets or sets the font size of the data rows.
Declaration
public double RowFontSize { get; set; }
Property Value
| Type |
|---|
| System.Double |
RowTextColor
Gets or sets the text color of the data row.
Declaration
public Color RowTextColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
SelectedRowTextColor
Gets or sets the text color of the selected rows.
Declaration
public Color SelectedRowTextColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
SelectionBackground
Gets or sets the background of the selected rows.
Declaration
public Brush SelectionBackground { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Controls.Brush |
SortIconColor
Gets or sets the color of the sort icon displayed in the header row of the SfTreeGrid.
Declaration
public Color SortIconColor { get; set; }
Property Value
| Type |
|---|
| Microsoft.Maui.Graphics.Color |
Methods
OnCommonThemeChanged(String, String)
Called when the common theme is changed.
Declaration
public void OnCommonThemeChanged(string oldTheme, string newTheme)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | oldTheme | |
| System.String | newTheme |
OnControlThemeChanged(String, String)
Called when the control theme is changed.
Declaration
public void OnControlThemeChanged(string oldTheme, string newTheme)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | oldTheme | |
| System.String | newTheme |