GetGridPage

Returns data for the specified page of the grid, as well as the corresponding row and column headers.

Tip:

For information on pages, see Pages on Grids.

Syntax

<HFMwDataGrid>.GetGridPage lhPage, lvPage, sDisplayData, pvarabstrRowHeaders, pvarabstrColHeaders, pvarabstrValues, pvaralStatus, pvaralColors

Argument

Description

lhPage

The horizontal index (0-based) of the desired page.

Input argument. Long subtype.

lvPage

The vertical index (0-based) of the desired page.

Input argument. Long subtype.

sDisplayData

The data display mode. Pass one of the HFMConstants type library constants listed in Data Information Display Constants.

Input argument. Integer subtype.

pvarabstrRowHeaders

Returns a nested array of the row headers. The argument returns an array consisting of one element for each row. Each element consists of an array that contains one string element for each nested dimension label.

Output argument.

pvarabstrColHeaders

Returns a nested array of the column headers. The argument returns an array consisting of one element for each column. Each element consists of an array that contains one string element for each nested dimension label.

Output argument.

pvarabstrValues

Returns an array of strings that contain data for the grid page’s cells. The data is formatted according to the user’s scaling and decimal separator preferences, and is organized in row major order.

Output argument.

pvaralStatus

Returns an array of numbers representing the cells’ statuses. The data is organized in row major order.

For details on cell statuses, see About Cell Statuses.

Output argument.

pvaralColors

Returns an array of numbers representing the colors that indicate the cell statuses. The data is organized in row major order.

The numbers correspond to colors used in the Data Explorer. These numbers are mapped to styles in the DataCellStyles.css style sheet, which is part of the Financial Management installation for the Web server. This mapping works as follows:

  • The styles are named according to the following convention, with n corresponding to the numbers returned in this array:

    .datagrid TD INPUT.COLORn

  • The colors of the cell and font are defined by the applicable style’s BACKGROUND-COLOR and COLOR attributes, respectively. For example, if 2 is returned as an array item, the color would be the BACKGROUND-COLOR attribute of the .datagrid TD INPUT.COLOR2 style.

    Note:

    If the style does not contain a BACKGROUND-COLOR attribute, the cell color defaults to white. If the style does not contain a COLOR attribute, the font color defaults to black.

Output argument.