Class TreeViewFieldOptions<TValue>

A class used for configuring the TreeView fields setting properties.

Inheritance

System.Object

TreeViewFieldOptions<TValue>

TreeViewFieldChild<TValue>

TreeViewFieldsSettings<TValue>

Namespace: Syncfusion.Blazor.Navigations

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeViewFieldOptions<TValue> : OwningComponentBase

Type Parameters

Name	Description
TValue	"Specifies the TValue parameter".

Constructors

TreeViewFieldOptions()

Declaration

public TreeViewFieldOptions()

Properties

Child

Gets or sets the string value that represents the name of the child data source holding a list of objects.

Declaration

public string Child { get; set; }

Property Value

Type
System.String

Examples

 
<SfTreeView TValue="MailItem" >
    <TreeViewFieldsSettings TValue="MailItem" Child="SubFolders" DataSource="@MyFolder" Text="FolderName"></TreeViewFieldsSettings>
</SfTreeView>
@code{ 
    public class MailItem
    {
       public string FolderName { get; set; }
       public List<MailItem> SubFolders { get; set; }
    }
    List<MailItem> MyFolder = new List<MailItem>();
    List<MailItem> Folder1 = new List<MailItem>();
    MyFolder.Add(new MailItem
    {
        SubFolders = Folder1
    });

DataManager

The DataManager class provides functionality for performing data operations in applications. It serves as an abstraction layer for working with remote data sources.

Declaration

public DataManager DataManager { get; set; }

Property Value

Type
DataManager

DataSource

Gets or sets the data source for rendering the TreeView component. The data source value can be of any type that implements IEnumerable.

Declaration

public IEnumerable<TValue> DataSource { get; set; }

Property Value

Type
System.Collections.Generic.IEnumerable<TValue>

Expanded

Gets or sets the mapping field for the expand state of the TreeView node.

Declaration

public string Expanded { get; set; }

Property Value

Type
System.String

HasChildren

Gets or sets the mapping field for determining whether a node has child nodes or not.

Declaration

public string HasChildren { get; set; }

Property Value

Type
System.String

HtmlAttributes

Gets or sets the mapping field for adding custom HTML attributes to the TreeView node.

Declaration

public string HtmlAttributes { get; set; }

Property Value

Type
System.String

Examples

 
<SfTreeView TValue="MailItem" >
    <TreeViewFieldsSettings TValue="MailItem" Id="Id" HtmlAttributes="HtmlAttributes"></TreeViewFieldsSettings>
</SfTreeView>
@code{ 
    Dictionary<string, object> HtmlAttributes = new Dictionary<string, object>() 
   { 
       { "class", "treeview" } 
   }; 

IconCss

Gets or sets the mapping field for the icon class of each TreeView node, which will be added before the node's text.

Declaration

public string IconCss { get; set; }

Property Value

Type
System.String

Id

Gets or sets the Id field mapped in the dataSource.

Declaration

public string Id { get; set; }

Property Value

Type
System.String

ImageUrl

Gets or sets the mapping field for the image URL of each TreeView node, where the image will be added before the node's text.

Declaration

public string ImageUrl { get; set; }

Property Value

Type
System.String

IsChecked

Gets or sets the field for the checked state of the TreeView node.

Declaration

public string IsChecked { get; set; }

Property Value

Type
System.String

NavigateUrl

Gets or sets the mapping field for navigateUrl to add it as the hyperlink of the TreeView node.

Declaration

public string NavigateUrl { get; set; }

Property Value

Type
System.String

ParentID

Gets or sets the parent ID field mapped in the dataSource.

Declaration

public string ParentID { get; set; }

Property Value

Type
System.String

Query

Gets or sets the query to select particular data from the dataSource.

Declaration

public Query Query { get; set; }

Property Value

Type
Query

Examples

 
<SfTreeView TValue="TreeData">
    <TreeViewFieldsSettings TValue="TreeData" Query="@Query" Id="EmployeeID" Text="FirstName" >
        <SfDataManager Url="http://services.odata.org/V4/Northwind/Northwind.svc" Adaptor="@Syncfusion.Blazor.Adaptors.ODataV4Adaptor" CrossDomain="true">
        </SfDataManager>
    </TreeViewFieldsSettings>
</SfTreeView>
@code{ 
     public Query Query = new Query().From("Employees").Select(new List<string> { "EmployeeID", "FirstName" }).Take(5).RequiresCount();
}

Selected

Gets or sets the mapping field for the selected state of the TreeView node.

Declaration

public string Selected { get; set; }

Property Value

Type
System.String

TableName

Gets or sets the table name used to fetch data from a specific table in the server.

Declaration

public string TableName { get; set; }

Property Value

Type
System.String

Text

Gets or sets the mapping field for the text displayed as the TreeView node's display text.

Declaration

public string Text { get; set; }

Property Value

Type
System.String

Tooltip

Gets or sets the mapping field for the tooltip that will be displayed as hovering text of the TreeView node.

Declaration

public string Tooltip { get; set; }

Property Value

Type
System.String

Methods

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task