WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfTreeGrid - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfTreeGrid

    Represents a control that displays the data in a tree format.

    Inheritance
    System.Object
    SfGridBase
    SfTreeGrid
    Implements
    System.IDisposable
    Inherited Members
    SfGridBase.StackedHeaderRowsProperty
    SfGridBase.FooterColumnCountProperty
    SfGridBase.AllowEditingProperty
    SfGridBase.IsReadOnlyProperty
    SfGridBase.AllowSortingProperty
    SfGridBase.AllowSelectionOnPointerPressedProperty
    SfGridBase.SelectionModeProperty
    SfGridBase.NavigationModeProperty
    SfGridBase.EditorSelectionBehaviorProperty
    SfGridBase.EditTriggerProperty
    SfGridBase.CurrentCellBorderThicknessProperty
    SfGridBase.CurrentCellBorderBrushProperty
    SfGridBase.FrozenColumnCountProperty
    SfGridBase.GridLinesVisibilityProperty
    SfGridBase.HeaderLinesVisibilityProperty
    SfGridBase.ShowRowHeaderProperty
    SfGridBase.RowHeaderWidthProperty
    SfGridBase.HeaderRowHeightProperty
    SfGridBase.RowHeightProperty
    SfGridBase.AllowDraggingColumnsProperty
    SfGridBase.AllowResizingColumnsProperty
    SfGridBase.AllowResizingHiddenColumnsProperty
    SfGridBase.AutoGenerateColumnsProperty
    SfGridBase.AutoGenerateColumnsForCustomTypeProperty
    SfGridBase.AutoGenerateColumnsModeForCustomTypeProperty
    SfGridBase.CellTemplateSelectorProperty
    SfGridBase.AutoGenerateColumnsModeProperty
    SfGridBase.SortClickActionProperty
    SfGridBase.HeaderContextMenuProperty
    SfGridBase.RecordContextMenuProperty
    SfGridBase.AllowTriStateSortingProperty
    SfGridBase.ShowSortNumbersProperty
    SfGridBase.GridValidationModeProperty
    SfGridBase.SelectedIndexProperty
    SfGridBase.SelectedItemProperty
    SfGridBase.SelectedItemsProperty
    SfGridBase.SortColumnDescriptionsProperty
    SfGridBase.GridPasteOptionProperty
    SfGridBase.GridCopyOptionProperty
    SfGridBase.ShowToolTipProperty
    SfGridBase.Dispose()
    SfGridBase.StackedHeaderRows
    SfGridBase.FooterColumnCount
    SfGridBase.AllowEditing
    SfGridBase.IsReadOnly
    SfGridBase.AllowSorting
    SfGridBase.AllowSelectionOnPointerPressed
    SfGridBase.SelectionMode
    SfGridBase.NavigationMode
    SfGridBase.EditorSelectionBehavior
    SfGridBase.EditTrigger
    SfGridBase.CurrentCellBorderThickness
    SfGridBase.CurrentCellBorderBrush
    SfGridBase.FrozenColumnCount
    SfGridBase.GridLinesVisibility
    SfGridBase.HeaderLinesVisibility
    SfGridBase.ShowRowHeader
    SfGridBase.RowHeaderWidth
    SfGridBase.HeaderRowHeight
    SfGridBase.RowHeight
    SfGridBase.AllowDraggingColumns
    SfGridBase.AllowResizingColumns
    SfGridBase.AllowResizingHiddenColumns
    SfGridBase.AutoGenerateColumns
    SfGridBase.AutoGenerateColumnsForCustomType
    SfGridBase.AutoGenerateColumnsModeForCustomType
    SfGridBase.CellTemplateSelector
    SfGridBase.AutoGenerateColumnsMode
    SfGridBase.SortClickAction
    SfGridBase.AllowTriStateSorting
    SfGridBase.HeaderContextMenu
    SfGridBase.RecordContextMenu
    SfGridBase.ShowSortNumbers
    SfGridBase.GridValidationMode
    SfGridBase.SelectedIndex
    SfGridBase.SelectedItem
    SfGridBase.SelectedItems
    SfGridBase.SortColumnDescriptions
    SfGridBase.GridPasteOption
    SfGridBase.GridCopyOption
    SfGridBase.ShowToolTip
    Namespace: Syncfusion.UI.Xaml.TreeGrid
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public class SfTreeGrid : SfGridBase, IDisposable
    Remarks

    The SfTreeGrid control provides a flexible way to display and manipulate self-relational and hierarchical data and the built-in column types allows the data to be displayed in to appropriate editor.

    Constructors

    SfTreeGrid()

    Initialize a new instance of the SfTreeGrid class.

    Declaration
    public SfTreeGrid()

    Fields

    AllowAutoSizingExpanderColumnProperty

    Identifies the AllowAutoSizingExpanderColumn dependency property.

    Declaration
    public static readonly DependencyProperty AllowAutoSizingExpanderColumnProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the AllowAutoSizingExpanderColumn dependency property.

    AllowDraggingRowsProperty

    Identifies the AllowDraggingRows dependency property.

    Declaration
    public static readonly DependencyProperty AllowDraggingRowsProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the AllowDraggingRows dependency property.

    AllowFilteringProperty

    Identifies the AllowFiltering dependency property.

    Declaration
    public static readonly DependencyProperty AllowFilteringProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the AllowFiltering dependency property.

    AllowSelectionOnExpanderClickProperty

    Identifies the AllowSelectionOnExpanderClick dependency property.

    Declaration
    public static readonly DependencyProperty AllowSelectionOnExpanderClickProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the AllowSelectionOnExpanderClick dependency property.

    AllowTriStateCheckingProperty

    Identifies the AllowTriStateChecking dependency property.

    Declaration
    public static readonly DependencyProperty AllowTriStateCheckingProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the AllowTriStateChecking dependency property.

    AutoExpandModeProperty

    Identifies the AutoExpandMode dependency property.

    Declaration
    public static readonly DependencyProperty AutoExpandModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the AutoExpandMode dependency property.

    CellStyleProperty

    Identifies the CellStyle dependency property.

    Declaration
    public static readonly DependencyProperty CellStyleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the CellStyle dependency property.

    CellStyleSelectorProperty

    Identifies the CellStyleSelector dependency property.

    Declaration
    public static readonly DependencyProperty CellStyleSelectorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the CellStyleSelector dependency property.

    CheckBoxMappingNameProperty

    Identifies the CheckBoxMappingName dependency property.

    Declaration
    public static readonly DependencyProperty CheckBoxMappingNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the CheckBoxMappingName dependency property.

    CheckBoxSelectionModeProperty

    Identifies the CheckBoxSelectionMode dependency property.

    Declaration
    public static readonly DependencyProperty CheckBoxSelectionModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the CheckBoxSelectionMode dependency property.

    ChildPropertyNameProperty

    Identifies the ChildPropertyName dependency property.

    Declaration
    public static readonly DependencyProperty ChildPropertyNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ChildPropertyName dependency property.

    ColumnSizerProperty

    Identifies the ColumnSizer dependency property.

    Declaration
    public static readonly DependencyProperty ColumnSizerProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ColumnSizer dependency property.

    ColumnsProperty

    Identifies the Columns dependency property.

    Declaration
    public static readonly DependencyProperty ColumnsProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the Columns dependency property.

    CurrentColumnProperty

    Identifies the CurrentColumn dependency property.

    Declaration
    public static readonly DependencyProperty CurrentColumnProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the CurrentColumn dependency property.

    CurrentItemProperty

    Identifies the CurrentItem dependency property.

    Declaration
    public static readonly DependencyProperty CurrentItemProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the CurrentItem dependency property.

    EnableRecursiveCheckingProperty

    Identifies the EnableRecursiveChecking dependency property.

    Declaration
    public static readonly DependencyProperty EnableRecursiveCheckingProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the EnableRecursiveChecking dependency property.

    ExpanderCellStyleProperty

    Identifies the ExpanderCellStyle dependency property.

    Declaration
    public static readonly DependencyProperty ExpanderCellStyleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ExpanderCellStyle dependency property.

    ExpanderCellStyleSelectorProperty

    Identifies the ExpanderCellStyleSelector dependency property.

    Declaration
    public static readonly DependencyProperty ExpanderCellStyleSelectorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ExpanderCellStyleSelector dependency property.

    ExpanderColumnProperty

    Identifies the ExpanderColumn dependency property.

    Declaration
    public static readonly DependencyProperty ExpanderColumnProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ExpanderColumn dependency property.

    ExpanderContextMenuProperty

    Identifies the ExpanderContextMenu dependency property.

    Declaration
    public static readonly DependencyProperty ExpanderContextMenuProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ExpanderContextMenu dependency property.

    ExpandStateMappingNameProperty

    Identifies the ExpandStateMappingName dependency property.

    Declaration
    public static readonly DependencyProperty ExpandStateMappingNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for ExpandStateMappingName dependency property.

    FilterLevelProperty

    Identifies the FilterLevel dependency property.

    Declaration
    public static readonly DependencyProperty FilterLevelProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the FilterLevel dependency property.

    FilterPopupStyleProperty

    Identifies the FilterPopupStyle dependency property.

    Declaration
    public static readonly DependencyProperty FilterPopupStyleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the FilterPopupStyle dependency property.

    FilterPopupTemplateProperty

    Identifies the FilterPopupTemplate dependency property.

    Declaration
    public static readonly DependencyProperty FilterPopupTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the FilterPopupTemplate dependency property.

    HeaderStyleProperty

    Identifies the HeaderStyle dependency property.

    Declaration
    public static readonly DependencyProperty HeaderStyleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the HeaderStyle dependency property.

    HeaderTemplateProperty

    Identifies the HeaderTemplate dependency property.

    Declaration
    public static readonly DependencyProperty HeaderTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the HeaderTemplate dependency property.

    ItemsSourceProperty

    Identifies the ItemsSource dependency property.

    Declaration
    public static readonly DependencyProperty ItemsSourceProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ItemsSource dependency property.

    LiveNodeUpdateModeProperty

    Identifies the LiveNodeUpdateMode dependency property.

    Declaration
    public static readonly DependencyProperty LiveNodeUpdateModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the LiveNodeUpdateMode dependency property.

    LoadOnDemandCommandProperty

    Identifies the LoadOnDemandCommand bindable property.

    Declaration
    public static readonly DependencyProperty LoadOnDemandCommandProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    This bindable property is read-only.

    NotificationSubscriptionModeProperty

    Identifies the NotificationSubscriptionMode dependency property.

    Declaration
    public static readonly DependencyProperty NotificationSubscriptionModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the NotificationSubscriptionMode dependency property.

    ParentPropertyNameProperty

    Identifies the ParentPropertyName dependency property.

    Declaration
    public static readonly DependencyProperty ParentPropertyNameProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ParentPropertyName dependency property.

    RecursiveCheckingModeProperty

    Identifies the RecursiveCheckingMode dependency property.

    Declaration
    public static readonly DependencyProperty RecursiveCheckingModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the RecursiveCheckingMode dependency property.

    RowDragDropTemplateProperty

    Identifies the RowDragDropTemplate bindable property.

    Declaration
    public static readonly DependencyProperty RowDragDropTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    This bindable property is read-only.

    RowDropIndicatorModeProperty

    Identifies the RowDropIndicatorModeProperty dependency property.

    Declaration
    public static readonly DependencyProperty RowDropIndicatorModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    RowGenerator

    Instance of TreeGridRowGenerator of SfTreeGrid

    Declaration
    protected TreeGridRowGenerator RowGenerator
    Field Value
    Type Description
    TreeGridRowGenerator

    RowIndentModeProperty

    Identifies the RowIndentMode dependency property.

    Declaration
    public static readonly DependencyProperty RowIndentModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the RowIndentMode dependency property.

    RowStyleProperty

    Identifies the RowStyle dependency property.

    Declaration
    public static readonly DependencyProperty RowStyleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the RowStyle dependency property.

    RowStyleSelectorProperty

    Identifies the RowStyleSelector dependency property.

    Declaration
    public static readonly DependencyProperty RowStyleSelectorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the RowStyleSelector dependency property.

    SelectionBackgroundProperty

    Identifies the SelectionBackground dependency property.

    Declaration
    public static readonly DependencyProperty SelectionBackgroundProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the SelectionBackground dependency property.

    SelectionForegroundProperty

    Identifies the SelectionForeground dependency property.

    Declaration
    public static readonly DependencyProperty SelectionForegroundProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the SelectionForeground dependency property.

    SelfRelationRootValueProperty

    Identifies the SelfRelationRootValue dependency property.

    Declaration
    public static readonly DependencyProperty SelfRelationRootValueProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the SelfRelationRootValue dependency property.

    SelfRelationUpdateModeProperty

    Identifies the SelfRelationUpdateMode dependency property.

    Declaration
    public static readonly DependencyProperty SelfRelationUpdateModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the SelfRelationUpdateMode dependency property.

    ShowCheckBoxProperty

    Identifies the ShowCheckBox dependency property.

    Declaration
    public static readonly DependencyProperty ShowCheckBoxProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the ShowCheckBox dependency property.

    SortComparersProperty

    Identifies the SortComparers dependency property.

    Declaration
    public static readonly DependencyProperty SortComparersProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the SortComparers dependency property.

    SourceTypeProperty

    Identifies the SourceType dependency property.

    Declaration
    public static readonly DependencyProperty SourceTypeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the SourceType dependency property.

    TreeGridCopyPasteProperty

    Identifies the TreeGridCopyPaste dependency property.

    Declaration
    public static readonly DependencyProperty TreeGridCopyPasteProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty
    Remarks

    The identifier for the TreeGridCopyPaste dependency property.

    Properties

    AllowAutoSizingExpanderColumn

    Gets or sets whether to change the width of expander column while expanding or collapsing based on maximum no of levels expanded.

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

    true if the AllowAutoSizingExpanderColumn is enabled in SfDataGrid AllowFiltering; otherwise, false. The default value is false.

    AllowDraggingRows

    Gets or sets a value that indicates whether the user can drag and drop rows.

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

    truethe row can be drag and drop; Otherwise, false. The default value is false.

    AllowFiltering

    Gets or sets a value that indicates whether UI filtering is enabled in SfTreeGrid.

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

    True if UI filtering is enabled; otherwise, false. The default value is false.

    AllowSelectionOnExpanderClick

    Gets or sets a value which specifies whether selection should be added while clicking expander for expanding/collapsing the nodes.

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

    true if the row or cell can be selected with Expanderclick; otherwise, false. The default value is True.

    AllowTriStateChecking

    Gets or sets a value which specifies IsThreeState property value of Node CheckBox.

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

    true if the Tristatechecking as enabled; otherwise, false. The default value is false.

    Remarks

    Node check can be displayed in expander by setting ShowCheckBox

    AutoExpandMode

    Gets or sets the value which indicates how the nodes to be expanded while loading.

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

    The default value is None.

    AutoScroller

    Gets or sets an instance of the TreeGridAutoScroller to perform horizontal or vertical scrolling automatically, when the row/column is dragged outside of the visible boundaries in SfTreeGrid.

    Declaration
    public TreeGridAutoScroller AutoScroller { get; set; }
    Property Value
    Type Description
    TreeGridAutoScroller

    An instance of the TreeGridAutoScroller.

    CellRenderers

    Gets the reference to the TreeGridCellRendererCollection instance which holds the collection of all predefined cell renderers TreeGridVirtualizingCellRenderer<D, E>.

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

    An instance of the TreeGridCellRendererCollection.

    Remarks

    The cell renderers provides various properties and virtual methods to customize its operations. When any of the predefined renderer is customized, that should be replaced to the CellRenderers collection with its appropriate cell type. The below table shows the predefined renderers and its corresponding cell type associated with column.

    Renderer  ClassCell TypeAssociated column
    TreeGridCellTextBoxRendererTextBoxTreeGridTextColumn
    TreeGridCellNumericRendererNumericTreeGridNumericColumn
    TreeGridCellCheckBoxRendererCheckBoxTreeGridCheckBoxColumn
    TreeGridCellTemplateRendererTemplateTreeGridTemplateColumn
    TreeGridCellComboBoxRendererComboBoxTreeGridComboBoxColumn
    TreeGridCellDateTimeRendererDateTimeTreeGridDateTimeColumn
    TreeGridCellHyperLinkRendererHyperLinkTreeGridHyperLinkColumn
    TreeGridHeaderCellRendererHeader-
    TreeGridCellTextBlockRendererTextBlock-
    TreeGridRowHeaderCellRendererRowHeader-
    Examples
    //The customized TreeGridCellTextBoxRendererExt is replaced to CellRenderers collection after removed the default renderer of TreeGridTextColumn.
    this.treeGrid.CellRenderers.Remove("TextBox");
    this.treeGrid.CellRenderers.Add("TextBox",new TreeGridCellTextBoxRendererExt());

    CellStyle

    Gets or sets the style applied to all the record cells in SfTreeGrid.

    Declaration
    public Style CellStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Style

    The style that is applied to all the record cells in SfTreeGrid. The default value is null.

    Remarks

    To define a Microsoft.UI.Xaml.Style for a cell, specify a TargetType of TreeGridCell.

    Examples
    <Page.Resources>
        <Style x:Key="cellstyle" TargetType="treeGrid:TreeGridCell">
            <Setter Property="Background" Value="Bisque"/>
        </Style>
    </Page.Resources>
    <treeGrid:SfTreeGrid  x:Name="sfTreeGrid"                   
                          CellStyle="{StaticResource cellstyle}"
                          AutoExpandMode="RootNodesExpanded"
                          AutoGenerateColumns="True"
                          ChildPropertyName="Children"
                          ExpanderColumn="FirstName"
                          ItemsSource="{Binding Persons}">
    </treeGrid:SfTreeGrid>

    CellStyleSelector

    Gets or sets the style applied to record cells conditionally based on data in SfTreeGrid.

    Declaration
    public StyleSelector CellStyleSelector { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.StyleSelector

    A StyleSelector object that chooses the style to cell based on data. The default value is null.

    Remarks

    To define a Style for a cell, specify a TargetType of TreeGridCell.

    See Also
    CellStyle

    CheckBoxMappingName

    Gets or sets the name of a property in data object associated with node check box.

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

    The CheckBox mapping name.

    See Also
    ShowCheckBox

    CheckBoxSelectionMode

    Gets or sets a value that specifies how selection should be processed when node CheckBox is checked or unchecked.

    Declaration
    public CheckBoxSelectionMode CheckBoxSelectionMode { get; set; }
    Property Value
    Type Description
    CheckBoxSelectionMode

    One of the CheckBoxSelectionMode enumeration which specify how selection should be processed when node CheckBox is checked or unchecked. The default value is Default.

    See Also
    ShowCheckBox

    ChildPropertyName

    Gets or sets the property name for the child object where ItemsSource is used to define the items for this tree.

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

    The child property name.

    Remarks

    Use this property only if you do not want to use the RequestTreeItems event to populate the tree nodes directly. You need to set this property to be the IEnumerable collection of root nodes for this tree if Nested collection is used. In self relational mode, ChildPropertyName and ParentPropertyName form the relation.

    ColumnDragDropController

    Gets or sets an instance of the TreeGridColumnDragDropController which controls the column drag-and-drop operation in SfTreeGrid.

    Declaration
    public TreeGridColumnDragDropController ColumnDragDropController { get; set; }
    Property Value
    Type Description
    TreeGridColumnDragDropController

    An instance of the TreeGridColumnDragDropController class.

    Remarks

    TreeGridColumnDragDropController class provides various properties and virtual methods to customize its operations.

    ColumnResizingController

    Gets or sets an instance of the TreeGridColumnResizingController which controls the resizing operation in SfTreeGrid.

    Declaration
    public TreeGridColumnResizingController ColumnResizingController { get; set; }
    Property Value
    Type Description
    TreeGridColumnResizingController

    An instance of the TreeGridColumnResizingController class.

    Remarks

    TreeGridColumnResizingController class provides various properties and virtual methods to customize its operations.

    Columns

    Gets or sets the collection that contains all the columns in SfTreeGrid.

    Declaration
    public TreeGridColumns Columns { get; set; }
    Property Value
    Type Description
    TreeGridColumns

    The collection that contains all the columns in SfTreeGrid. This property has no default value.

    Remarks

    Each column associated with its own renderer and it controls the corresponding column related operations.

    Exceptions
    Type Condition
    System.NullReferenceException

    Thrown when the Columns value is set as null.

    See Also
    CellRenderers

    ColumnSizer

    Gets or sets a value that indicates how the column widths are determined.

    Declaration
    public TreeColumnSizer ColumnSizer { get; set; }
    Property Value
    Type Description
    TreeColumnSizer

    One of the TreeColumnSizer enumeration that calculate the column width. The default value is None.

    Remarks

    The default behavior of ColumnSizer can be customized through TreeGridColumnSizer property.

    CurrentColumn

    Gets or sets the column that contains the current cell.

    Declaration
    public TreeGridColumn CurrentColumn { get; set; }
    Property Value
    Type Description
    TreeGridColumn

    The column that contains the current cell. The default value is null.

    CurrentItem

    Gets or sets the data item that corresponds to the focused row or cell.

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

    The corresponding focused data item.The default registered value is null.

    EnableRecursiveChecking

    Gets or sets a value which specifies whether recursive node checking is enabled or not. If recursive node checking enabled, node check box state will be changed based on its child or parent check box state.

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

    true if Recursivechecking is enabled; otherwise, false. The default value is false.

    Remarks

    RecursiveChecking behavior can be changed by setting RecursiveCheckingMode property.

    ExpanderCellStyle

    Gets or sets the style applied to expander cells in SfTreeGrid.

    Declaration
    public Style ExpanderCellStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Style

    The style that is applied to expander cells in SfTreeGrid. The default value is null.

    Remarks

    To define a System.Windows.Style for a cell, specify a TargetType of TreeGridExpanderCell.

    ExpanderCellStyleSelector

    Gets or sets the style applied to expander cells conditionally based on data in SfTreeGrid.

    Declaration
    public StyleSelector ExpanderCellStyleSelector { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.StyleSelector

    A System.Windows.Controls.StyleSelector object that chooses the style to cell based on data. The default value is null.

    Remarks

    To define a Microsoft.UI.Xaml.Style for a cell, specify a TargetType of TreeGridExpanderCell.

    See Also
    ExpanderCellStyle

    ExpanderColumn

    Gets or sets the column name which will be shown as expander column.

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

    The expander column name.

    ExpanderContextMenu

    Gets or sets the shortcut menu that appears on each expander column cells in SfTreeGrid.

    Declaration
    public ContextMenu ExpanderContextMenu { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.ContextMenu

    The shortcut menu for each expander column cells in SfTreeGrid. The default value is null.

    Remarks

    Command bound with MenuFlyoutItem receives TreeGridNodeContextMenuInfo as command parameter which contains the corresponding expander column cells with Child nodes.

    ExpandStateMappingName

    Gets or sets the value to the name of the property in a data object that associated with the tree node expanded or collapsed state.

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

    The default value of ExpandStateMappingName 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 Description
    FilterLevel

    One of the FilterLevel enumeration that specifies how nodes should be filtered. The default value is All.

    FilterPopupStyle

    Gets or sets the style applied to the filter pop-up in SfTreeGrid.

    Declaration
    public Style FilterPopupStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Style

    The style that is applied to the filter pop-up in SfTreeGrid. The default value is null.

    Remarks

    To define a System.Windows.Style for a filter pop-up, specify a TargetType of GridFilterControl.

    FilterPopupTemplate

    Gets or sets System.Windows.DataTemplate that defines the visual representation of the filter pop-up in SfTreeGrid.

    Declaration
    public DataTemplate FilterPopupTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    The object that defines the visual representation of the filter pop-up. The default value is null.

    See Also
    FilterPopupTemplate
    FilterPopupStyle

    HeaderStyle

    Gets or sets the style applied to all the header cells in SfTreeGrid.

    Declaration
    public Style HeaderStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Style

    The style that is applied to all the header cells in SfTreeGrid. The default value is null.

    Remarks

    To define a System.Windows.Style for header cell, specify a TargetType of TreeGridHeaderCell.

    Examples
    <Page.Resources>
            <Style TargetType="treeGrid:TreeGridHeaderCell" x:Key="headerStyle">
                <Setter Property="FontWeight" Value="Bold"/>
                <Setter Property="FontSize" Value="14"/>
                <Setter Property="Background" Value="LightPink"/>
                <Setter Property="Foreground" Value="DarkBlue"/>
            </Style>
    </Page.Resources>
    <treeGrid:SfTreeGrid  x:Name="sfTreeGrid"
                          HeaderStyle="{StaticResource headerStyle}"
                          AutoExpandMode="RootNodesExpanded"
                          AutoGenerateColumns="True"
                          ChildPropertyName="Children"
                          ExpanderColumn="FirstName"
                          ItemsSource="{Binding Persons}">
    </treeGrid:SfTreeGrid>

    HeaderTemplate

    Gets or sets System.Windows.DataTemplate that defines the visual representation of the header cell in SfTreeGrid.

    Declaration
    public DataTemplate HeaderTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    The object that defines the visual representation of the header cell in SfTreeGrid. The default value is null.

    ItemsSource

    Gets or sets the collection that is used to generate the content of the SfTreeGrid.

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

    The collection that is used to generate the content of the SfTreeGrid. The default value is null.

    Remarks

    ItemsSourceChanged event will be raised when the ItemsSource property gets changed.

    LiveNodeUpdateMode

    Gets or sets a value to control data manipulation operations during data updates.

    Declaration
    public LiveNodeUpdateMode LiveNodeUpdateMode { get; set; }
    Property Value
    Type Description
    LiveNodeUpdateMode

    One of the LiveNodeUpdateMode that indicates how data manipulation operations are handled during data updates. The default value is Default.

    LoadOnDemandCommand

    Gets or sets the System.Windows.Input.ICommand which will be executed when click on the expander.

    Declaration
    public ICommand LoadOnDemandCommand { get; set; }
    Property Value
    Type Description
    System.Windows.Input.ICommand

    Command that used to load the data's based on demand.

    Remarks

    Return true in CanExecute method of this command to enable expander icon and also to execute on demand loading for that node, else return false.

    Examples
    <syncfusion:SfTreeGrid Name="treeGrid"
               LoadOnDemandCommand="{Binding LoadCommand}"
               ItemsSource="{Binding EmployeeDetails}"/>
    public class LoadCommand : ICommand
    {
       public event EventHandler CanExecuteChanged;
       public bool CanExecute(object parameter)
       {
           TreeNode node = (parameter as TreeNode);
           EmployeeInfo employeeInfo = node.Item as EmployeeInfo;
           if (employeeInfo != null)
               if (employeeInfo.ReportsTo == -1)
                   return true;
           return false;
       }
       public void Execute(object parameter)
       {
           TreeNode node = (parameter as TreeNode);
           EmployeeInfo employeeInfo = node.Item as EmployeeInfo;
           if (employeeInfo != null)
               node.PopulateChildNodes(GetReportees(employeeInfo.ID));
       }
    }

    NotificationSubscriptionMode

    Gets or sets a value that indicates whether to listen System.ComponentModel.INotifyPropertyChanging.PropertyChanging and System.ComponentModel.INotifyPropertyChanged.PropertyChanged events of data object and System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged event of SourceCollection.

    Declaration
    public NotificationSubscriptionMode NotificationSubscriptionMode { get; set; }
    Property Value
    Type Description
    NotificationSubscriptionMode

    listen System.ComponentModel.INotifyPropertyChanging.PropertyChanging and System.ComponentModel.INotifyPropertyChanged.PropertyChanged events of data object and System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged event of .

    Remarks

    By default, view listens to System.ComponentModel.INotifyPropertyChanging.PropertyChanging and System.ComponentModel.INotifyPropertyChanged.PropertyChanged events of data object and System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged event of SourceCollection.

    ParentPropertyName

    Gets or sets the property name for the parent object where ItemsSource is used to define the items for this tree when a self-relation is determining the tree structure.

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

    The parent property name.

    Remarks

    Use this property only if you do not want to use the RequestTreeItems event to populate the tree nodes directly. In self relational mode, ChildPropertyName and ParentPropertyName form the relation. It should be unique.

    RecursiveCheckingMode

    Gets or sets the value which indicates in which case recursive checking should be applied when EnableRecursiveChecking is true.

    Declaration
    public RecursiveCheckingMode RecursiveCheckingMode { get; set; }
    Property Value
    Type Description
    RecursiveCheckingMode

    The default value is Default.

    RowDragDropController

    Gets or sets an instance of the TreeGridRowDragDropController which controls the row drag-and-drop operation in SfTreeGrid.

    Declaration
    public TreeGridRowDragDropController RowDragDropController { get; set; }
    Property Value
    Type Description
    TreeGridRowDragDropController

    An instance of the TreeGridRowDragDropController class.

    Remarks

    TreeGridRowDragDropController class provides various properties and virtual methods to customize its operations.

    RowDragDropTemplate

    Gets or sets the row drag and drop template that is used to display when row dragging and dropping.

    Declaration
    public DataTemplate RowDragDropTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    The object that defines the visual representation of the row drag drop in SfTreeGrid. The default value is null.

    Remarks

    Default template will be displayed, if row drag and drop template is empty.

    RowDropIndicatorMode

    Gets or sets a value that indicates the mode of drop indicator notify the position of a row where the dragged rows are going to be dropped.

    Declaration
    public DropIndicatorMode RowDropIndicatorMode { get; set; }
    Property Value
    Type Description
    DropIndicatorMode

    One of the DropIndicatorMode enumeration that specifies mode of Dropindicator. The default value is Arrow.

    RowIndentMode

    Gets or sets a value that specifies the selection and row background indentation in row, when expander column is first column.

    Declaration
    public RowIndentMode RowIndentMode { get; set; }
    Property Value
    Type Description
    RowIndentMode

    One of the RowIndentMode enumeration the selection and background indentation in row. The default value is Default.

    RowStyle

    Gets or sets the style applied to the data rows in SfTreeGrid.

    Declaration
    public Style RowStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Style

    The style that is applied to all data rows in SfTreeGrid. The default value is null.

    Remarks

    To define a System.Windows.Style for a row, specify a TargetType of TreeGridRowControl.

    RowStyleSelector

    Gets or sets the style applied to data row conditionally based on data in SfTreeGrid.

    Declaration
    public StyleSelector RowStyleSelector { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.StyleSelector

    A System.Windows.Controls.StyleSelector object that chooses the style to data row based on data. The default value is null.

    Remarks

    To define a System.Windows.Style for a row, specify a TargetType of TreeGridRowControl.

    See Also
    RowStyle

    SelectionBackground

    Gets or sets a brush that highlights the background of the currently selected row or cell.

    Declaration
    public Brush SelectionBackground { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    The brush that highlights the background of the selected row or cell.

    SelectionController

    Gets or sets the instance of TreeGridBaseSelectionController which controls selection operations in SfTreeGrid.

    Declaration
    public TreeGridBaseSelectionController SelectionController { get; set; }
    Property Value
    Type Description
    TreeGridBaseSelectionController

    An instance of TreeGridBaseSelectionController.

    Remarks

    The default behavior of row selection can be customized by assigning the class derived from TreeGridRowSelectionController to SelectionController property.

    SelectionForeground

    Gets or sets a brush that will be applied as the foreground of selected row.

    Declaration
    public Brush SelectionForeground { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    The brush that will be applied as the foreground of selected row. The default value is Black.

    SelfRelationRootValue

    Gets or sets the value that defines the root object in a self-relational mode when ItemsSource is used to define the underlying tree data.

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

    The root value for the relation item. The default registered value is null.

    SelfRelationUpdateMode

    Gets or sets a value that indicates how nodes should be arranged while changing ChildPropertyName and ParentPropertyName in Self Relational mode.

    Declaration
    public SelfRelationUpdateMode SelfRelationUpdateMode { get; set; }
    Property Value
    Type Description
    SelfRelationUpdateMode

    One of the SelfRelationUpdateMode enumeration that specifies how the nodes should be arranged. The default value is and .

    ShowCheckBox

    Gets or sets a value which specifies whether checkbox should be displayed next to expander.

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

    The default value is false.

    See Also
    CheckBoxSelectionMode
    EnableRecursiveChecking
    AllowTriStateChecking
    RecursiveCheckingMode

    SortComparers

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

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

    Compares two SortComparer to perform sort operation based on custom logic.

    Remarks

    A comparer that are added to SortComparers collection to apply custom Sorting based on the specified column name and sort direction.

    SourceType

    Gets or sets the type of data object displayed in SfTreeGrid.

    Declaration
    public Type SourceType { get; set; }
    Property Value
    Type Description
    System.Type

    Returns the type of the Source.

    Remarks

    Used to specify the type of data object for column population and data (sorting and filtering) when your data object have multilevel inheritance.

    TreeGridColumnSizer

    Gets or sets an instance of the TreeGridColumnSizer which controls columns sizing and column width calculation.

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

    An instance of the TreeGridColumnSizer class.

    Remarks

    TreeGridColumnSizer class provides various properties and virtual methods to customize its operations.

    TreeGridCopyPaste

    Gets or sets an instance of the TreeGridCutCopyPaste interface which controls the copy and paste operations in SfTreeGrid.

    Declaration
    public TreeGridCutCopyPaste TreeGridCopyPaste { get; set; }
    Property Value
    Type Description
    TreeGridCutCopyPaste

    An instance of class that derives from TreeGridCutCopyPaste interface. The default value is null.

    Remarks

    The TreeGridCutCopyPaste class provides various properties and virtual methods to customize its operations.

    TreeGridModel

    Gets the reference to the TreeGridModel instance which manages interaction between SfTreeGrid and TreeGridView

    Declaration
    protected TreeGridModel TreeGridModel { get; set; }
    Property Value
    Type Description
    TreeGridModel

    The reference to the TreeGridModel instance.

    TreeGridPanel

    Gets or sets the TreeGridPanel to arrange the data in panel.

    Declaration
    protected TreeGridPanel TreeGridPanel { get; set; }
    Property Value
    Type Description
    TreeGridPanel

    An instance of TreeGridPanel.

    View

    Gets the reference to the TreeGridView instance which manage the nodes, expand, collapse operations and sorting in SfTreeGrid.

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

    An instance of TreeGridView.

    Remarks

    View will be created based on ItemsSource you are setting. Below are the list of CollectionViews available in SfTreeGrid.

    1. TreeGridQueryableView
    2. TreeGridSelfRelationalView
    3. TreeGridUnboundReview

    Methods

    ArrangeOverride(Size)

    Arranges the content of the SfTreeGrid.

    Declaration
    protected override Size ArrangeOverride(Size arrangeBounds)
    Parameters
    Type Name Description
    System.Windows.Size arrangeBounds

    The computed size that is used to arrange the content.

    Returns
    Type Description
    System.Windows.Size

    The size consumed by SfTreeGrid.

    ClearFilter(TreeGridColumn)

    Clears the filters for the particular column.

    Declaration
    public void ClearFilter(TreeGridColumn column)
    Parameters
    Type Name Description
    TreeGridColumn column

    The corresponding column to clear the filters.

    ClearFilter(String)

    Clears the filters for the particular column.

    Declaration
    public void ClearFilter(string columnName)
    Parameters
    Type Name Description
    System.String columnName

    The MappingName of the corresponding column to clear the filters.

    ClearFilters()

    Clears the filters for all the columns in SfTreeGrid.

    Declaration
    public void ClearFilters()

    ClearSelections(Boolean)

    Clears all the selection present in SfTreeGrid.

    Declaration
    public void ClearSelections(bool exceptCurrentRow)
    Parameters
    Type Name Description
    System.Boolean exceptCurrentRow

    Indicates whether the selection should be cleared for the current row or not.

    Remarks

    This method helps to clear the selection programmatically.

    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.

    Dispose(Boolean)

    Disposes all the resources used by the SfTreeGrid class.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    Specifies that need to disposed or not.

    Overrides
    SfGridBase.Dispose(Boolean)

    EnsureViewProperties()

    Ensures selection related operations in View.

    Declaration
    protected void EnsureViewProperties()

    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.

    GetCheckedNodes(Boolean)

    Returns the checked nodes in SfTreeGrid.

    Declaration
    public ObservableCollection<TreeNode> GetCheckedNodes(bool includeAllNodes = false)
    Parameters
    Type Name Description
    System.Boolean includeAllNodes

    which specifies whether need to include the nodes which are not in view.

    Returns
    Type Description
    System.Collections.ObjectModel.ObservableCollection<TreeNode>

    Collection of TreeNode.

    MeasureOverride(Size)

    Determines the desired size of the SfTreeGrid.

    Declaration
    protected override Size MeasureOverride(Size constraint)
    Parameters
    Type Name Description
    System.Windows.Size constraint

    The size that the SfTreeGrid can occupy.

    Returns
    Type Description
    System.Windows.Size

    The desired size of SfTreeGrid.

    OnApplyTemplate()

    Builds the visual tree for the SfTreeGrid when a new template is applied.

    Declaration
    public override void OnApplyTemplate()

    OnContextMenuOpening(ContextMenuEventArgs)

    Occurs when the context menu is opening.

    Declaration
    protected override void OnContextMenuOpening(ContextMenuEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Controls.ContextMenuEventArgs e

    The ContextMenuEventArgs that contains the event data.

    Remarks

    Handling the context menu showing operations of TreeGrid.

    OnCreateAutomationPeer()

    Creates and returns an  object for the SfTreeGrid.

    Declaration
    protected override AutomationPeer OnCreateAutomationPeer()
    Returns
    Type Description
    System.Windows.Automation.Peers.AutomationPeer

    Returns new instance of for the SfTreeGrid.

    OnPreviewKeyDown(KeyEventArgs)

    Occurs when the PreviewKeyDown attached event reaches an element in its route that is derived from this class.

    Declaration
    protected override void OnPreviewKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e

    The System.Windows.Input.KeyEventArgs that contains the event data.

    OnTextInput(TextCompositionEventArgs)

    Occurs when the TextInput attached event reaches an element in its route that is derived from this class.

    Declaration
    protected override void OnTextInput(TextCompositionEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TextCompositionEventArgs e

    The System.Windows.Input.TextCompositionEventArgs that contains the event data.

    RaiseCellDoubleTappedEvent(TreeGridCellDoubleTappedEventArgs)

    Raises the CellDoubleTapped event in SfTreeGrid.

    Declaration
    protected void RaiseCellDoubleTappedEvent(TreeGridCellDoubleTappedEventArgs args)
    Parameters
    Type Name Description
    TreeGridCellDoubleTappedEventArgs args

    Specifies the TreeGridCellDoubleTappedEventArgs that contains the event data.

    RaiseCellTappedEvent(TreeGridCellTappedEventArgs)

    Raises the CellTapped event in SfTreeGrid.

    Declaration
    protected void RaiseCellTappedEvent(TreeGridCellTappedEventArgs args)
    Parameters
    Type Name Description
    TreeGridCellTappedEventArgs args

    Specifies the TreeGridCellTappedEventArgs that contains the event data.

    RaiseCellToolTipOpeningEvent(TreeGridCellToolTipOpeningEventArgs)

    Raises the CellToolTipOpening event in SfTreeGrid.

    Declaration
    protected void RaiseCellToolTipOpeningEvent(TreeGridCellToolTipOpeningEventArgs args)
    Parameters
    Type Name Description
    TreeGridCellToolTipOpeningEventArgs args

    Specifies the TreeGridCellToolTipOpeningEventArgs that contains the event data.

    RaiseItemsSourceChanged(Object, Object)

    To raise the ItemsSourceChanged event in SfTreeGrid.

    Declaration
    protected void RaiseItemsSourceChanged(object oldItemsSource, object newItemsSOurce)
    Parameters
    Type Name Description
    System.Object oldItemsSource

    The old itemsSource.

    System.Object newItemsSOurce

    The new itemsSource.

    RefreshHeaderLineCount()

    Updates the frozen rows count.

    Declaration
    protected virtual void RefreshHeaderLineCount()

    RefreshPanelAndView()

    Refreshes TreeGridPanel and View properties based on SfTreeGrid property settings.

    Declaration
    protected virtual void RefreshPanelAndView()
    Examples

    The View.CurrentItem updated based on SfTreeGrid.CurrentItem property.

    RepopulateTree()

    Repopulate the tree in on demand loading.

    Declaration
    public void RepopulateTree()
    Remarks

    You can use this event when RequestTreeItems event is used to populate the tree.

    ResetNode(TreeNode)

    Resets the child nodes of the particular node and repopulate child nodes.

    Declaration
    public void ResetNode(TreeNode treeNode)
    Parameters
    Type Name Description
    TreeNode treeNode

    Specifies the node to be reset.

    ScrollInView(RowColumnIndex)

    Scrolls the SfTreeGrid vertically and horizontally to display the cell for the specified RowColumnIndex.

    Declaration
    public void ScrollInView(RowColumnIndex rowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex rowColumnIndex

    Specifies the rowColumnIndex of the cell to scroll into view.

    SelectAll()

    Selects all the rows in SfTreeGrid.

    Declaration
    public void SelectAll()
    Remarks

    This method only works for Multiple and Extended mode selection.

    SelectRows(Int32, Int32)

    Selects the row based on its specified the start and end index.

    Declaration
    public void SelectRows(int startRowIndex, int endRowIndex)
    Parameters
    Type Name Description
    System.Int32 startRowIndex

    Specifies the start index of the row to select.

    System.Int32 endRowIndex

    Specifies the end index of the row to select.

    Remarks

    This is applicable for Multiple and Extended selection mode.

    UnWireEvents()

    Unwires the events associated with the SfDataGrid.

    Declaration
    protected virtual void UnWireEvents()

    WireEvents()

    Wires the events associated with the SfDataGrid.

    Declaration
    protected virtual void WireEvents()

    Events

    AutoGeneratingColumn

    Occurs when column is generated for the properties in underlying data object.

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

    You can cancel or customize the column being created using the TreeGridAutoGeneratingColumnEventArgs event argument.

    CellDoubleTapped

    Occurs when the user double clicks or touch the cell in SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridCellDoubleTappedEventArgs> CellDoubleTapped
    Event Type
    Type Description
    System.EventHandler<TreeGridCellDoubleTappedEventArgs>
    Remarks

    CellDoubleTapped does not occurs when the end user double clicks or touch the non-selectable cells.

    CellTapped

    Occurs when the user clicks or touch the cell in SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridCellTappedEventArgs> CellTapped
    Event Type
    Type Description
    System.EventHandler<TreeGridCellTappedEventArgs>
    Remarks

    CellTapped does not occurs when the end user clicks or touch the non-selectable cells.

    CellToolTipOpening

    Occurs when the user hovers the cell in SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridCellToolTipOpeningEventArgs> CellToolTipOpening
    Event Type
    Type Description
    System.EventHandler<TreeGridCellToolTipOpeningEventArgs>
    Remarks

    CellToolTipOpening does not occurs when the tooltip not enabled for the cells.

    ColumnDragging

    Occurs when the column is being reordered in to a new position.

    Declaration
    public event EventHandler<TreeGridColumnDraggingEventArgs> ColumnDragging
    Event Type
    Type Description
    System.EventHandler<TreeGridColumnDraggingEventArgs>
    Remarks

    You can cancel the column being dragged through TreeGridColumnDraggingEventArgs event argument.

    CopyCellContent

    Occurs when each cell in the selected cells or rows being copied from SfTreeGrid into clipboard.

    Declaration
    public event EventHandler<TreeGridCopyPasteCellEventArgs> CopyCellContent
    Event Type
    Type Description
    System.EventHandler<TreeGridCopyPasteCellEventArgs>
    Remarks

    You can cancel or customize each cell is being copied from the selected cells or rows through TreeGridCopyPasteCellEventArgs event argument.

    CopyContent

    Occurs when the selected cells or rows in SfTreeGrid is being copied to clipboard.

    Declaration
    public event EventHandler<GridCopyPasteEventArgs> CopyContent
    Event Type
    Type Description
    System.EventHandler<GridCopyPasteEventArgs>
    Remarks

    You can cancel or customize the content being copied from a SfTreeGrid through GridCopyPasteEventArgs event argument.

    CurrentCellActivated

    Occurs after the current cell is activated in SfTreeGrid.

    Declaration
    public event EventHandler<CurrentCellActivatedEventArgs> CurrentCellActivated
    Event Type
    Type Description
    System.EventHandler<CurrentCellActivatedEventArgs>
    Remarks

    This event occurs after the CurrentCellActivatingEventArgs event if that event is not canceled.

    CurrentCellActivating

    Occurs when the current cell is being activated in SfTreeGrid.

    Declaration
    public event EventHandler<CurrentCellActivatingEventArgs> CurrentCellActivating
    Event Type
    Type Description
    System.EventHandler<CurrentCellActivatingEventArgs>
    Remarks

    You can cancel the current cell is being activated through the CurrentCellActivatingEventArgs event argument.

    CurrentCellBeginEdit

    Occurs when the edit mode starts for the current cell in SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridCurrentCellBeginEditEventArgs> CurrentCellBeginEdit
    Event Type
    Type Description
    System.EventHandler<TreeGridCurrentCellBeginEditEventArgs>
    Remarks

    You can cancel the current cell is being edited through the CurrentCellBeginEditEventArgs event argument.

    CurrentCellDropDownSelectionChanged

    Occurs when the SelectedItem changed in the drop down of GridMultiColumnDropDownList or GridComboBoxColumn.

    Declaration
    public event EventHandler<CurrentCellDropDownSelectionChangedEventArgs> CurrentCellDropDownSelectionChanged
    Event Type
    Type Description
    System.EventHandler<CurrentCellDropDownSelectionChangedEventArgs>

    CurrentCellEndEdit

    Occurs when the edit mode ends for the current cell.

    Declaration
    public event EventHandler<CurrentCellEndEditEventArgs> CurrentCellEndEdit
    Event Type
    Type Description
    System.EventHandler<CurrentCellEndEditEventArgs>

    CurrentCellRequestNavigate

    Occurs when the GridHyperLinkColumn's cell is request for navigation.

    Declaration
    public event EventHandler<CurrentCellRequestNavigateEventArgs> CurrentCellRequestNavigate
    Event Type
    Type Description
    System.EventHandler<CurrentCellRequestNavigateEventArgs>

    CurrentCellValidated

    Occurs after the current cell validated.

    Declaration
    public event EventHandler<TreeGridCurrentCellValidatedEventArgs> CurrentCellValidated
    Event Type
    Type Description
    System.EventHandler<TreeGridCurrentCellValidatedEventArgs>
    Remarks

    This event occurs after the TreeGridCurrentCellValidatedEventArgs event if that event is not canceled.

    CurrentCellValidating

    Occurs while moving to other cells from edited cell for validating the user input.

    Declaration
    public event EventHandler<TreeGridCurrentCellValidatingEventArgs> CurrentCellValidating
    Event Type
    Type Description
    System.EventHandler<TreeGridCurrentCellValidatingEventArgs>
    Remarks

    You can cancel or customize the current cell being validated through the TreeGridCurrentCellValidatingEventArgs event argument.

    CurrentCellValueChanged

    Occurs when the current cell value Changes.

    Declaration
    public event EventHandler<TreeGridCurrentCellValueChangedEventArgs> CurrentCellValueChanged
    Event Type
    Type Description
    System.EventHandler<TreeGridCurrentCellValueChangedEventArgs>

    FilterChanged

    Occurs after the column is filtered in the SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridFilterChangedEventArgs> FilterChanged
    Event Type
    Type Description
    System.EventHandler<TreeGridFilterChangedEventArgs>

    FilterChanging

    Occurs when the column is being filtered in the SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridFilterChangingEventArgs> FilterChanging
    Event Type
    Type Description
    System.EventHandler<TreeGridFilterChangingEventArgs>

    FilterItemsPopulated

    Occurs after the items have been populated to the filter control in the SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridFilterItemsPopulatedEventArgs> FilterItemsPopulated
    Event Type
    Type Description
    System.EventHandler<TreeGridFilterItemsPopulatedEventArgs>

    FilterItemsPopulating

    Occurs when the items are being populated to the filter control in the SfTreeGrid.

    Declaration
    public event EventHandler<TreeGridFilterItemsPopulatingEventArgs> FilterItemsPopulating
    Event Type
    Type Description
    System.EventHandler<TreeGridFilterItemsPopulatingEventArgs>

    ItemsSourceChanged

    Occurs when the ItemsSource changed.

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

    The View can be accessed here.

    NodeCheckStateChanged

    Occurs after expander node check box is checked.

    Declaration
    public event EventHandler<NodeCheckStateChangedEventArgs> NodeCheckStateChanged
    Event Type
    Type Description
    System.EventHandler<NodeCheckStateChangedEventArgs>

    NodeCollapsed

    Occurs after the Node is collapsed.

    Declaration
    public event EventHandler<NodeCollapsedEventArgs> NodeCollapsed
    Event Type
    Type Description
    System.EventHandler<NodeCollapsedEventArgs>

    NodeCollapsing

    Occurs when the Node is being collapsed.

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

    You can cancel the Node being collapsed through NodeCollapsingEventArgs event argument.

    NodeExpanded

    Occurs after the Node is expanded.

    Declaration
    public event EventHandler<NodeExpandedEventArgs> NodeExpanded
    Event Type
    Type Description
    System.EventHandler<NodeExpandedEventArgs>

    NodeExpanding

    Occurs when the Node is being expanded.

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

    You can cancel the Node being expanded through NodeExpandedEventArgs event argument.

    PasteCellContent

    Occurs when each cell is being pasted from clipboard to SfTreeGrid control.

    Declaration
    public event EventHandler<TreeGridCopyPasteCellEventArgs> PasteCellContent
    Event Type
    Type Description
    System.EventHandler<TreeGridCopyPasteCellEventArgs>
    Remarks

    You can cancel or customize each cell is being pasted from the clipboard through TreeGridCopyPasteCellEventArgs event argument.

    PasteContent

    Occurs when the clipboard value is being pasted to SfTreeGrid.

    Declaration
    public event EventHandler<GridCopyPasteEventArgs> PasteContent
    Event Type
    Type Description
    System.EventHandler<GridCopyPasteEventArgs>
    Remarks

    You can cancel or customize the content is being pasted from clipboard to SfTreeGrid through GridCopyPasteEventArgs event argument.

    QueryCoveredRange

    Occurs to query the range to merge for particular cell.

    Declaration
    public event EventHandler<TreeGridQueryCoveredRangeEventArgs> QueryCoveredRange
    Event Type
    Type Description
    System.EventHandler<TreeGridQueryCoveredRangeEventArgs>

    RequestTreeItems

    This event is used to request an IEnumerable object that holds the child item objects for a particular parent item in on demand loading.

    Declaration
    public event EventHandler<TreeGridRequestTreeItemsEventArgs> RequestTreeItems
    Event Type
    Type Description
    System.EventHandler<TreeGridRequestTreeItemsEventArgs>
    Remarks

    In the TreeGridRequestTreeItemsEventArgs parent object will be passed,
    and your event handler needs to provide an IEnumerable object that contains the child objects for this parent object. If the parent object is null, you should provide the collection of root objects for the tree.

    ResizingColumns

    Occurs when the column width changes during resizing.

    Declaration
    public event EventHandler<ResizingColumnsEventArgs> ResizingColumns
    Event Type
    Type Description
    System.EventHandler<ResizingColumnsEventArgs>
    Remarks

    You can cancel or customize the column being resized through ResizingColumnsEventArgs event argument.

    RowValidated

    Occurs after the row is validated.

    Declaration
    public event EventHandler<TreeGridRowValidatedEventArgs> RowValidated
    Event Type
    Type Description
    System.EventHandler<TreeGridRowValidatedEventArgs>
    Remarks

    This event occurs after the RowValidating event if that event is not canceled.

    RowValidating

    Occurs while the moving from the edited row to validate the user input.

    Declaration
    public event EventHandler<TreeGridRowValidatingEventArgs> RowValidating
    Event Type
    Type Description
    System.EventHandler<TreeGridRowValidatingEventArgs>
    Remarks

    You can cancel the row is being validated through the TreeGridRowValidatingEventArgs event argument.

    SelectionChanged

    Occurs when the current selection changes.

    Declaration
    public event EventHandler<GridSelectionChangedEventArgs> SelectionChanged
    Event Type
    Type Description
    System.EventHandler<GridSelectionChangedEventArgs>
    Remarks

    This event occurs after the SelectionChanging event if that event is not canceled. It will be raised both UI and programmatic selection.

    SelectionChanging

    Occurs when the selection is being changed in SfTreeGrid.

    Declaration
    public event EventHandler<GridSelectionChangingEventArgs> SelectionChanging
    Event Type
    Type Description
    System.EventHandler<GridSelectionChangingEventArgs>
    Remarks

    You can cancel or customize the selection being changed through the GridSelectionChangingEventArgs event argument.
    It will be raised both UI and programmatic selection.

    SortColumnsChanged

    Occurs after the column is sorted in SfTreeGrid.

    Declaration
    public event EventHandler<GridSortColumnsChangedEventArgs> SortColumnsChanged
    Event Type
    Type Description
    System.EventHandler<GridSortColumnsChangedEventArgs>
    Remarks

    This event occurs after the SortColumnsChanging event if that event is not canceled.

    SortColumnsChanging

    Occurs when the column is being sorted in SfTreeGrid.

    Declaration
    public event EventHandler<GridSortColumnsChangingEventArgs> SortColumnsChanging
    Event Type
    Type Description
    System.EventHandler<GridSortColumnsChangingEventArgs>
    Remarks

    You can cancel or customize the column being sorted using the GridSortColumnsChangingEventArgs event argument. It will be raised for UI based sorting only.

    TreeGridContextMenuOpening

    Occurs before the shortcut menu/context menu opened.

    Declaration
    public event EventHandler<TreeGridContextMenuEventArgs> TreeGridContextMenuOpening
    Event Type
    Type Description
    System.EventHandler<TreeGridContextMenuEventArgs>
    Remarks

    To handle or change the shortcut menu being opened through the TreeGridContextMenuEventArgs event argument.

    Implements

    System.IDisposable

    Extension Methods

    TreeGridIndexResolver.GetNodeAtRowIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToRowIndex(SfTreeGrid, TreeNode)
    TreeGridIndexResolver.ResolveToRowIndex(SfTreeGrid, Object)
    TreeGridIndexResolver.ResolveToRowIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToNodeIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.GetHeaderIndex(SfTreeGrid)
    TreeGridIndexResolver.ResolveToGridVisibleColumnIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToScrollColumnIndex(SfTreeGrid, Int32)
    TreeGridIndexResolver.ResolveToStartColumnIndex(SfTreeGrid)
    StackedHeadersHelper.IntersectedChildColumn(SfGridBase, List<Int32>, StackedHeaderRow, StackedColumn)
    StackedHeadersHelper.CheckChildSequence(SfGridBase, List<Int32>, StackedHeaderRow, StackedColumn)
    StackedHeadersHelper.GetHeightIncrementationLimit(SfTreeGrid, CoveredCellInfo, Int32)
    StackedHeadersHelper.GetChildSequence(SfTreeGrid, StackedColumn, Int32)
    TreeGridHelper.GetTreePanel(SfTreeGrid)
    TreeGridHelper.GetValidationHelper(SfTreeGrid)
    TreeGridHelper.UpdateDataRow(SfTreeGrid, Int32)
    TreeGridHelper.GetGridModel(SfTreeGrid)
    TreeGridHelper.GetTreeGridRowGenerator(SfTreeGrid)
    TreeGridHelper.RefreshColumns(SfTreeGrid)
    TreeGridHelper.AddNode(SfTreeGrid, TreeNode, Object)
    TreeGridHelper.InsertNode(SfTreeGrid, TreeNode, Object, Int32)
    TreeGridHelper.RemoveNode(SfTreeGrid, TreeNode, Object)
    TreeGridHelper.ResetNodes(SfTreeGrid, TreeNode)
    TreeGridHelper.MoveNode(SfTreeGrid, TreeNode, Int32, Int32)
    TreeGridHelper.ReplaceNode(SfTreeGrid, TreeNode, Object, Int32)
    TreeGridSelectionHelper.GetTreeDataColumnBase(SfTreeGrid, RowColumnIndex)
    TreeGridSelectionHelper.GetFirstDataRowIndex(SfTreeGrid)
    TreeGridSelectionHelper.GetLastDataRowIndex(SfTreeGrid)
    TreeGridSelectionHelper.UpdateRowHeaderState(SfTreeGrid)
    TreeGridSelectionHelper.GetNextPageIndex(SfTreeGrid)
    TreeGridSelectionHelper.GetPreviousPageIndex(SfTreeGrid)
    TreeGridSelectionHelper.GetNextRowInfo(SfTreeGrid, Int32)
    TreeGridSelectionHelper.GetPreviousRowInfo(SfTreeGrid, Int32)
    TreeGridSelectionHelper.GetFirstColumnIndex(SfTreeGrid, FlowDirection)
    TreeGridSelectionHelper.GetLastColumnIndex(SfTreeGrid, FlowDirection)
    TreeGridSelectionHelper.AllowFocus(SfTreeGrid, RowColumnIndex)
    TreeGridExcelExportExtension.ExportToExcel(SfTreeGrid, TreeGridExcelExportingOptions)
    TreeGridExcelExportExtension.ExportToExcel(SfTreeGrid, TreeGridExcelExportingOptions, IWorksheet)
    TreeGridExcelExportExtension.ExportToExcel(SfTreeGrid, IWorkbook, TreeGridExcelExportingOptions)
    TreeGridPdfExportExtension.ExportToPdf(SfTreeGrid, TreeGridPdfExportingOptions)
    TreeGridPdfExportExtension.ExportToPdfGrid(SfTreeGrid, TreeGridPdfExportingOptions)
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved