transmitoptionrefs

Specifies individual options that are filtered for a particular transmission.

Filtering option references means keeping or omitting individual options, rather than all options of a particular type (see transmitoptions).

Syntax

   <transmitoptionrefs>
      <filter>transmit flag</filter>
      <optionref>option reference₁</optionref>
      ...
      <optionref>option reference_n</optionref>
   </transmitoptionrefs>

Note: There may be any number of option reference entries.

Table 1. transitoptionrefs parameters
Parameter	Type	Description
transmit flag	keep	include options in the option reference list with the transmission; omit those not in the list
	omit	omit options in the option reference list from the transmission; include those not in the list
option reference	string	identifies the option to be filtered

Available in

action, button, cell

Examples

This sample shows how you would use transmitoptionrefs in conjunction with transmitoptions: although all options that are values are omitted, the value in the “NameField” on “page1” will be kept.

   <transmitoptions>
      <filter>omit</filter>
      <optiontype>value</optiontype>
   </transmitoptions>
   <transmitoptionrefs>
      <filter>keep</filter>
      <optionref>page1.NameField.value</optionref>
   </transmitoptionrefs>

This sample shows how you would use transmitoptionrefs in conjunction with transmititemrefs: although the item called “MgrSignButton” on “page1” is omitted, its signer option is kept

   <transmititemrefs>
      <filter>omit</filter>
      <itemref>MgrSignButton</itemref>
   </transmititemrefs>
   <transmitoptionrefs>
      <filter>keep</filter>
      <optionref>page1.MgrSignButton.signature</optionref>
   </transmitoptionrefs>

Usage details

Default: keep all options (omit nothing), unless the containing item is omitted.
Element tag names can be specified with or without a namespace prefix. The default namespace URI is the XFDL namespace URI if no namespace prefix is given. If a namespace prefix is given, then the namespace URI to which the prefix is bound is used in determining whether or not each element matches the given filter.
For example, the filter component <optionref>page1.field1.value</optionref> could equivalently be written <optionref>page1.field1.xfdl:value</optionref> if the prefix xfdl is mapped to the XFDL namespace URI.
Other filters may take precedence over the transmitoptionrefs option. Refer to Order of precedence of filters for more information on the order of precedence of filters.