TcxTreeListReportLinkOptionsPagination Class
Options determining how to split a TreeList control across report pages if its size exceeds the size of the single printed page.
Declaration
TcxTreeListReportLinkOptionsPagination = class(
TdxCustomTableControlReportLinkOptionsPagination
)Remarks
The TcxTreeListReportLinkOptionsPagination class contains options used to determine how to split a TreeList control across report pages if its size exceeds the size of the single printed page. There are four criteria that affect report pagination:
bands,
columns,
nodes,
custom page breaks.
To enable a single criterion just set the corresponding property to True.
The bands and columns affect the horizontal splitting of the TreeList while the nodes and custom page breaks are vertical.
If the Band property is True, the TreeList control has more than one band and the TreeList‘s width exceeds the single printed page the TreeList is split across the report pages to accommodate the maximum number of bands possible on a single page. This is also valid for the Column property, if this is True the TreeList control will be split to accommodate the maximum possible number of columns in their entirety on a single page.
These two properties have no effect if either the TBasedxReportLink.ShrinkToPageWidth property or the TcxTreeListReportLinkOptionsSize.AutoWidth property is set to True.
Vertical TreeList splitting is controlled by the Node and Custom properties. If the Node property is True the TreeList control nodes are split across the report pages to accommodate the maximum number of columns in their entirety possible on a single page.
Set the Custom property to True to enable custom page breaks. Custom page breaks allows you to add a page break before any TreeList node. To add custom page breaks to the report you should use the OnGetCustomPageBreaks event.
After changing options you can always restore their default values using the RestoreDefaults method.