metadata

Collects a comprehensive Extensible Metadata Platform (XMP) metadata packet for the document.

Any third-party metadata is collected and converted to XMP as follows:

  • All elements are given the namespace http://ns.adobe.com/xfa/promoted-desc/, with the suggested prefix desc:.

  • The value of the name object becomes the object name.

  • A desc:ref property qualifier is added, whose value is an XPath expression pointing back to the parent of the original desc. The order of desc objects within a single parent is not preserved. Multiple desc objects of the same name are not collected. Only the first desc object appears in the output.

  • Content under the desc object is converted as follows:

    Object

    XMP type

    boolean

    Boolean

    date

    Date

    dateTime

    Date

    decimal

    Real

    exData

    external: URI

    embedded: Thumbnail

    float

    Real

    image

    external: URI

    embedded: Thumbnail

    integer

    Integer

    text

    Text

    time

    Date

    When the XDP file is rendered as a PDF file, the collected metadata is written to the PDF file’s XMP packet. Copies of the same metadata continue to exist in the XFA stream inside the PDF file.

Syntax

Reference_Syntax.metadata ( INTEGER param )

Parameters

param

(Optional) An integer representing the serialization format.

  • 0 (RDF) (default)

  • 1 (PlainXMP)

Returns

A valid string representing the XML serialization of the XMP metadata.

Applies to

Model

Object

Form Model

desc

template

Version

XFA 2.5

// Ethnio survey code removed