TcxTreeListCustomReportLink.OptionsPagination Property

Options determining how to split the TreeList control across report pages if its size exceeds that of a single printed page.

Declaration

property OptionsPagination: TcxTreeListReportLinkOptionsPagination read; write;

Property Value

Type
TcxTreeListReportLinkOptionsPagination

Remarks

The OptionsPagination property is used to determine how to split a TreeList control across report pages if its size exceeds that of a 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.

• TcxTreeListReportLinkOptionsPagination.Band for bands;

• TcxTreeListReportLinkOptionsPagination.Column for columns;

• TcxTreeListReportLinkOptionsPagination.Node for nodes;

• TcxTreeListReportLinkOptionsPagination.Custom for custom page breaks.

The bands and columns affect horizontal TreeList splitting while the nodes and custom page breaks are vertical.

If the TcxTreeListReportLinkOptionsPagination.Band property is True, the TreeList control has more than one band and its width exceeds a single printed page the TreeList is split across the report pages to accommodate the maximum possible bands on a single page. This is also valid for the TdxGridReportLinkOptionsPagination.Column property, if True the TreeList control will be split to accommodate the maximum number of columns possible on a single page.

These two properties have no effect if either TBasedxReportLink.ShrinkToPageWidth property or TcxTreeListReportLinkOptionsSize.AutoWidth property is set to True.

Vertical TreeList splitting is controlled by the TcxTreeListReportLinkOptionsPagination.Node and TcxTreeListReportLinkOptionsPagination.Custom properties. If the TcxTreeListReportLinkOptionsPagination.Node property is True the TreeList control nodes are split across the report pages to accommodate the maximum number of columns possible on a single page.

Set the TcxTreeListReportLinkOptionsPagination.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.