GetProcessManagementGridPage

Returns process management-related information for the specified page of the HFMwDataGrid instance.

Syntax

<HFMwDataGrid>.GetProcessManagementGridPage lhPage, pvarabstrEntities, pvarabstrData, pvarabstrCalcStatus, pvarabstrReviewLevels, pvaralPassFail, pvaralStatus, pvaralColors, pvaralUnfilteredRowNumbers

Argument

Description

lhPage

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

Input argument. Long subtype.

pvarabstrEntities

Returns an array containing the labels of the entities for the process units on the page.

Input/output argument.

pvarabstrData

Returns an array containing the data in the process units.

Input/output argument.

pvarabstrCalcStatus

Returns an array containing the calculation statuses of the process units.

Input/output argument.

pvarabstrReviewLevels

Returns an array containing the review levels of the process units.

Input/output argument.

pvaralPassFail

Returns an array indicating whether the process units passed or failed validation for promotion. Valid values are represented by the HFMConstants type library constants listed in Process Management Validation Constants.

Input/output argument.

pvaralStatus

Returns an array of numbers representing the cells’ statuses.

For details on cell statuses, see About Cell Statuses.

Input/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.

Input/output argument.

pvaralUnfilteredRowNumbers

Returns an array of the unfiltered row numbers in the data grid.

Input/output argument.