documentToDelimitedDataString
Converts a document to a delimited data string.
This service will convert the following document:
To the string containing the following delimited data: (useHeaderRowForFieldNames=true)
"Date","Pupil","Grade"
"25 May","Bloggs, Fred","C"
"25 May","Doe, Jane","B"
"15 July","Bloggs, Fred","A"
Here the fieldQualifier = Comma(,) and textQualifier= double quote(")
To the string containing the following delimited data: (useHeaderRowForFieldNames=false)
"column1","column2","column3"
"Date","Pupil","Grade"
"25 May","Bloggs, Fred","C"
"25 May","Doe, Jane","B"
"15 July","Bloggs, Fred","A"
Here the fieldQualifier = Comma(,) and textQualifier= double quote(")
Input Parameters
document | Document. Document to be converted to delimited data string. This document contains document array rows[] corresponding to the delimited data. |
fieldQualifier | String Optional. The delimiter to use for separating entries in delimitedDataString. Default is comma (,). |
textQualifier | String Optional. The character to use for quoted elements. Default is double quote ("). |
useField NamesFor HeaderRow | String Optional. The first line in the output delimited data delimitedDataString will be constructed using the property names in the input document array document\rows[]. Set to: true. Property names in the input document array document\rows[] will be used as the first row in the output delimitedDataString. false. column1, column2...columnN will be used as the first row in the output delimitedDataString. |
encoding | String Optional. The encoding to use while parsing the delimited data. |
Output Parameters
delimited DataString | String. Delimited data byte string resulting from the conversion of a document. |