TreeListDocumentExportSummaryItem.SummaryType Property
Returns the summary item’s aggregation function.
Namespace: DevExpress.Blazor
Assembly: DevExpress.Blazor.v25.1.dll
NuGet Package: DevExpress.Blazor
Declaration
public TreeListSummaryItemType SummaryType { get; }
Property Value
Type | Description |
---|---|
TreeListSummaryItemType | Returns an aggregation function. |
Available values:
Name | Description |
---|---|
Sum | Calculates the sum of all values in a column. |
Min | Calculates the minimum value of all values in a column. |
Max | Calculates the maximum value of all values in a column. |
Count | Calculates the number of values in a column. |
Avg | Calculates the average of all values in a column. |
Custom | Uses a custom algorithm to calculate a summary value. |
None | Does not calculate a summary value. |
Remarks
When exporting TreeList data to PDF, handle the CustomizeCell event to customize table cells in the output file. Use the SummaryItems property to obtain information about summaries displayed in the processed cell.
The following example customizes the text and formatting of summaries in the exported document:
@rendermode InteractiveServer
@using DevExpress.Drawing
@inject SpaceObjectDataProvider SpaceObjectDataProvider
<DxTreeList @ref="TreeList" Data="TreeListData" ChildrenFieldName="Satellites">
<Columns>
<DxTreeListDataColumn FieldName="Name" />
<DxTreeListDataColumn FieldName="TypeOfObject" Caption="Type" />
<DxTreeListDataColumn FieldName="Mass10pow21kg" Caption="Mass, kg" DisplayFormat="N2" />
<DxTreeListDataColumn FieldName="MeanRadiusInKM" Caption="Radius, km" DisplayFormat="N2" />
</Columns>
<TotalSummary>
<DxTreeListSummaryItem SummaryType="TreeListSummaryItemType.Count" FieldName="Name" />
<DxTreeListSummaryItem SummaryType="TreeListSummaryItemType.Min" FieldName="MeanRadiusInKM" />
<DxTreeListSummaryItem SummaryType="TreeListSummaryItemType.Max" FieldName="MeanRadiusInKM" />
</TotalSummary>
<ToolbarTemplate>
<DxToolbar>
<DxToolbarItem Text="Export to PDF" Click="ExportPdf_Click" BeginGroup="true" />
</DxToolbar>
</ToolbarTemplate>
</DxTreeList>
@code {
ITreeList TreeList { get; set; }
object TreeListData { get; set; }
protected override async Task OnInitializedAsync() {
TreeListData = SpaceObjectDataProvider.GenerateData();
}
async Task ExportPdf_Click() {
await TreeList.ExportToPdfAsync("ExportResult", new TreeListPdfExportOptions() {
CustomizeCell = OnCustomizeCell,
});
}
void OnCustomizeCell(TreeListDocumentExportCustomizeCellEventArgs args) {
if (args.AreaType == DocumentExportAreaType.TotalFooter) {
if (args.ColumnFieldName == "Name") {
var sum = args.SummaryItems[0];
args.Text = "Total " + sum.SummaryType + " of " + sum.FieldName + "s: " + sum.Value;
}
if (args.ColumnFieldName == "MeanRadiusInKM") {
args.Text = args.SummaryItems[0].Text + " Km\n" + args.SummaryItems[1].Text + " Km";
args.ElementStyle.TextAlignment = DevExpress.XtraPrinting.TextAlignment.MiddleRight;
}
}
args.Handled = true;
}
}