alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download

    Show / Hide Table of Contents

    Class SfTreeGrid

    Represents a SfTreeGrid control that displays hierarchical data in a tree structure with expandable and collapsible nodes.

    Inheritance
    System.Object
    SfView
    SfTreeGrid
    Implements
    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<Microsoft.Maui.IView>
    System.Collections.Generic.ICollection<Microsoft.Maui.IView>
    System.Collections.Generic.IEnumerable<Microsoft.Maui.IView>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement
    Inherited Members
    SfView.ArrangeOverride(Rect)
    SfView.Children
    SfView.ClipToBounds
    SfView.GetSemanticsNodesCore(Double, Double)
    SfView.IDrawableLayout.DrawingOrder
    SfView.IDrawableLayout.InvalidateDrawable()
    SfView.MeasureOverride(Double, Double)
    SfView.OnBindingContextChanged()
    SfView.OnDraw(ICanvas, RectF)
    SfView.OnHandlerChanged()
    SfView.Padding
    SfView.PaddingProperty
    Namespace: Syncfusion.Maui.TreeGrid
    Assembly: Syncfusion.Maui.TreeGrid.dll
    Syntax
    public class SfTreeGrid : SfView, IDrawableLayout, IDrawable, IAbsoluteLayout, ILayout, IView, IElement, ITransform, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IVisualTreeElement, ISemanticsProvider, IParentThemeElement, IThemeElement

    Constructors

    SfTreeGrid()

    Initializes a new instance of the SfTreeGrid class.

    Declaration
    public SfTreeGrid()

    Fields

    AllowTriStateSortingProperty

    Identifies the AllowTriStateSorting Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty AllowTriStateSortingProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    AutoExpandModeProperty

    Identifies the AutoExpandMode Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty AutoExpandModeProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    AutoGenerateColumnsModeProperty

    Identifies the AutoGenerateColumnsMode Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty AutoGenerateColumnsModeProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ChildPropertyNameProperty

    Identifies the ChildPropertyName bindable property.

    Declaration
    public static readonly BindableProperty ChildPropertyNameProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ColumnsProperty

    Identifies the Columns Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty ColumnsProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty
    Remarks

    This Microsoft.Maui.Controls.BindableProperty is read-only.

    ColumnWidthModeProperty

    Identifies the ColumnWidthMode Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty ColumnWidthModeProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    DefaultColumnWidthProperty

    Identifies the DefaultColumnWidth Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty DefaultColumnWidthProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    DefaultStyleProperty

    Identifies the DefaultStyle Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty DefaultStyleProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ExpanderColumnProperty

    Identifies the ExpanderColumn Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty ExpanderColumnProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ExpanderIconProperty

    Identifies the ExpanderIcon Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty ExpanderIconProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ExpanderWidthProperty

    Identifies the ExpanderWidth Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty ExpanderWidthProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ExpandStateMappingNameProperty

    Identifies the ExpandStateMappingName bindable property.

    Declaration
    public static readonly BindableProperty ExpandStateMappingNameProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    FilterLevelProperty

    Identifies the FilterLevel Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty FilterLevelProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    FooterFrozenColumnCountProperty

    Identifies the FooterFrozenColumnCount Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty FooterFrozenColumnCountProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    FrozenColumnCountProperty

    Identifies the FrozenColumnCount Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty FrozenColumnCountProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    GridLinesVisibilityProperty

    Identifies the GridLinesVisibility Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty GridLinesVisibilityProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    HeaderGridLinesVisibilityProperty

    Identifies the HeaderGridLinesVisibility Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty HeaderGridLinesVisibilityProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    HeaderRowHeightProperty

    Identifies the HeaderRowHeight Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty HeaderRowHeightProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ItemsSourceProperty

    Identifies the ItemsSource Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty ItemsSourceProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty
    Remarks

    This Microsoft.Maui.Controls.BindableProperty is read-only.

    ParentPropertyNameProperty

    Identifies the ParentPropertyName bindable property.

    Declaration
    public static readonly BindableProperty ParentPropertyNameProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    RowHeightProperty

    Identifies the RowHeight Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty RowHeightProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SelectedIndexProperty

    Identifies the SelectedIndex Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SelectedIndexProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SelectedRowProperty

    Identifies the SelectedRow Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SelectedRowProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SelectedRowsProperty

    Identifies the SelectedRow Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SelectedRowsProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SelectionModeProperty

    Identifies the SelectionMode Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SelectionModeProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SelfRelationRootValueProperty

    Identifies the SelfRelationRootValue bindable property.

    Declaration
    public static readonly BindableProperty SelfRelationRootValueProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    ShowSortNumbersProperty

    Identifies the ShowSortNumbers Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty ShowSortNumbersProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SortColumnDescriptionsProperty

    Identifies the SortColumnDescriptionCollection Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SortColumnDescriptionsProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty
    Remarks

    This Microsoft.Maui.Controls.BindableProperty is read-only.

    SortComparersProperty

    Identifies the SortComparers Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SortComparersProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty
    Remarks

    This Microsoft.Maui.Controls.BindableProperty is read-only.

    SortIconTemplateProperty

    Identifies the SortIconTemplate Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SortIconTemplateProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SortingGestureTypeProperty

    Identifies the SortingGestureType Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SortingGestureTypeProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    SortingModeProperty

    Identifies the SortingMode Microsoft.Maui.Controls.BindableProperty.

    Declaration
    public static readonly BindableProperty SortingModeProperty
    Field Value
    Type
    Microsoft.Maui.Controls.BindableProperty

    Properties

    AllowTriStateSorting

    Gets or sets a value indicating whether tri-state sorting is enabled.

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

    AutoExpandMode

    Gets or sets the expand mode that determines how nodes are expanded when the grid is loaded.

    Declaration
    public TreeGridExpandMode AutoExpandMode { get; set; }
    Property Value
    Type
    TreeGridExpandMode

    AutoGenerateColumnsMode

    Gets or sets the mode that determines how columns are automatically generated based on the data source.

    Declaration
    public AutoGenerateColumnsMode AutoGenerateColumnsMode { get; set; }
    Property Value
    Type
    AutoGenerateColumnsMode

    CellRenderers

    Gets the collection of cell renderers used to render cells with specific data types or templates.

    Declaration
    public TreeGridCellRendererCollection CellRenderers { get; }
    Property Value
    Type
    TreeGridCellRendererCollection

    ChildPropertyName

    Gets or sets the property name for the child collection used to determine the tree structure.

    Declaration
    public string ChildPropertyName { get; set; }
    Property Value
    Type
    System.String
    Remarks

    This property defines which property in your data object holds the collection of child items. For nested collection mode, this is the only property required. For self-relational mode, use this together with ParentPropertyName.

    Columns

    Gets or sets the collection of columns displayed by the control.

    Declaration
    public TreeGridColumnCollection Columns { get; set; }
    Property Value
    Type
    TreeGridColumnCollection

    ColumnSizer

    Gets or sets the column sizer used to calculate and manage column widths.

    Declaration
    public TreeGridColumnSizer ColumnSizer { get; set; }
    Property Value
    Type
    TreeGridColumnSizer

    ColumnWidthMode

    Gets or sets the mode that determines how column widths are automatically calculated.

    Declaration
    public TreeGridColumnWidthMode ColumnWidthMode { get; set; }
    Property Value
    Type
    TreeGridColumnWidthMode

    DefaultColumnWidth

    Gets or sets the default width of columns in pixels.

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

    DefaultStyle

    Gets or sets the default style applied to the TreeGrid and its elements.

    Declaration
    public TreeGridStyle DefaultStyle { get; set; }
    Property Value
    Type
    TreeGridStyle
    Remarks

    If this value is null, the built-in default style will be applied.

    ExpanderColumn

    Gets or sets the column name that will display the expand/collapse expander.

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

    ExpanderIcon

    Gets or sets the template that customizes the expand/collapse icon displayed in the expander column.

    Declaration
    public DataTemplate ExpanderIcon { get; set; }
    Property Value
    Type
    Microsoft.Maui.Controls.DataTemplate
    Remarks

    When null, the default expand/collapse icon is used. The template receives a TreeNode as its binding context, allowing you to bind to properties like IsExpanded, Level, and HasChildNodes.

    ExpanderWidth

    Gets or sets the width of the expander column.

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

    ExpandStateMappingName

    Gets or sets the property name that holds the expanded or collapsed state for each tree node.

    Declaration
    public string ExpandStateMappingName { get; set; }
    Property Value
    Type
    System.String
    Remarks

    Set this to the name of a boolean property in your data object to automatically sync the expand/collapse state with your data. The default value is string.Empty.

    FilterLevel

    Gets or sets a value that indicates how nodes should be filtered using Filter.

    Declaration
    public FilterLevel FilterLevel { get; set; }
    Property Value
    Type
    FilterLevel

    FooterFrozenColumnCount

    Gets or sets the number of columns to freeze on the right side of the grid.

    Declaration
    public int FooterFrozenColumnCount { get; set; }
    Property Value
    Type
    System.Int32
    Remarks

    When set to a value greater than 0, the specified number of columns from the right will remain visible while scrolling horizontally. The default value is 0 (no frozen footer columns).

    FrozenColumnCount

    Gets or sets the number of columns to freeze on the left side of the grid.

    Declaration
    public int FrozenColumnCount { get; set; }
    Property Value
    Type
    System.Int32
    Remarks

    When set to a value greater than 0, the specified number of columns from the left will remain visible while scrolling horizontally. The default value is 0 (no frozen columns).

    GridLinesVisibility

    Gets or sets the visibility of the grid lines for data rows.

    Declaration
    public TreeGridLinesVisibility GridLinesVisibility { get; set; }
    Property Value
    Type
    TreeGridLinesVisibility
    Remarks

    Use HeaderGridLinesVisibility to customize the visibility of grid lines for column headers.

    HeaderGridLinesVisibility

    Gets or sets the visibility of the grid lines for column headers.

    Declaration
    public TreeGridLinesVisibility HeaderGridLinesVisibility { get; set; }
    Property Value
    Type
    TreeGridLinesVisibility
    Remarks

    Use GridLinesVisibility to customize the visibility of grid lines for data rows.

    HeaderRowHeight

    Gets or sets the height of the header row in pixels.

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

    ItemsSource

    Gets or sets the collection used to generate the content of the control.

    Declaration
    public object ItemsSource { get; set; }
    Property Value
    Type
    System.Object
    Remarks

    Assign a data collection to this property to enable data binding and automatic item generation. The property supports any enumerable data source, such as arrays, lists, or observable collections. Changes to the collection may automatically update the displayed items, depending on the control's implementation.

    ParentPropertyName

    Gets or sets the property name for the parent object used to determine the tree structure in self-relational mode.

    Declaration
    public string ParentPropertyName { get; set; }
    Property Value
    Type
    System.String
    Remarks

    This property defines which property in your data object holds the reference to the parent item. Use this together with ChildPropertyName for self-relational hierarchies. It should be unique within your data structure.

    RowHeight

    Gets or sets the height of data rows in pixels.

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

    SelectedIndex

    Gets the index of the currently selected row.

    Declaration
    public int SelectedIndex { get; set; }
    Property Value
    Type
    System.Int32

    SelectedRow

    Gets the data item of the currently selected row.

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

    SelectedRows

    Gets a list of all selected row data items.

    Declaration
    public ObservableCollection<object> SelectedRows { get; set; }
    Property Value
    Type
    System.Collections.ObjectModel.ObservableCollection<System.Object>

    SelectionMode

    Gets or sets the row selection mode.

    Declaration
    public TreeGridSelectionMode SelectionMode { get; set; }
    Property Value
    Type
    TreeGridSelectionMode

    SelfRelationRootValue

    Gets or sets the value that defines the root object in self-relational mode.

    Declaration
    public object SelfRelationRootValue { get; set; }
    Property Value
    Type
    System.Object
    Remarks

    In self-relational mode, this value is used to identify root-level items (items whose parent property matches this value). The default value is null.

    ShowSortNumbers

    Gets or sets a value indicating whether the ordinal sort order numbers are displayed next to the sort indicator in column headers when multi-column sorting is enabled.

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

    SortColumnDescriptions

    Gets or sets the collection of the sort descriptions of columns that are sorted.

    Declaration
    public SortColumnDescriptionCollection SortColumnDescriptions { get; set; }
    Property Value
    Type
    SortColumnDescriptionCollection

    SortComparers

    Gets the collection of custom comparers used to sort columns based on custom logic.

    Declaration
    public SortComparers SortComparers { get; }
    Property Value
    Type
    SortComparers

    SortIconTemplate

    Gets or sets a custom Microsoft.Maui.Controls.DataTemplate used to render the sort indicator (the up/down arrow) in column headers.

    Declaration
    public DataTemplate SortIconTemplate { get; set; }
    Property Value
    Type
    Microsoft.Maui.Controls.DataTemplate

    SortingGestureType

    Gets or sets the gesture that triggers sorting when a column header is interacted with.

    Declaration
    public TreeGridSortingGestureType SortingGestureType { get; set; }
    Property Value
    Type
    TreeGridSortingGestureType

    SortingMode

    Gets or sets the value that decides whether sorting is enabled and whether single or multiple columns can be sorted in a SfTreeGrid.

    Declaration
    public TreeGridSortingMode SortingMode { get; set; }
    Property Value
    Type Description
    TreeGridSortingMode

    One of the TreeGridSortingMode enumeration values. The default value is None, which disables sorting.

    View

    Gets or sets the TreeGridView that provides the hierarchical data and structure for the grid.

    Declaration
    public TreeGridView View { get; set; }
    Property Value
    Type
    TreeGridView

    VisualContainer

    Gets the visual container that manages the rendering and layout of grid rows and columns.

    Declaration
    public VisualContainer VisualContainer { get; }
    Property Value
    Type
    VisualContainer

    Methods

    ArrangeContent(Rect)

    Arranges the content of the element within the specified bounds.

    Declaration
    protected override Size ArrangeContent(Rect bounds)
    Parameters
    Type Name Description
    Microsoft.Maui.Graphics.Rect bounds

    The rectangle that defines the area within which to arrange the content.

    Returns
    Type Description
    Microsoft.Maui.Graphics.Size

    A Size structure representing the actual size used to arrange the content.

    Overrides
    SfView.ArrangeContent(Rect)

    ClearSelection()

    Clears all selected rows and cells.

    Declaration
    public void ClearSelection()

    CollapseAllNodes()

    Collapses all the nodes in SfTreeGrid.

    Declaration
    public void CollapseAllNodes()

    CollapseAllNodes(TreeNode)

    Collapses the particular node and all its child nodes in SfTreeGrid.

    Declaration
    public void CollapseAllNodes(TreeNode node)
    Parameters
    Type Name Description
    TreeNode node

    Specifies which node to be collapsed.

    CollapseNode(TreeNode)

    Collapses the particular node in SfTreeGrid.

    Declaration
    public void CollapseNode(TreeNode node)
    Parameters
    Type Name Description
    TreeNode node

    Specifies which node to be collapsed.

    CollapseNode(Int32)

    Collapses the node in particular rowIndex.

    Declaration
    public void CollapseNode(int rowIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    Specifies the row index which contains the node to be collapsed.

    ExpandAllNodes()

    Expands all the nodes in SfTreeGrid.

    Declaration
    public void ExpandAllNodes()

    ExpandAllNodes(TreeNode)

    Expands the particular node and all its child nodes in SfTreeGrid.

    Declaration
    public void ExpandAllNodes(TreeNode node)
    Parameters
    Type Name Description
    TreeNode node

    Specifies which node to be expanded.

    ExpandAllNodes(Int32)

    Expands all the nodes in SfTreeGrid up to given level.

    Declaration
    public void ExpandAllNodes(int level)
    Parameters
    Type Name Description
    System.Int32 level

    Specifies how many levels to be expanded.

    ExpandNode(TreeNode)

    Expands the particular node in SfTreeGrid.

    Declaration
    public void ExpandNode(TreeNode node)
    Parameters
    Type Name Description
    TreeNode node

    Specifies which node to be expanded.

    ExpandNode(Int32)

    Expands the node in particular rowIndex.

    Declaration
    public void ExpandNode(int rowIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    Specifies the row index which contains the node to be expanded.

    MeasureContent(Double, Double)

    Measures the size required for the content, given the specified width and height constraints.

    Declaration
    protected override Size MeasureContent(double widthConstraint, double heightConstraint)
    Parameters
    Type Name Description
    System.Double widthConstraint

    The maximum width.

    System.Double heightConstraint

    The maximum height.

    Returns
    Type Description
    Microsoft.Maui.Graphics.Size

    A Size structure representing the width and height required to display the content within the specified constraints.

    Overrides
    SfView.MeasureContent(Double, Double)

    OnCommonThemeChanged(String, String)

    Called when the common theme has changed.

    Declaration
    public void OnCommonThemeChanged(string oldTheme, string newTheme)
    Parameters
    Type Name Description
    System.String oldTheme

    The old theme name.

    System.String newTheme

    The new theme name.

    OnControlThemeChanged(String, String)

    Called when the control theme has changed.

    Declaration
    public void OnControlThemeChanged(string oldTheme, string newTheme)
    Parameters
    Type Name Description
    System.String oldTheme

    The old theme name.

    System.String newTheme

    The new theme name.

    OnPropertyChanged(String)

    Called when a property on this element has changed.

    Declaration
    protected override void OnPropertyChanged(string propertyName = null)
    Parameters
    Type Name Description
    System.String propertyName

    The name of the property that changed.

    SelectAll()

    Selects all rows in multiple-selection mode.

    Declaration
    public void SelectAll()

    UnWireEvents()

    Unwires the events associated with the TreeGrid.

    Declaration
    protected virtual void UnWireEvents()

    WireEvents()

    Wires the events associated with the TreeGrid.

    Declaration
    protected virtual void WireEvents()

    Events

    AutoGeneratingColumn

    Occurs when a column is being auto-generated for a property in the underlying data source.

    Declaration
    public event EventHandler<TreeGridAutoGeneratingColumnEventArgs> AutoGeneratingColumn
    Event Type
    Type
    System.EventHandler<TreeGridAutoGeneratingColumnEventArgs>
    Remarks

    This event allows you to customize, replace, or cancel the column that is automatically generated by the SfTreeGrid for each property of the bound items. Set the Column to a different column type to customize the column, or set System.ComponentModel.CancelEventArgs.Cancel to true to skip generating a column for the current property.

    ItemsSourceChanged

    Occurs when the items source of the SfTreeGrid is changed.

    Declaration
    public event EventHandler<TreeGridItemsSourceChangedEventArgs> ItemsSourceChanged
    Event Type
    Type
    System.EventHandler<TreeGridItemsSourceChangedEventArgs>

    NodeCollapsed

    Occurs after a tree node has been collapsed.

    Declaration
    public event EventHandler<TreeGridNodeCollapsedEventArgs> NodeCollapsed
    Event Type
    Type
    System.EventHandler<TreeGridNodeCollapsedEventArgs>

    NodeCollapsing

    Occurs when a tree node is being collapsed.

    Declaration
    public event EventHandler<TreeGridNodeCollapsingEventArgs> NodeCollapsing
    Event Type
    Type
    System.EventHandler<TreeGridNodeCollapsingEventArgs>
    Remarks

    Handle this event to cancel a node collapse by setting to true in the event handler.

    NodeExpanded

    Occurs after a tree node has been expanded.

    Declaration
    public event EventHandler<TreeGridNodeExpandedEventArgs> NodeExpanded
    Event Type
    Type
    System.EventHandler<TreeGridNodeExpandedEventArgs>

    NodeExpanding

    Occurs when a tree node is being expanded.

    Declaration
    public event EventHandler<TreeGridNodeExpandingEventArgs> NodeExpanding
    Event Type
    Type
    System.EventHandler<TreeGridNodeExpandingEventArgs>
    Remarks

    Handle this event to cancel a node expansion by setting to true in the event handler.

    SelectionChanged

    Occurs after a row selection has changed.

    Declaration
    public event EventHandler<TreeGridSelectionChangedEventArgs> SelectionChanged
    Event Type
    Type
    System.EventHandler<TreeGridSelectionChangedEventArgs>

    SelectionChanging

    Occurs before a row selection changes.

    Declaration
    public event EventHandler<TreeGridSelectionChangingEventArgs> SelectionChanging
    Event Type
    Type
    System.EventHandler<TreeGridSelectionChangingEventArgs>

    SortColumnsChanged

    Occurs after the SortColumnDescriptions collection has been changed.

    Declaration
    public event EventHandler<TreeGridSortColumnsChangedEventArgs> SortColumnsChanged
    Event Type
    Type
    System.EventHandler<TreeGridSortColumnsChangedEventArgs>

    SortColumnsChanging

    Occurs before the SortColumnDescriptions collection is changed, allowing the change to be canceled.

    Declaration
    public event EventHandler<TreeGridSortColumnsChangingEventArgs> SortColumnsChanging
    Event Type
    Type
    System.EventHandler<TreeGridSortColumnsChangingEventArgs>

    TreeGridLoaded

    Occurs when the SfTreeGrid is fully loaded and ready for interaction.

    Declaration
    public event EventHandler TreeGridLoaded
    Event Type
    Type
    System.EventHandler

    Implements

    IDrawableLayout
    Microsoft.Maui.Graphics.IDrawable
    Microsoft.Maui.IAbsoluteLayout
    Microsoft.Maui.ILayout
    Microsoft.Maui.IView
    Microsoft.Maui.IElement
    Microsoft.Maui.ITransform
    Microsoft.Maui.IContainer
    System.Collections.Generic.IList<>
    System.Collections.Generic.ICollection<>
    System.Collections.Generic.IEnumerable<>
    System.Collections.IEnumerable
    Microsoft.Maui.ISafeAreaView
    Microsoft.Maui.IPadding
    Microsoft.Maui.ICrossPlatformLayout
    Microsoft.Maui.IVisualTreeElement

    Extension Methods

    TreeGridHelper.GetCellValue(SfTreeGrid, Object, String)
    TreeGridHelper.PointToRowColumnIndex(SfTreeGrid, Point, Boolean)
    TreeGridHelper.RowColumnIndexToPoint(SfTreeGrid, RowColumnIndex)
    TreeGridHelper.Refresh(SfTreeGrid)
    TreeGridHelper.RefreshColumns(SfTreeGrid)
    TreeGridIndexResolver.GetHeaderIndex(SfTreeGrid)
    TreeGridIndexResolver.GetNodeAtRowIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToRowIndex(SfTreeGrid, TreeNode)
    TreeGridIndexResolver.ResolveToRowIndex(SfTreeGrid, Object)
    TreeGridIndexResolver.ResolveToRowIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToGridVisibleColumnIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToNodeIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToScrollColumnIndex(SfTreeGrid, Int32)
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved