GetGridPageWithExpansionInfo

Returns data from the specified page of the grid, as well as the corresponding row headers, column headers, and member expansion information. (For information on pages, see Pages on Grids.)

Tip:	To return grid page information in an XML or JavaScript format, use GetGridPageWithExpansionInfoAsXML or GetGridPageWithExpansionInfoAsJavaScript.

Syntax

<HFMwDataGrid>.GetGridPageWithExpansionInfo lhPage, lvPage, sDisplayDataMode, pvaravarabstrRowHeaders, pvaravarabstrColHeaders, pvaravarabyteRowMemberExpansionModes, pvaravarasRowMemberGenerationLevels, pvaravarabyteColumnMemberExpansionModes, pvaravarasColumnMemberGenerationLevels, pvarabstrData, 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.
sDisplayDataMode	Specifies the data display mode. Pass one of the HFMConstants type library constants listed in Data Information Display Constants. Input argument. Integer subtype.
pvaravarabstrRow Headers	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.
pvaravarabstrColHeaders	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.
pvaravarabyteRowMemberExpansionModes	Returns an array with one element for each row. Each element contains an array that consists of a flag for each nested dimension member. The flag indicates whether the member is expanded in the hierarchy. The HFMConstants type library constants that represent the valid return values are listed in Data Grid Member Expansion Mode Constants. Output argument.
pvaravarasRowMemberGenerationLevels	Returns an array of arrays that indicate the position of the dimension members in the hierarchy. 0 indicates the top level of the hierarchy, 1 the next level, and so on. Note: This argument applies only in a hierarchical view of a dimension Output argument.
pvaravarabyteColumnMemberExpansionModes	Returns an array with one element for each row. Each element contains an array that consists of a flag for each nested dimension member. The flag indicates whether the member is expanded in the hierarchy. The HFMConstants type library constants that represent the valid return values are listed in Data Grid Member Expansion Mode Constants. Output argument.
pvaravarasColumnMemberGenerationLevels	Returns an array of arrays that indicate the position of the dimension members in the hierarchy. 0 indicates the top level of the hierarchy, 1 the next level, and so on. Note: This argument applies only in a hierarchical view of a dimension Output argument.
pvarabstrData	Returns an array of strings that represent the page’s data, organized in row major order. Data is formatted according to the user’s scaling and decimal separator preferences. 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.