Specifying List Viewer object tag parameters

To embed an instance of the List Viewer in HTML, use the object tag with the type set to application/avantgo-mime-list :

<object id=objName type="application/avantgo-mime-list" 
    width=pixelsWide height=pixelsHigh
    style=inlineStyleSpec>

Where:

  • objName is the label you will use to refer to the list object.

  • pixelsWide is the width of the list area in pixels.

  • pixelsHigh is the height of the list area in pixels.

  • inlineStyleSpec is an inline style specification to control the formatting of the list display.

The Master-Detail page example illustrates the use of the List Viewer.

For a list of parameters you can specify within the object tag, see the table below. For reference material you will need to write JavaScript or C code to use the Date/Time Picker, see M-Business Date/Time Picker API.

For a list of parameters you can specify within the object tag, see the table below. After the object tag for the List Viewer is specified, you can use the M-Business List Viewer API on the object.

Specific format specifications for the read-only text field are listed in Field format specifications.

Table 5. List Viewer object tag parameters

Specification

Description

cellBgColor

The background color for the selected cell.

cellSelectBgColor

The background color for the selected cell.

cellBdColor

The border color for the cell.

cellSelectBdColor

The border color for the selected cell.

colAlignment_n

Horizontal placement of the contents for cells in column n. This attribute can also be set by calling setColumnAlignment() from JavaScript.

Possible values for alignment are:

0 (left alignment)

1 (right alignment)

2 (center alignment)

colDSName_n

Data source column name for column n. This attribute can also be set by calling setColumnDSName() from JavaScript.

colFormat_n

Format specifications for column n. This attribute works for columns of integer and datetime types only. This attribute can also be set by calling setColumnFormat() from JavaScript. See Field format specifications, for a list of specification values and their associated descriptions.

colMargin

The margin between each column in the list.

colTitle_n

Title for column n. This attribute can also be set by calling setColumnTitle() from JavaScript.

colWidth_n

Suggested width for column n. This attribute can also be set by calling setColumnWidth() from JavaScript.

dbname

Name of the M-Business XML datastore.

headerBgColor

The background color for the header.

headerBdColor

The border color for the header.

numCols

Number of columns in the list. This attribute can also be set by calling setColumnCount() from JavaScript.

numRows

Suggested number of rows in the list.

realTimeScroll

Scroll list data in real time? true/false; default is true.

rowMargin

The margin between each row in the list.

scrollbarArrowColor

The color for the scroll bar arrows.

scrollbarBubbleColor

The color for the scroll bar bubble.

scrollbarBdColor

The border color for the scroll bar.

scrollbarBgColor

The background color for the scroll bar.

scrollbarButtonColor

The background color for the scroll bar up/down buttons.