Pagers

TreeGrid documentation

Side pager

The side pager is defined by <P> tag placed to <Pagers> tag, e.g. <Grid><Pagers><P Type='Pages'/><P ... /></Pagers></Grid>.
There can be more side pagers in grid, placed on right (default) or left side.
The side pagers are defined since 9.0, prior this version there was only one pager defined by <Pager> tag.

If used root paging (<Cfg Paging='1' or '2' or '3'/>), there is defined default pager by <Grid><Pager Name='Pager' Type='Pages'></Grid>
To not use the default pager for paging set <Pager Type=""/>.
Name of the pager. by this name is the pager accessible by API in Pagers. Also redefining <P> tag with the existing Name will update already existing pager.
Type of pager. It controls, what will be displayed in the pager, it can be:

Pages	Pager for root pages, defined by <Cfg Paging/>
Columns	Pager for columns, defined by <Cfg ColPaging/> (not yet implemented)
Gantt	Pager for Gantt zoom, defined by <C Type='Gantt' GanttPageSize/>
Custom	Custom pager, it is filled and controlled by custom API events.

For 0 it shows the pager on the right grid side.
For 1 it shows the pager on the left grid side.
If there are more pagers defined on the same side, they are shown in the order they are defined in <Pagers> tag.
If pager is visible. Pager can be visible only if Cfg.Paging > 0 and Cfg.NoPager = 0.
A user can select pager visibility from configuration menu (except if set CanHide='0'). If pager is displayed in columns menu and can be hidden or displayed by a user from this menu.
If set to 1, the pager can be also hidden automatically if there is no room for it, to preserve displaying "Too small extents" message.
This attribute does not affect displaying and hiding pager from configuration menu (you can control it by <MenuCfg ShowPager/> instead)
Pager header caption.
Pager width in pixels. A user can resize the pager by dragging its right side, unless it has CanResize='0'.
Minimal width of pager in pixels. This restriction is applied when a user resizes the pager or the pager is resized automatically when main tag width is too small.
If pager can be resized by a user.
If set to 1, pager can also be resized if there is no room for it, to preserver displaying "Too small extents" message.
If page will be highlighted under mouse cursor.
If set to 1, grid does not render any pager, regardless of settings in <Pagers> or <Pager> tag.
Called on click to pager page.
Pager is the API object for <P> tag.
Page is the object for the page related to the Pager Type.
Page2 (since 10.0) is the last date in the "Gantt" page.
Active (since 10.0) is true if the "Gantt" page is already selected in the chart. False means Click, true means DblClick.
Called when generating the HTML for individual pager pages.
Name is the default name to show.
Return new HTML name or Name.
See OnClickPagerPage for other attributes description.
Called when showing tip for pager page under mouse cursor.
Tip is default tip to show.
Drag is drag action name when dragging is active, otherwise null.
Return new tip or Tip.
See OnClickPagerPage for other attributes description.
Re-renders all pagers, including horizontal (space) pagers.
Starts scrolling side pager under mouse cursor. Only for touchpads (e.g. on iPad).
By default is the action attached to OnDrag2Pager for scrolling with two fingers.
An array of side pager objects. It has length property as count of the pagers.
The pagers can be accessible by the index or by the pager.Name.
The pager object has properties like all the <P> attributes.

Side pager type Pages

Pager for root pages (<Cfg Paging>)

Pager for root pages, defined by <Cfg Paging/>
Maximum of sorting columns to be listed in page names, can be set to 0 - 3.
If set to 0, the pages are always named "Page" + index.
Maximal count of characters in the page names, if both bounds are presents. Maximal count of characters in the page names, if single cell value is present. Cell value used for creating page names in side pager, see also OnGetPageNameValue event.
Called to get value used for creating page names in side pager val is predefined value, return val or new value.
Called when are being (re)generated page names for side pager after sorting or grouping.
page is given page, read and set its properties page.Name (HTML, page name displayed in pager) and page.Title (text, tooltip for page item on pager).
Pager settings, from XML node <Pager>.

Side pager type Gantt

Pager for Gantt zooms (<C GanttPageSize>)

Pager for Gantt zoom, defined by <C Type='Gantt' GanttPageSize/>
Sets size of the page in pager. If not set, the page size is set by column GanttSize.
If set neither <P PagerSize/> nor <C GanttSize/> nor <C xxxPageSize/>, the pager does not show any page.
The values are the same as GanttUnits.
PageSize can be set also in Gantt column instead of the pager <P> tag. The advantage is that it can be set different for every zoom level.
The xxx is the pager Name attribute, e.g. for <P Name='Test'/> it will be <C TestPageSize='...'/>
Sets size of the whole pager. The ChartSize unit should be bigger than PageSize / GanttSize.
The pager shows pages only from this date range.
The values are the same as GanttUnits.
For example when set PageSize='d' ChartSize='M', the pager shows all days from actual month in Gantt chart. Changing month in chart will regenerate the pager.
If the ChartSize is not set, the pager shows all dates from actual Gantt chart. The size of actual Gantt chart is calculated to show all items in the chart.
If the ChartSize is set to 0, the chart size is in range GanttChartMinStart - GanttChartMaxEnd, if set, otherwise it acts like the ChartSize=""
ChartSize can be set also in Gantt column instead of the pager <P> tag. The advantage is that it can be set different for every zoom level.
The xxx is the pager Name attribute, e.g. for <P Name='Test'/> it will be <C TestChartSize='...'/>
Adds given number of pages in front of pages (from previous ChartSize period)
ChartPrev can be set also in Gantt column instead of the pager <P> tag. The advantage is that it can be set different for every zoom level.
The xxx is the pager Name attribute, e.g. for <P Name='Test'/> it will be <C TestChartPrev='...'/>
Adds given number of pages after pages (from next ChartSize period)
ChartNext can be set also in Gantt column instead of the pager <P> tag. The advantage is that it can be set different for every zoom level.
The xxx is the pager Name attribute, e.g. for <P Name='Test'/> it will be <C TestChartPrev='...'/>
Formats the displayed page name. Formats starting date of the page.
If not set, the format is set by column xxxFormat.
The format is standard TreeGrid date / time format string for date PageSize, or standard TreeGrid number format string for number PageSize.
It can contain two formats separated by semicolon. In this case it prints two formatted date, the second format formats ending date of the page (= starting date of the next page minus 1).
Page Format can be set also in Gantt column instead of the pager <P> tag. The advantage is that it can be set different for every zoom level.
The xxx is the pager Name attribute, e.g. for <P Name='Test'/> it will be <C TestFormat='...'/>
Formats the displayed page tip (TITLE). Formats starting date of the page.
If not set, the format is set by column xxxTipFormat.
The format is standard TreeGrid date / time format string for date PageSize, or standard TreeGrid number format string for number PageSize.
It can contain two formats separated by semicolon. In this case it shows two formatted date, the second format formats ending date of the page (= starting date of the next page minus 1).
Page TipFormat can be set also in Gantt column instead of the pager <P> tag. The advantage is that it can be set different for every zoom level.
The xxx is the pager Name attribute, e.g. for <P Name='Test'/> it will be <C TestTipFormat='...'/>
Formats the displayed pager caption. Formats starting date of the pager (the first date of ChartSize or if not set, the first date in chart)
If not set, the format is set by column xxxCaptionFormat. If not set either it, it shows static Caption.
The format is standard TreeGrid date / time format string for date PageSize, or standard TreeGrid number format string for number PageSize.
It can contain two formats separated by semicolon. In this case it prints two formatted date, the second format formats ending date of the page (= starting date of the next page minus 1).
Pager CaptionFormat can be set also in Gantt column instead of the pager <P> tag. The advantage is that it can be set different for every zoom level.
The xxx is the pager Name attribute, e.g. for <P Name='Test'/> it will be <C TestCaptionFormat='...'/>
Name of the first zoom level to show the pager for.
If the actual zoom level will be lower (defined prior this zoom level in <Zoom> array), the pager will be hidden.
If not set, the pager is shown for all zoom levels from start.
Name of the last zoom level to show the pager for.
If the actual zoom level will be higher (defined after this zoom level in <Zoom> array), the pager will be hidden.
If not set, the pager is shown for all zoom levels to end.
What to do on the page click, replaces the ZoomToPage. For special actions use OnClickPagerPage API event instead.
For 0 it scrolls to the page date.
For 1 it sets GanttSize to the PageSize and scrolls to the page date.
For 2 it changes zoom level to show exactly the page range in the chart, but does not change the GanttSize.
For 3 it sets GanttSize to the PageSize and changes zoom level to show exactly the page range in the chart.
For 4 (new 10.0) it chooses the (first) zoom level with the same GanttSize as the pager PageSize. It scrolls to previously displayed date if the GanttSize increased.
What to do on the page double click, replaces the ZoomToPage. For special actions use OnClickPagerPage API event instead.
The double click means a click to already active page.
The options are the same as for Click.
Replaced by Click and DblClick.
If set to 1, highlights all pages in the pager that contain some Gantt object (Main bar, Flow, Run, Flag, Point, Constraint). Constraints used only if set GanttShowConstraints='2'.
If set to 2, works like 1, except it counts only edges of Main, Flow and Run bars. The Flag, Point and Constraints are counted the same as 1.
Used only if the pager size is equal or wider than actual zoom level (ChartSize>=GanttSize).
Can slow down the chart if there are a lot of rows with many objects, especially Run boxes!
If set to 1, highlights all pages that contain only excluded dates. Used only for page sizes equal or less than days (PageSize<='d').
Used only if the pager size is equal or wider than actual zoom level (ChartSize>=GanttSize).
If set, adds the zoom change done by clicking to the pager page to the zoom undo to be undone by action UndoZoom.
Limits the size of the chart to this unit. The values are the same as the GanttUnits.
For example GanttSize='M' shows always Gantt chart for one month.
This value can be used to show only part of the chart or for paging in Gantt chart using side pager Type='Gantt'
If set to empty string, it tries to show the whole chart. Also moving Gantt object outside the visible range will resize the visible range. It is default behavior in grid prior 9.0.
If set to 0, it tries to show the whole chart, moving Gantt object outside the visible range never resizes the visible range.
In API, the Grid.Cols[gantt_col].GanttSize contains actually selected page size in the grid.
Count of GanttUnits added before GanttSize range, to show it from previous range.
Count of GanttUnits added after GanttSize range, to show it from next range.

Side pager type Custom

Custom pager controlled by API events

Custom pager controlled by API events.
Use the pager API events to control the individual pages: OnGetPageName, OnGetPageTip, OnClickPagerPage.
Called to get count of items to show on custom pager.

Pager cell with navigation buttons and edit

Displays control buttons PagerFirst, PagerPrevious, PagerNext, PagerLast and editable cell with page number and number of pages named PagerEdit.
This cell is replaced by the mentioned buttons and the editable cell and no longer exists for API.
You can set also attributes of the new cells, for example PagerEditWidth='100' or PagerNextOnClick='MyActionNext()'
Due its internal implementation, the Pager Type cell is available only in Extended API.

Pager cell as list of page indexes

Displays all page numbers as links to the pages. Displays horizontal scrollbar if required.
You can set cell attribute RelWidth='1' to show the cell on the whole row.
You can set also cell attribute Wrap='1' to not show the horizontal scrollbar.
Maximal count of page links displayed in Pages type cell.
The Pages type cell displays actual page + up to Count/2-1 links before actual page + up to Count/2 links after actual page + first page + last page + links for Step.
For Pages type cell. It contains one or more comma separated values to display only some page links outside the Count range.
For example for Step='10' it displays pages 10, 20, 30, ...
For example for page 254 Count='10' Step='10,100' it displays pages 1, 100,200,210,220,230,240, 250,251,252,253,254,255,256,257,258,259,260, 270,280,290,300,400,500,600,...
When set cell attribute Wrap='2' the steps are displayed on own lines, the pager will be displayed on three lines. Otherwise the step links are separated by space.
Remember, when used Step the count of links often changes when changes active page and the pager height can change too. You should set row Height attribute to maximal expected height of the pager to avoid grid flickering.
Called for Pages type for every page number to get the html displayed in the link for the page.
The number is displayed for the page. It starts from 1, so it is bigger by 1 than the related page index.
To get page object call grid.GetPage(number-1);