Attention: This topic contains Product-sensitive Programming Interface
and Associated Guidance Information.
The DFHMDX macro is invoked from within DFHMSX. Its
syntax is shown in Figure 1.
Figure 1. Syntax of DFHMDX 
DFHMDX
.-*----.
>>-DFHMDX--+-MAPSET=name--+--------------+--,MAP=-+-name-+-+---->
| '-,MODULE=name-' |
'-MAPSET=*--,MAP=*------------------------------'
>--+------------------------------------------+--+---------------------+-->
'-,DOCTYPE=-+-'-//W3C//DTD HTML 3.2//EN'-+-' '-,TITLE='title-text'-'
'-doctype--------------------'
>--+-------------------------------------+--+-----------------+--+---------------------+-->
'-,MASTHEAD=-+-url------------------+-' '-,BACKGROUND=url-' '-,BGCOLOR=-| color |-'
'-url,'alternate text'-'
>--+------------------+--+------------------+--+-------------------+--+-------------------+-->
'-,TEXT=-| color |-' '-,LINK=-| color |-' '-,VLINK=-| color |-' '-,ALINK=-| color |-'
>--+----------------------------+--+--------------------------------+--+--------------------+-->
| .-,--------------------. | | .-,------------------------. | | .-YES----. |
| V | | | V | | '-,RESET=-+-NO-----+-'
'-,---| key |-=-| button |-+-' '-,---| bmscolor |-=-| color |-+-' '-'text'-'
>--+---------------------------+--+-------------------------------------------------+-->
| .-,---------. | | .-,---------. |
| V | | | V | |
'-,RALIGN=(---(row,col)-+-)-' '-,SUPPRESS=(---(row,col)-+-+-------+-+-------+-)-'
'-,HEAD-' '-,FOOT-'
>--+----------------+--+------------------+--+--------------------+--+--------------------------+-->
'-,ONLOAD='text'-' '-,ONUNLOAD='text'-' | .-YES-. | '-OPENSQ--=--+-char------+-'
'-,PROPFONT=-+-NO--+-' '-hex-value-'
>--+---------------------------+--+--------------------------+--+---------------------------+-->
'-CLOSESQ--=--+-char------+-' '-OPENBR--=--+-char------+-' '-CLOSEBR--=--+-char------+-'
'-hex-value-' '-hex-value-' '-hex-value-'
>--+--------------------------+--+--------------------+--+--------------------+-><
'-EXCLAM--=--+-char------+-' '-,CODEPAGE=codepage-' | .-NO--. |
'-hex-value-' '-,NUMALIGN=-+-YES-+-'
The keyword parameters to this macro can appear in any
order.
- MAPSET
- specifies the name of the map set that contains the map to which
other options refer. If you specify an asterisk, the options become
the default to all subsequent map sets.
- MODULE
- specifies the name of the load module into which the map set is
link-edited. You can only use this parameter if you do not specify
MAPSET=*. The name you specify (which can only be seven characters)
is used to construct the names of the templates by adding a single
character suffix. The default value is the name of the map set.
- MAP
- specifies the name of the map within the map set specified in
MAPSET to which the options refer. If you specify an asterisk, the
options become the default to all subsequent maps.
- DOCTYPE
- specifies the DTD public identifier part of the <!doctype>
tag that you want to appear in the HTML template. The default is -//W3C//DTD
HTML 3.2//EN, which specifies HTML 3.2. Level 3.2 is required
for the color support in certain HTML tags.
- TITLE
- specifies the title to be used as the HTML title, and as the content
of the first <h1> tag.
- MASTHEAD
- specifies the URL of a masthead graphic to appear at the head
of a page before the first <h1> tag. If you supply alternate-text,
the client will use the text if it cannot load the specified graphic.
- BACKGROUND
- specifies the URL of a graphic file for the page background.
- BGCOLOR
- specifies the color of the page background.
- TEXT
- specifies the color of normal text.
- LINK
- specifies the color of unvisited hypertext links on the page.
- VLINK
- specifies the color of visited hypertext links on the page.
- ALINK
- specifies the color of activated hypertext links on the page.
- PF1-PF24
- specifies the name or image to be assigned to the simulated button
for the corresponding 3270 program function key.
- PA1-PA3
- specifies the name or image to be assigned to the simulated button
for the corresponding 3270 program attention key.
- CLEAR
- specifies the name or image to be assigned to the simulated button
for the 3270 Clear key.
- ENTER
- specifies the name or image to be assigned to the simulated button
for the 3270 Enter key.
- PEN
- specifies the name or image to be assigned to the simulated button
for pen selection.
- BLUE
- specifies the color to appear in the HTML page where blue is specified
in the BMS map. The default is #0000FF.
Restriction: DFHMDX will only override the colour of unnamed
fields; it leaves named fields unchanged.
- GREEN
- specifies the color to appear in the HTML page where green is
specified in the BMS map. The default is #008000.
Restriction: DFHMDX will only override the colour of unnamed
fields; it leaves named fields unchanged.
- NEUTRAL
- specifies the color to appear in the HTML page where neutral is
specified in the BMS map. The default is #000000.
Restriction: DFHMDX will only override the colour of unnamed
fields; it leaves named fields unchanged.
- PINK
- specifies the color to appear in the HTML page where pink is specified
in the BMS map. The default is #FF00FF.
Restriction: DFHMDX will only override the colour of unnamed
fields; it leaves named fields unchanged.
- RED
- specifies the color to appear in the HTML page where red is specified
in the BMS map. The default is #FF0000.
Restriction: DFHMDX will only override the colour of unnamed
fields; it leaves named fields unchanged.
- TURQUOISE
- specifies the color to appear in the HTML page where turquoise
is specified in the BMS map. The default is #00FFFF.
Restriction: DFHMDX will only override the colour of unnamed
fields; it leaves named fields unchanged.
- YELLOW
- specifies the color to appear in the HTML page where yellow is
specified in the BMS map. The default is #FFFF00.
Restriction: DFHMDX will only override the colour of unnamed
fields; it leaves named fields unchanged.
- RESET
- specifies whether the HTML reset function is to be supported.
Specify YES to get a default reset button with the default legend
Reset. Specify NO to get no reset button. Specify your own text for
a reset button with your own legend.
- RALIGN
- specifies BMS map fields in which data is to be right aligned
in the HTML page. The values rr and cc specified must
correspond to the POS=(rr,cc) specification on the DFHMDF
macro for a field to be right aligned. Each pair must be enclosed
in parentheses, and the whole list of pairs must be enclosed in parentheses.
If you want to right align every qualifying field which ends in a
particular column, specify the end column number and put an asterisk
for the row specification. Calculate the end column number for a field
by adding its start column number to its LENGTH, as defined in the
DFHMDF macro. Fields will be right aligned only if they are protected,
unnamed, and are initialized with an INITIAL, XINIT or GINIT value
in the DFHMDF macro. The RALIGN parameter is ignored if you specify
it with MAP=* or MAPSET=*.
If you wish to specify a list that exceeds
the assembler's limit of 256 characters for a character string in
macro definitions, code extra DFHMDX macros with the same MAPSET and
MAP values, and put more values in the RALIGN parameters.
- SUPPRESS
- specifies BMS map fields that are not to appear in the HTML page.
Specify any number of row and column pairs for the start positions
of the fields to be suppressed. The values rr and cc specified
must correspond to the POS=(rr,cc) specification on
the DFHMDF macro for a field to be suppressed. Each pair must be enclosed
in parentheses, and the whole list of pairs must be enclosed in parentheses.
If you want to suppress all the fields in a row, specify the row number
and put an asterisk for the column specification. The SUPPRESS parameter
is ignored if you specify it with MAP=* or MAPSET=*.
Use the keyword
HEAD to suppress the
heading
section
in the template. Use the keyword FOOT to suppress the
footing section
in the template.
If you wish
to specify a list that exceeds the assembler's limit of 256 characters
for a character string in macro definitions, code extra DFHMDX macros
with the same MAPSET and MAP values, and put more values in the SUPPRESS
parameters.
- ONLOAD
- specifies the JavaScript text to be used
to replace the standard onLoad exception handler
for the HTML page. The text must not contain double quotes ("),
and single quotes (') must be doubled ('')
following the usual assembler language conventions. If you use this
parameter you will suppress the setting of the cursor to the field
indicated by DFH_CURSOR provided by the standard onLoad exception
handler. You can use the function dfhsetcursor to
set the cursor position.
- ONUNLOAD
- specifies the JavaScript text to be used
as the onUnload exception handler for the HTML page.
The text must not contain double quotes ("), and
single quotes (') must be doubled (''),
following the usual assembler language conventions.
- PROPFONT
- specifies the font. If YES, the template will specify that text
is to be presented in a proportional font, and consecutive spaces
are to be reduced to a single space. If NO, the template will specify
that text is to be specified in a font of fixed pitch, and consecutive
spaces are to be preserved.
- OPENSQ
- The hex value or the character to be used to display an open square
bracket. The default is X'BA' (code page 37).
- CLOSESQ
- The hex value or the character to be used to display a close square
bracket. The default is X'BB' (code page 37).
- OPENBR
- The hex value or the character to be used to display an open brace.
The default is X'C0' (code page 37).
- CLOSEBR
- The hex value or the character to be used to display a close brace.
The default is X'D0' (code page 37).
- EXCLAM
- The hex value or the character to be used to display an exclamation
mark. The default is X'5A' (code page 37).
- CODEPAGE
- specifies the IBM® code page number in which any
text generated by the template generation process is encoded. This
code page must match the code page used when the templates are used
by CICS®, either in the HOSTCODEPAGE option of the EXEC
CICS DOCUMENT command, or in the SRVERCP option of the DFHCNV
macro selected by the analyzer program. The IBM host
code pages supported by CICS are described in CICS Family:
Communicating from CICS on System/390®.
The default code page is 037.
- NUMALIGN
- specifies how fields that are explicitly defined as numeric in
the DFHMDF macro are aligned within the table cells in the HTML template:
- NO
- specifies that numeric fields are not right aligned within their
table cells. This is the default.
- YES
- specifies that numeric fields are right aligned within their table
cells:
- For a protected field, the generated HTML text is right aligned
within the cell. If the text contains trailing blanks, they may not
be preserved: some clients will replace them with a single blank.
Note: The
RALIGN parameter preserves trailing blanks; the NUMALIGN parameter
does not. If both parameters apply to a field (that is, if a numeric
field is identified by the RALIGN parameter, and NUMALIGN=YES is specified),
trailing blanks are not preserved.
- For an unprotected field, the HTML text input element (but not the
text within the element) is right aligned within the cell.
color can be an explicit specification #rrggbb,
where rr, gg, and bb are 2-digit hexadecimal
numbers giving the intensities of red, green, and blue in the requested
color, or it can be any one of the following color names: AQUA, BLACK, BLUE, FUCHSIA, GRAY, GREEN, LIME, MAROON, NAVY, OLIVE, PURPLE, RED, SILVER, TEAL, WHITE, YELLOW.
key can
be any of PF1 to PF24, PA1 to PA3, CLEAR, ENTER,
and PEN.
button can be (IMAGE,url),
where url specifies the URL of a graphic image to be used for
the button, or 'text', where text is
the text to be put in the button, or NO if the button
is not to appear.
bmscolor can be any of BLUE, GREEN, NEUTRAL, PINK, RED, TURQUOISE,
and YELLOW.