TreeListVirtualModeNodeCreatingEventArgs Class

Provides data for the ASPxTreeList.VirtualModeNodeCreating event.

Namespace: DevExpress.Web.ASPxTreeList

Assembly: DevExpress.Web.ASPxTreeList.v19.1.dll

Declaration

C#

public class TreeListVirtualModeNodeCreatingEventArgs :
    EventArgs

VB.NET

Public Class TreeListVirtualModeNodeCreatingEventArgs
    Inherits EventArgs

Related API Members

TreeListVirtualModeNodeCreatingEventArgs is the data class for the following events:

• ASPxTreeList.VirtualModeNodeCreating

Example

In this example, the ASPxTreeList uses the Virtual data binding method to display the file/folder tree. In this mode, a tree is created on demand.

The image below shows the result.

C#

using System.IO;
using System.Collections.Generic;
using DevExpress.Web.ASPxTreeList;

protected void ASPxTreeList1_VirtualModeCreateChildren(object sender,
TreeListVirtualModeCreateChildrenEventArgs e) {
    string path = e.NodeObject == null ? Page.MapPath("~/") : e.NodeObject.ToString();

    List<string> children = new List<string>();
    if (Directory.Exists(path)) {
        foreach (string name in Directory.GetDirectories(path)) {
            if (!IsSystemName(name))
                children.Add(name);
        }
        foreach (string name in Directory.GetFiles(path))
            if (!IsSystemName(name))
                children.Add(name);
    }
    e.Children = children;
}
protected void ASPxTreeList1_VirtualModeNodeCreating(object sender,
TreeListVirtualModeNodeCreatingEventArgs e) {
    string path = e.NodeObject.ToString();

    e.NodeKeyValue = GetNodeGuid(path);
    e.IsLeaf = !Directory.Exists(path);
    e.SetNodeValue("FileName", PopFileName(path));
}

// Helpers

Guid GetNodeGuid(string path) {
    if (!Map.ContainsKey(path))
        Map[path] = Guid.NewGuid();
    return Map[path];
}
Dictionary<string, Guid> Map {
    get {
        const string key = "DX_PATH_GUID_MAP";
        if (Session[key] == null)
            Session[key] = new Dictionary<string, Guid>();
        return Session[key] as Dictionary<string, Guid>;
    }
}
string PopFileName(string path) {
    return path.Substring(1 + path.LastIndexOf("\\"));
}
bool IsSystemName(string name) {
    name = PopFileName(name).ToLower();
    return name.StartsWith("app_") || name == "bin"
        || name.EndsWith(".aspx.cs") || name.EndsWith(".aspx.vb");
}

VB.NET

Imports System.IO
Imports System.Collections.Generic
Imports DevExpress.Web.ASPxTreeList

Protected Sub ASPxTreeList1_VirtualModeCreateChildren(ByVal sender As Object,_
ByVal e As TreeListVirtualModeCreateChildrenEventArgs)
   Dim path As String
   If e.NodeObject Is Nothing Then
   path = Page.MapPath("~/")
   Else
      path = e.NodeObject.ToString()
   End If

   Dim children As List(Of String) = New List(Of String)()
   If Directory.Exists(path) Then
      For Each name As String In Directory.GetDirectories(path)
         If (Not IsSystemName(name)) Then
            children.Add(name)
         End If
      Next name
      For Each name As String In Directory.GetFiles(path)
         If (Not IsSystemName(name)) Then
            children.Add(name)
         End If
      Next name
   End If
   e.Children = children
End Sub

Protected Sub ASPxTreeList1_VirtualModeNodeCreating(ByVal sender As Object,_
ByVal e As TreeListVirtualModeNodeCreatingEventArgs)
   Dim path As String = e.NodeObject.ToString()

   e.NodeKeyValue = GetNodeGuid(path)
   e.IsLeaf = Not Directory.Exists(path)
   e.SetNodeValue("FileName", PopFileName(path))
End Sub

' Helpers

Private Function GetNodeGuid(ByVal path As String) As Guid
   If (Not Map.ContainsKey(path)) Then
      Map(path) = Guid.NewGuid()
   End If
   Return Map(path)
End Function

Private ReadOnly Property Map() As Dictionary(Of String, Guid)
   Get
      Const key As String = "DX_PATH_GUID_MAP"
      If Session(key) Is Nothing Then
         Session(key) = New Dictionary(Of String, Guid)()
      End If
      Return TryCast(Session(key), Dictionary(Of String, Guid))
   End Get
End Property

Private Function PopFileName(ByVal path As String) As String
   Return path.Substring(1 & path.LastIndexOf("\"))
End Function

Private Function IsSystemName(ByVal name As String) As Boolean
   name = PopFileName(name).ToLower()
   Return name.StartsWith("app_") OrElse name = "bin" OrElse name.EndsWith(".aspx.cs")_
   OrElse name.EndsWith(".aspx.vb")
End Function

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TreeListVirtualModeNodeCreatingEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

treelist-how-to-load-data-from-a-database-in-virtual-mode-and-implement-drag-and-drop-e4837/CS/Q515371/Models/TreeListVirtualModeHelper.cs#L26

}
public static void VirtualModeNodeCreating(TreeListVirtualModeNodeCreatingEventArgs e) {
    Employee empl = e.NodeObject as Employee;

VB.NET

treelist-how-to-load-data-from-a-database-in-virtual-mode-and-implement-drag-and-drop-e4837/VB/Q515371/Models/TreeListVirtualModeHelper.vb#L26

End Sub
Public Shared Sub VirtualModeNodeCreating(ByVal e As TreeListVirtualModeNodeCreatingEventArgs)
    Dim empl As Employee = TryCast(e.NodeObject, Employee)

Inheritance

Object

EventArgs

TreeListVirtualModeNodeCreatingEventArgs