CA Technologies Prerelease Documentation. Authorized Use Only.

PDM Macro Definitions › lsExport

lsExport

Use the lsExport macro in place of lsCol to specify a column for a list form that is not included in the web UI list. However, this column is included in the spreadsheet generated by exporting the list. You define the contents of a list form with the lsStart, lsCol, and lsEnd macros. You can optionally include lsWrite and lsExport macros. For example:

<PDM_MACRO name=lsStart. . .>
<PDM_MACRO name=lsCol . .>
<PDM_MACRO name=lsCol . .>
<PDM_MACRO name=lsWrite . .>
<PDM_MACRO name=lsCol . .>
. . . 
<PDM_MACRO name=lsEnd>

HTML for the entire list is output by the lsEnd macro. The other list macros save information used by lsEnd to generate the list.

This macro has the following properties:

attr=attributeName

(Required) Specifies the name of the attribute associated with the control.

common_name_option=yes|no

Specifies whether the column contains an SREL attribute. The common name of the referenced table replaces this attribute value when the list is exported.

export=yes|no

Specifies whether this column is exported when the user clicks the Export button.

export_hdr_default

Specifies the text of the header.

exportFmt=function

Specifies the name of a JavaScript function (without parentheses) that returns a string format code used to control formatting the column when it is exported. The function can return the following values:

• "YES_NO"—Return either "yes" or "no"
• "FACTORY_LINK"—No formatting (reserved for future use)
• "LIST_LOOKUP:v1,v1a,v2,v2a,.."—Convert from a list. A value matching the first element in a pair is converted to the second element in the pair.

exportHdr=text|DISPLAY_NAME

Specifies the header for the column when it is exported. You can specify the value as explicit text, or as the keyword value DISPLAY_NAME, which sets the header to the value of export_hdr_default.

export_hdr_default=text

Specifies the text of the export column header when exportHdr has the keyword value DISPLAY_NAME. You rarely must specify this property, which defaults to the display name of the attribute of the column.

hdr=text

Specifies the text of the caption on the control; defaults to the DISPLAY_NAME of the attribute associated with the control.

label=string

Specifies text for a label positioned to the left of data.