getDelimitedFileOptions

getDelimitedFileOptions(fieldSeparator:         Character output;
                        fieldDelimiter:         Character output;
                        extractGroupHeaders:    Boolean output;
                        extractGroupFooters:    Boolean output;
                        extractReportHeaders:   Boolean output;
                        extractReportFooters:   Boolean output;
                        combineGroupsAndDetail: Boolean output;
                        formatDates:            Boolean output;
                        formatNumerics:         Boolean output);

The getDelimitedFileOptions method of the JadeReportWriterReport class obtains the current values to be used when running the report for extraction to a delimited file.

These values were set when the report was designed by using the appropriate controls in the JADE Report Writer Designer application Report Properties dialog. If you want to override these values at run time, you can call the setDelimitedFileOptions method and pass as parameters the delimited file values that you require.

The parameters for the getDelimitedFileOptions method are listed in the following table.

Parameter Specifies…
fieldSeparator The delimiter that is used between each field of data (for example, a comma or a tab character)
fieldDelimiter The character that is placed around each non-null field (and is typically a quote (‘) character)
extractGroupHeaders Whether group header data is extracted to the output file
extractGroupFooters Whether group footer data is extracted to the output file
extractReportHeaders Whether report header data is extracted to the output file
extractReportFooters Whether report footer data is extracted to the output file
combineGroupsAndDetail Whether group header and detail fields are combined into one record
formatDates Whether date fields are written as formatted strings as they are for a printed report (when true) or as a numeric value (when false)
formatNumerics Whether numeric fields are written as formatted strings as they are for a printed report (when true) or as unformatted numeric values (when false)

If the values of both the combineGroupsAndDetail and extractGroupHeaders parameters are true, each extract record contains the group header fields in order and then the detail fields combined into one record.

If both the combineGroupsAndDetail and extractGroupHeaders parameters are not set to true and the extractGroupHeaders or extractGroupFooters parameter is set to true, group data is extracted as separate records.