XML SET OPTIONS
XML SET OPTIONS ( elementRef | document ; selector ; value {; selector2 ; value2 ; ... ; selectorN ; valueN} )
| Parameter | Type | Description | |
|---|---|---|---|
| elementRef | document | Text | → | XML root element reference or Reference of open document |
| selector | Integer | → | Option to set |
| value | Integer | → | Value of option |
Description
The XML SET OPTIONS command is used to modify the value of one or more XML options for the structure passed in the first parameter.
This command applies the XML structures of the "tree" type (DOM) or of the "document" type (SAX). In the first parameter, you can pass either a root element reference (elementRef), or the reference of an open SAX document (document).
Pass the option to be modified in selector and the new value of the option in value. You can pass as many selector/value pairs as you want. You must use the constants described below, placed in the "XML" theme.
- The following options are only used in the direction 4D to XML (they have no effect on the reading of XML values in 4D) by these commands:
| Constant | Type | Value | Comment |
|---|---|---|---|
| XML binary encoding | Integer | 5 | Specifies the way binary data will be converted. Possible values: XML Base64 (default value): binary data are simply converted to Base64XML data URI scheme: binary data are converted to Base64 and the "data:;base64" header is added. This format mainly allows a browser to automatically decode a picture, and is also required for the insertion of pictures. For more information, see http://en.wikipedia.org/wiki/Data%5FURI%5Fscheme. |
| XML date encoding | Integer | 2 | Specifies the way 4D dates will be converted. For example, !01/01/2003! in the Paris time zone. Possible values: XML ISO (default value): use of the format xs:datetime without indication of time zone. Result: "2003-01-01". The time part, if it is present in the 4D value (via SQL) is lost. XML local: use of the format xs:date with indication of time zone. Result: "2003-01-01 +01:00". The time part, if it is present in the 4D value (via SQL) is lost. XML datetime local: use of the format xs:dateTime (ISO 8601). Indication of time zone. This format allows the time part to be kept, if it is present in the 4D value (via SQL). Result: " |
| XML indentation | Integer | 4 | Specifies the indentation of the XML document. Possible values: XML with indentation (default value): the document is indented.XML no indentation: the document is not indented; its contents are placed in a single line. |
| XML picture encoding | Integer | 6 | Specifies the way pictures must be converted (before encoding in Base64). Possible values: XML convert to PNG (default value): pictures are converted to PNG before being encoded in Base64.XML native codec: pictures are converted in their first native storage CODEC before being encoded in Base64. You must use these options to encode SVG pictures (see example for the XML SET OPTIONS command). |
| XML string encoding | Integer | 1 | Specifies the way 4D strings are converted to element values. It does not concern the conversion to attributes for which XML imposes the use of escape characters. Possible values: XML with escaping (default value): conversion of 4D strings to XML element values with replacement of characters. The Text type data are automatically parsed so that forbidden characters (<&>’) are replaced by XML entities (&<> '").XML raw data: 4D strings are sent as raw data; 4D does not carry out encoding or parsing. 4D values are converted if possible to XML fragments and inserted as a child of the target element. If a value cannot be considered as an XML fragment, it is inserted as raw data into a new CDATA node. |
| XML time encoding | Integer | 3 | Specifies the way 4D times are converted. For example, ?02/00/46? (Paris time). The encoding differs depending on whether you want to express a time or a duration. Possible values for times: XML datetime UTC: time expressed in UTC (Universal Time Coordinated). Note that conversion to UTC is automatic. Result: " XML seconds: number of seconds since midnight; no modification of the value since it expresses a duration. Result: " |
| Notes: |
- The XML local and XML datetime local values do not provide dates expressed in UTC (Universal Time Coordinated); they are converted without modification but indicating the time difference. These formats are useful in the case of successive and reciprocal conversions (round tripping).
- The XML UTC and XML datetime UTC values are equivalent to the previous from the formatting viewpoint, but are expressed in UTC. These formats should be given priority to ensure interoperability. The values are not modified.
- The following options allow you to modify some default xml parser features:
| Constant | Type | Value | Comment |
|---|---|---|---|
| XML BOM | Integer | 9 | Specifies if XML documents include BOM. Possible values: XML default (default): use current database settings. By default, BOM is not included - except in databases/projects created with 4D versions up to v19.x, where BOM is included. See also Compatibility settings. XML enabled: include BOM XML disabled: do not include BOM |
| XML DOM case sensitivity | Integer | 8 | Specifies the case sensitivity regarding element names for DOM Get XML element and DOM Count XML elements commands. Possible values: XML case sensitive (default value): commands are case sensitive.XML case insensitive: commands are not case sensitive. |
| XML external entity resolution | Integer | 7 | Controls whether external entities are resolved in XML documents. For security reasons, by default both DOM and SAX 4D XML parsers do not allow external entity resolution. Note that the scope of this selector is the calling process (if preemptive) or all cooperative processes (if called from a cooperative process). It globally applies to all XML documents (the first parameter is ignored, you can pass an empty string). Possible values: XML enabled: allow external entity resolution in XML documentsXML disabled (default value): disallow external entity resolution (an external entity declaration generates a parser error) |
| XML line ending | Integer | 10 | End-of-line characters in written XML documents. Possible values: XML default (default): use current database settings. Default is LF on macOS and CRLF on Windows. However on macOS, in databases/projects created with 4D versions up to v19.x, default is CR for DOM and CRLF for SAX. See also Compatibility settings. XML LF: Use LF (line feed) XML CR: Use CR (carriage return) XML CRLF: Use CR+LF |
Example
Insertion of an SVG picture:
XML SET OPTIONS($pictElemRef;XML binary encoding;XML data URI scheme)
XML SET OPTIONS($pictElemRef;XML picture encoding;XML native codec)
DOM SET XML ATTRIBUTE($pictElemRef;"xlink:href";PictVar)
See also
DOM SET XML ATTRIBUTE
DOM SET XML DECLARATION
DOM SET XML ELEMENT VALUE
SAX ADD XML ELEMENT VALUE
XML GET OPTIONS
Properties
| Command number | 1090 |
| Thread safe | ✓ |