ASPxTreeList.HtmlDataCellPrepared Event

Enables the settings of individual cells to be changed.

Namespace: DevExpress.Web.ASPxTreeList

Assembly: DevExpress.Web.ASPxTreeList.v18.2.dll

Declaration

C#

public event TreeListHtmlDataCellEventHandler HtmlDataCellPrepared

VB.NET

Public Event HtmlDataCellPrepared As TreeListHtmlDataCellEventHandler

Event Data

The HtmlDataCellPrepared event's data class is TreeListHtmlDataCellEventArgs. The following properties provide information specific to this event:

Property	Description
Cell	Gets the processed data cell.
CellValue	Gets the processed cell’s value.
Column	Gets the data column that owns the cell currently being processed.
Level	Gets the nesting level of a node which contains the processed data cell.
NodeKey	Gets the key value of a node which contains the processed cell.

The event data class exposes the following methods:

Method	Description
GetValue(String)	Returns the value of the specified cell within the processed node.

Remarks

The HtmlDataCellPrepared event is raised for each data cell within the ASPxTreeList when the corresponding table cell has been created. You can handle this event to change the style settings of individual cells.

The processed cell is identified by the event parameter’s TreeListHtmlDataCellEventArgs.Cell property. Its value is returned by the TreeListHtmlDataCellEventArgs.CellValue property. The column and node where the processed cell resides can be obtained via the TreeListHtmlDataCellEventArgs.Column and TreeListHtmlRowEventArgs.Row properties.

Example

This example shows how to paint individual data cells and entire nodes depending upon the ASPxTreList’s data. The ASPxTreeList.HtmlDataCellPrepared event is handled to custom paint budgets that are greater than $1,000,000.

The ASPxTreeList.HtmlRowPrepared event is handled to custom paint departments located at Monterey.

The image below shows the result:

C#

using System.Drawing;

protected void treeList_HtmlRowPrepared(object sender, TreeListHtmlRowEventArgs e) {
    if(Object.Equals(e.GetValue("Location"), "Monterey"))
        e.Row.BackColor = Color.FromArgb(211, 235, 183);
}

protected void treeList_HtmlDataCellPrepared(object sender, TreeListHtmlDataCellEventArgs e) {
    if(e.Column.Name == "budget") {
        decimal value = (decimal)e.CellValue;
        e.Cell.BackColor = GetBudgetColor(value);
        if(value > 1000000M)
            e.Cell.Font.Bold = true;
    }
}

VB.NET

Imports System.Drawing

Protected Sub treeList_HtmlRowPrepared(ByVal sender As Object, ByVal e As TreeListHtmlRowEventArgs)
   If Object.Equals(e.GetValue("Location"), "Monterey") Then
      e.Row.BackColor = Color.FromArgb(211, 235, 183)
   End If
End Sub

Protected Sub treeList_HtmlDataCellPrepared(ByVal sender As Object,_
ByVal e As TreeListHtmlDataCellEventArgs)
   If e.Column.Name = "budget" Then
      Dim value As Decimal = CDec(e.CellValue)
      e.Cell.BackColor = GetBudgetColor(value)
      If value > 1000000D Then
         e.Cell.Font.Bold = True
      End If
   End If
End Sub

Related GitHub Examples

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

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#

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/CS/E520.Module.Web/Controllers/WebFilterTreeListViewController.cs#L24

    treeList = treeListEditor.TreeList;
    treeList.HtmlDataCellPrepared += treeList_HtmlDataCellPrepared;
}

VB.NET

XAF_how-to-search-and-focus-nodes-in-the-tree-list-editor-e520/VB/E520.Module.Web/Controllers/WebFilterTreeListViewController.vb#L26

    treeList = treeListEditor.TreeList
    AddHandler treeList.HtmlDataCellPrepared, AddressOf treeList_HtmlDataCellPrepared
End If