GetGridDefinitionAsXMLEx

Returns an XML representation of the specified grid elements.

Syntax

<HFMwDataGrid>.GetGridDefinitionAsXMLEx (lFlagsRequestedInfo)

Argument

Description

lFlagsRequestedInfo

Specifies the grid information to be returned. Pass one or more of the HFMConstants type library constants listed in Data Grid Definition Constants.

You can use the addition operator ( + ) with these constants to return multiple types of information.

Note:

To return information on the grid’s expanded dimensions, you must have expanded rows or columns with a method such as ExpandColumnDimension.

Note:

To return information on the grid’s user interface state, you must have previously called SaveUIStateUsingXML.

Input argument. Long subtype.

Return Value

A string containing the XML representation of the specified grid elements. The XML string is described in Data Grid Definition DTD.

Example

The following example prints information on the grid’s row and column dimensions to a file. Note how the call to GetGridDefinitionAsXMLEx uses the addition operator to return information on both the row and column dimensions.

Dim sXml, oFs, oTs
' cHFMDataGrid is a previously set HFMwDataGrid object
sXml = cHFMDataGrid.GetGridDefinitionAsXMLEx( _ 
WEBOM_DATAGRID_DEFINITION_INFO_COLDIMS + _ 
WEBOM_DATAGRID_DEFINITION_INFO_ROWDIMS)
' Write the string to disk as a text file
set oFs = CreateObject("Scripting.FileSystemObject")
' sFile was previously set to a file name and path
set oTs = oFs.CreateTextFile(sFile)
oTs.Write(sXml)
oTs.Close