Summary. Get started

Summary allows you to display the result of aggregation operation over bound data in the treeview.

To define summaries use the Summaries treeview property. You can customize summaries either in run-time or design-time using summaries designer.

Every summary item has these core properties to define summary behavior:

• Operation – defines which operation`s result to display in the summary;
• NodeControl – defines from which node control to get data to aggregate;
• Column – defines in which column to show the summary (optional, for the treeview with columns only).

To display the summary, first you need to define which operation`s result this summary will show by filling the Operation summary property. Then you need to define where to get data to aggregate by filling the NodeControl summary property. If you have a treeview with columns, you need to define in which column to show your summary using the Column summary property.

Column

In the treeview with columns, you need to decide in which column to show every summary. To do that, use the Column summary property. In the treeview without columns it doesn`t matter whether you define a column or not, all summaries will be shown.

Summary types

Summaries can be one of these types:

• Node summaries (#1 on the picture below) – allows you to define node`s personal summaries, that are shown only for the specified node. All Node summaries are stored in the Summaries.Node treeview property.
• Nodes summaries (#2) – shows summaries inside all non-root nodes which don`t have personal summaries. It allows you to define summaries only once to show for all nodes. All Nodes summaries are stored in the Summaries.Nodes treeview property.
• Treeview summaries (#3) – allows you to show summaries for root nodes at the bottom of treeview. All Treeview summaries are stored in the Summaries.Treeview treeview property.

Node summaries

Node summaries allows you to define node`s personal summaries, that are shown only for the specified node. To define a Node summary, use the Summaries.Node treeview property and NodeSummaryItem type as shown below:

Example:

NodeTextBox tb = new NodeTextBox();
tb.AttachTo(tree);
 
Node root = new Node(“Test”);
root.AttachTo(tree);
Node child = new Node(“child node”);
child.AttachTo(root);
 
NodeSummaryItem sum = new NodeSummaryItem();
// set the node where to display the summary.
sum.Node = root;
sum.NodeControl = tb;
sum.Operation = eSummaryOperation.Count;
tree.Summaries.Node.Add(sum);

Note that to display the Node summary, you need to set the node for which to show this summary!

Nodes summaries

Nodes summaries shows summaries inside all non-root nodes which don`t have personal summaries. It allows you to define summaries only once to show for all nodes.
To define a Nodes summary, use the Summaries.Nodes treeview property and NodesummaryItem type as shown below:

Example:

NodeTextBox tb = new NodeTextBox();
tb.AttachTo(tree);
 
Node root = new Node(“Test”);
root.AttachTo(tree);
Node child = new Node(“child node”);
child.AttachTo(root);
root = new Node(“Test 2”);
root.AttachTo(tree);
child = new Node(“child node 2”);
child.AttachTo(root);
 
NodesSummaryItem sum = new NodesSummaryItem();
sum.NodeControl = tb;
sum.Operation = eSummaryOperation.Count;
tree.Summaries.Nodes.Add(sum);

Treeview summaries

Treeview summaries allows you to show summaries for root nodes at the bottom of treeview. They`re intended to summarize data for all nodes in the treeview and they`re always visible at the bottom of the treview.
To define a Treeview summary, use the Summaries.Treeview treeview property and TreeviewSummaryItem type as shown below:

Example:

NodeTextBox tb = new NodeTextBox();
tb.AttachTo(tree);
 
Node root = new Node(“Test”);
root.AttachTo(tree);
Node child = new Node(“child node”);
child.AttachTo(root);
 
TreeviewSummaryItem sum = new TreeviewSummaryItem();
sum.NodeControl = tb;
sum.Operation = eSummaryOperation.Count;
tree.Summaries.Treeview.Add(sum);

You can control the visibility for each of these summary types using the Visible property (disabled by default).
For example, to show Treeview summaries use the code below:

tree.Summaries.Treeview.Visible = true;

Summary levels

Every summary type is a collection of summaries, where each summary can be positioned on any level.

Summary levels allow you to flexibly display many summaries in the treeview. To control summary levels use:

• LevelsCount summary type`s property for Nodes and Treeview summary types;
• SummaryLevelsCount node property for Node summary type.