GetGridPageWithExpansionInfoAsXML

Returns an XML representation of the specified page. The XML string includes the page’s data, row and column headers, and member expansion information. (For information on pages, see Pages on Grids.)

Tip:

To return grid page information in other formats, use GetGridPageWithExpansionInfo or GetGridPageWithExpansionInfoAsJavaScript.

Syntax

<HFMwDataGrid>.GetGridPageWithExpansionInfoAsXML (lhPage, lvPage, sDisplayDataMode, varbForceGetPage)

Argument

Description

lhPage

The horizontal index of the desired page.

Input argument. Long subtype.

lvPage

The vertical index 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.

varbForceGetPage

Specifies whether to force a reload of the page. By default, if the horizontal and vertical page numbers are the same as the last request, the grid page is retrieved from a cache instead of the database. Passing TRUE will override this default by forcing a load from the database, passing FALSE will enact the default behavior.

Input argument.

Return Value

Returns a string containing an XML representation of the grid. The XML string is described in Data Grid Data and Headers DTD.