signoptions

Specifies which types of options are filtered for a particular signature.

Filtering options means keeping or omitting all options of a particular type, rather than specific options (see signoptionrefs).

Syntax

   <signoptions>
      <filter>option filter</filter>
      <optiontype>option type1</optiontype>
      ...
      <optiontype>option typen</optiontype>
   </signoptions>
Note: There may be any number of option type entries.
Table 1. signoptions parameters
Parameter Type Description
option filter keep include types of options in the option type list with the signature; omit those not in the list
  omit omit types of options in the option type list from the signature; include those not in the list
option type string specifies the type (element tag name) of options to be filtered

Available in

button, signature

Example

This example shows a signoptions setting that omits two types of options from the signature.

   <signoptions>
      <filter>omit</filter>
      <optiontype>url</optiontype>
      <optiontype>printsettings</optiontype>
   </signoptions>

Usage details

  1. Default: keep all options (omit nothing), unless the containing item is omitted.
  2. One signoptions setting must always be specified in the following way:
       <signoptions>
          <filter>omit</filter>
          <optiontype>triggeritem</optiontype>
          <optiontype>coordinates</optiontype>
       </signoptions>
    
    • This setting ensures that the signature will not be broken due to an alteration to the form.
    • If the this option must be used as a keep filter, then consider omitting the global.global.triggeritem and the coordinates of image buttons using a signoptionrefs filter.
  3. 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 component.

    For example, the filter component <optiontype>triggeritem</optiontype> could be equivalently written as <optiontype>xfdl:triggeritem</optiontype> if the prefix xfdl is mapped to the XFDL namespace URI.

  4. Other filters may take precedence over the signoptions option. Refer to Order of precedence of filters for more information on the order of precedence of filters.