Data Grid Data and Headers DTD

<!DOCTYPE GRID [
  <!ELEMENT GRID ANY>
  <!ATTLIST GRID hPageCnt CDATA #IMPLIED>
  <!ATTLIST GRID vPageCnt CDATA #IMPLIED> 
  <!ATTLIST GRID hPageNum CDATA #IMPLIED> 
  <!ATTLIST GRID vPageNum CDATA #IMPLIED> 
  <!ELEMENT RHDRS (HDR*)>
  <!ATTLIST RHDRS count CDATA #IMPLIED>
  <!ELEMENT CHDRS (HDR*)>
  <!ATTLIST CHDRS count CDATA #IMPLIED>
  <!ELEMENT HDR EMPTY>
  <!ATTLIST HDR idx CDATA #IMPLIED>
  <!ATTLIST HDR dim CDATA #IMPLIED>
  <!ATTLIST HDR txt CDATA "">
  <!ATTLIST HDR exp CDATA "0">
  <!ATTLIST HDR gen CDATA "0">
  <!ELEMENT CELLS (CELL*)>
  <!ELEMENT CELL (CELLTEXT?, LINEITEMDETAIL?, CELLATTACHMENTS?)>
  <!ATTLIST CELL row CDATA #IMPLIED>
  <!ATTLIST CELL col CDATA #IMPLIED>
  <!ATTLIST CELL value CDATA "">
  <!ATTLIST CELL status CDATA #IMPLIED>
  <!ATTLIST CELL color CDATA #IMPLIED>
  <!ATTLIST CELL tasks CDATA "0">
  <!ELEMENT CELLTEXT EMPTY>
  <!ATTLIST CELLTEXT text CDATA #IMPLIED>
  <!ELEMENT LINEITEMDETAIL (LINES)>
  <!ELEMENT LINES (LINE*)>
  <!ELEMENT LINE EMPTY>
  <!ATTLIST LINE idx CDATA #IMPLIED>
  <!ATTLIST LINE desc CDATA #IMPLIED>
  <!ATTLIST LINE data CDATA #IMPLIED>
  <!ELEMENT CELLATTACHMENTS (DOCUMENTS)>
  <!ELEMENT DOCUMENTS (DOCUMENT*)>
  <!ELEMENT DOCUMENT EMPTY>
  <!ATTLIST DOCUMENT file CDATA #IMPLIED>
  <!ATTLIST DOCUMENT path CDATA #IMPLIED>
]>

Element

Description

GRID

Root element, and contains the following attributes:

  • hPageCnt = Total number of horizontal pages in the grid.

  • vPageCnt = Total number of vertical pages in the grid.

  • hPageNum = The horizontal page number of the current page (0-based).

  • vPageNum = The vertical page number of the current page (0-based).

RHDRS

Row header information. An <RHDRS> tag contains one <HDR> tag for each row header.

<RHDRS> contains the count attribute, which represents the number of rows on the grid page.

Note:

If you are using SaveDirtyCellsOnLastGridPageFromXML, do not include <RHDRS>.

CHDRS

Column header information. A <CHDRS> tag contains one <HDR> tag for each column header.

<CHDRS> contains the count attribute, which represents the number of columns on the grid page.

Note:

If you are using SaveDirtyCellsOnLastGridPageFromXML, do not include <CHDRS>.

HDR

Represents a row or column header, and contains the following attributes:

  • idx = Row or column number (0-based).

  • dim = Dimension index, which is the 0-based index within the row or column for the dimension (corresponds to the lDimIndex parameter used in “Expand” methods such as ExpandRowDimension).

  • txt = Row or column label. This may be either a member label, a member description, or a combination of the two, depending on the metadata display mode. This attribute is empty for unexpanded dimensions.

  • exp = The current expansion state, which is represented by the following values:

    -1 = The dimension not expanded.

    0 = Members are shown as a flat list, and no expansion is supported.

    1 = The member has no children, and cannot be expanded.

    2 = The member has children and is expanded.

    3 = The member has children and is not expanded.

  • gen = The generation level within the hierarchy (0=top level). This attribute has meaning only for hierarchical dimensions such as the Entity dimension.

    Note:

    If you are using SaveDirtyCellsOnLastGridPageFromXML, do not include <HDR>.

CELLS

Represents the collection of cells in the data grid. A <CELLS> tag contains one <CELL> tag for each cell.

CELL

Represents a cell in the grid. A <CELL> element can contain 0 or 1 <CELLTEXT> elements, 0 or 1 <LINEITEMDETAIL> elements, and 0 or more <CELLATTACHMENTS> elements. <CELL> contains the following attributes:

  • row = The row number (0-based).

  • col = The column number (0-based).

  • value = The cell value. The value will vary depending on the data display mode, which is specified by the sDisplayDataMode argument of GetGridPageWithExpansionInfoAsXML.

    Note:

    For data, value represents the numeric data value; for calculation status, value represents the status; for process state, value represents the current Process Management state.

  • status = The cell's status. Cell statuses are described in About Cell Statuses.

  • color = Represents the color that identifies the cell’s status. For details on valid values, see the description of the pvaralColors argument for GetGridPage.

  • tasks = Indicates the Data Explorer tasks allowed for this cell. The numbers that are valid values for tasks are represented by the HFMConstants type library constants listed in Data Explorer Task Constants.

    Note:

    If you are using SaveDirtyCellsOnLastGridPageFromXML, include only the row, col, and value attributes, and do not include status, color and tasks.

CELLTEXT

Represents cell text for the cell. The text attribute contains the text.

LINEITEMDETAIL

The parent element of line item details for the cell.

LINES

An enumeration of the line item details. <LINES> contains a <LINE> tag for each line item detail.

LINE

Represents a line item, and contains the following attributes:

  • idx = The index of the line item.

  • data = The line item's numeric value.

  • desc = The line item’s description.

CELLATTACHMENTS

The parent element of the cell’s attachments. <CELLATTACHMENTS> contains a <DOCUMENTS> tag, which in turn contains the cell attachment.

DOCUMENTS

Contains one <DOCUMENT> element per cell attachment.

DOCUMENT

Represents a cell attachment, and contains the following attributes:

  • file = The name of the attachment.

  • path = The path of the attachment.