Skip to content

ExportToXml

Maps the table rows into XML using the supplied query mapping options.

myDataTable.ExportToXml(options: Columns : Array<Expression> : ( ... | ... )
An expression for the column, which can be a calculation or transformation.

Name : ( ... | ... )
The name of the column to use in the results. If not specified, the

XPath : ( ... | ... )
An XPath expression to map data to the column.
An array of columns to include in the result set.

Map : (this: DataRow, node: Xml) => void
A custom mapper function to apply to each node in the result set.

MaxLength : number
The maximum number of rows to return. If not set, all rows are returned.

Node : Xml
The root node for the mapping. If not specified, the global

Order : Array<Expression> : string
The expression to use for ordering the results.

Type : ( ... | ... | ... )
The type of ordering (ascending or descending). If not specified, defaults to "Ascending".
An array of order expressions to sort the results.

Parameters : object
Additional parameters to pass to the query.

Start : number
The starting index for the rows to return.

SubQueries : Array<Columns> : ( ... | ... )
An array of columns to include in the result set.

MaxLength : ( ... | ... )
The maximum number of rows to return. If not set, all rows are returned.

Name : ( ... | ... )
The name of the sub-query. The relation name can be used as the name.

Order : ( ... | ... )
An array of order expressions to sort the results.

Parameters : ( ... | ... )
Additional parameters to pass to the query.

Relation : ( ... | ... )
The name of the relation to use for the sub-query.

Start : ( ... | ... )
The starting index for the rows to return.

SubQueries : SubQuery[] | undefined
An array of sub-queries to include in the result set.

TargetSchema : ( ... | ... )
The name of the schema to execute the query against.

TargetTable : ( ... | ... )
The name of the table to execute the query against.

Where : ( ... | ... )
The criteria to filter the query results.

XPath : ( ... | ... )
The XPath expression to export the data to.
An array of sub-queries to include in the result set.

TargetSchema : string
The name of the schema to execute the query against.

TargetTable : string
The name of the table to execute the query against.

Where : Blocks : Array<...>
An array of nested query blocks.

Condition : ( "And" | "Or" )
The condition to combine this block with the next one. If not specified, defaults to "And".

Criteria : Array<...>
An array of criteria to apply within this block.
The criteria to filter the query results.

XPath : string
The root XPath expression to map the data to.):DataTable

Parameters

Columns : Array<Expression> : ( ... | ... )
An expression for the column, which can be a calculation or transformation.

Name : ( ... | ... )
The name of the column to use in the results. If not specified, the

XPath : ( ... | ... )
An XPath expression to map data to the column.
An array of columns to include in the result set.

Map : (this: DataRow, node: Xml) => void
A custom mapper function to apply to each node in the result set.

MaxLength : number
The maximum number of rows to return. If not set, all rows are returned.

Node : Xml
The root node for the mapping. If not specified, the global

Order : Array<Expression> : string
The expression to use for ordering the results.

Type : ( ... | ... | ... )
The type of ordering (ascending or descending). If not specified, defaults to "Ascending".
An array of order expressions to sort the results.

Parameters : object
Additional parameters to pass to the query.

Start : number
The starting index for the rows to return.

SubQueries : Array<Columns> : ( ... | ... )
An array of columns to include in the result set.

MaxLength : ( ... | ... )
The maximum number of rows to return. If not set, all rows are returned.

Name : ( ... | ... )
The name of the sub-query. The relation name can be used as the name.

Order : ( ... | ... )
An array of order expressions to sort the results.

Parameters : ( ... | ... )
Additional parameters to pass to the query.

Relation : ( ... | ... )
The name of the relation to use for the sub-query.

Start : ( ... | ... )
The starting index for the rows to return.

SubQueries : SubQuery[] | undefined
An array of sub-queries to include in the result set.

TargetSchema : ( ... | ... )
The name of the schema to execute the query against.

TargetTable : ( ... | ... )
The name of the table to execute the query against.

Where : ( ... | ... )
The criteria to filter the query results.

XPath : ( ... | ... )
The XPath expression to export the data to.
An array of sub-queries to include in the result set.

TargetSchema : string
The name of the schema to execute the query against.

TargetTable : string
The name of the table to execute the query against.

Where : Blocks : Array<...>
An array of nested query blocks.

Condition : ( "And" | "Or" )
The condition to combine this block with the next one. If not specified, defaults to "And".

Criteria : Array<...>
An array of criteria to apply within this block.
The criteria to filter the query results.

XPath : string
The root XPath expression to map the data to. options
    Query and XML mapping options. Node must identify the target XML node.

Returns

The current table.

See Also