DevExpress CustomJSProperties 获取行值仅得主键问题求助
MVCxGridView 借助CustomJSProperties实现行Tooltip的字段取值问题修复
原代码的核心问题
- 取值范围仅覆盖了分组列,没有把Tooltip需要展示的其他业务字段纳入提取范围,最终返回给前端的自然只有分组列的值
- 循环时未判断行类型,分组行、汇总行也会参与取值流程,容易触发主键重复、索引越界的运行时异常
- 循环结束索引没有做边界截断,当最后一页实际行数小于分页大小的时候,会超出实际可见行的索引范围
可落地的修改逻辑
- 拓展字段提取清单:在原有分组列的基础上,追加所有需要展示在Tooltip里的非分组业务字段,通过去重避免对同一列重复取值
- 循环时做行类型校验:仅对普通数据行提取字段值,跳过分组行、汇总行等非数据行
- 安全截断循环范围:把循环结束索引限制在GridView实际可见行的最大索引范围内,彻底避免越界问题
- 优化返回结构:把取到的数组形式的行值,转成“字段名-字段值”的键值对结构,方便前端直接按字段名读取内容
修正后的参考代码
后端CustomJSProperties事件代码:
gvSettings.CustomJSProperties = (s, e) => { MVCxGridView grid1 = s as MVCxGridView; // 安全截断循环边界 int startIndex = grid1.VisibleStartIndex; int endIndex = Math.Min(startIndex + grid1.SettingsPager.PageSize, grid1.VisibleRowCount); // 组装需要提取的全量字段:分组列 + 自定义Tooltip需要的业务字段 var tooltipFields = grid1.GetGroupedColumns() .OrderBy(g => g.GroupIndex) .Select(g => g.FieldName) // 替换为你实际需要展示在Tooltip里的非分组字段名 .Concat(new[] { "CustomerName", "ProductName", "OrderDate", "Amount" }) .Distinct() .ToArray(); var clientData = new Dictionary<object, object>(); for (int i = startIndex; i < endIndex; i++) { // 跳过非数据行,仅处理普通明细行 if (!grid1.IsDataRow(i)) continue; var rowKey = grid1.GetRowValues(i, grid1.KeyFieldName); var rowFieldValues = grid1.GetRowValues(i, tooltipFields) as object[]; // 转成键值对结构,方便前端读取 var rowTooltipContent = tooltipFields .Zip(rowFieldValues, (fieldName, fieldValue) => new { fieldName, fieldValue }) .ToDictionary(item => item.fieldName, item => item.fieldValue); clientData.Add(rowKey, rowTooltipContent); } e.Properties.Add("cpTooltipList", clientData); };
前端配合取值的参考逻辑:
// 绑定在GridView的客户端Init事件上 function OnGridInit(s, e) { const visibleRowIndices = s.GetRowVisibleIndices(); visibleRowIndices.forEach(rowIndex => { const rowKey = s.GetRowKey(rowIndex); const tooltipData = s.cpTooltipList[rowKey]; // 将拼好的Tooltip内容绑定到行DOM节点,也可以替换成自定义Tooltip组件的渲染逻辑 const rowDom = s.GetRow(rowIndex); rowDom.title = Object.entries(tooltipData) .map(([field, value]) => `${field}: ${value}`) .join('\n'); }); }
开发注意事项
- 不要一次性将全表数据源序列化到前端:CustomJSProperties会将属性值直接输出到当前页面的前端脚本中,只取当前页需要的字段即可,全表传输会大幅增加页面加载体积,降低响应速度
- 提前处理特殊类型的字段值:日期、金额、枚举类的字段值,建议在后端转成符合展示规范的字符串再传给前端,减少前端格式化的逻辑成本
- 翻页、排序、过滤场景会自动重新触发CustomJSProperties事件,不需要手动调用逻辑更新前端缓存的Tooltip数据
内容的提问来源于stack exchange,提问作者Beqa Chelidze
相关产品推荐
相关产品推荐

