ParameterDef

This topic is not current. For the most current information, see the Print Schema Specification.

A ParameterDef element defines the valid characteristics of parameter input. The value is entered by means of a ParameterInit element.

Element Tag

<ParameterDef>

XML Attributes

The following table lists the XML attributes that may be pertain to this element.

XML Attribute Details
name
Defines a unique name for the parameter in the context of the current document. Duplicate ParameterDef name attributes render the PrintCapabilities document invalid.

For more information, please see XML Attributes section.

Element Information

The following table lists the elements that may be parents of this element, the elements that may be children of this element, and any restrictions on the element itself.

Category Details
Parent elements
PrintCapabilities
Child elements
Property (one or more)
The following standard Property elements must appear as the content of a ParameterDef element.
  • DataType
  • DefaultValue
  • Mandatory
  • MaxLength or MaxValue
  • MinLength or MinValue
  • Multiple*
  • UnitType
This element
No character data is permitted.
Duplicate child siblings are not permitted.

*Required when DataType is integer or decimal. Optional when DataType is string.

Configuration Dependencies

A ParameterDef and its content to any nesting level may not have any configuration dependencies.

Example

The following example sets all of the required Property elements for this parameter. The example in ParameterInit demonstrates how to initialize this parameter.

<psf:ParameterDef name="psk:PageMediaSizeMediaSizeHeight">
  <psf:Property name="psf:DataType">
    <psf:Value xsi:type="xs:string">xs:integer</psf:Value>
  </psf:Property>
  <psf:Property name="psf:UnitType">
    <psf:Value xsi:type="xs:string">microns</psf:Value>
  </psf:Property>
  <psf:Property name="psf:Multiple">
    <psf:Value xsi:type="xs:integer">1</psf:Value>
  </psf:Property>
  <psf:Property name="psf:MaxValue">
    <psf:Value xsi:type="xs:integer">594106</psf:Value>
  </psf:Property>
  <psf:Property name="psf:MinValue">
    <psf:Value xsi:type="xs:integer">152400</psf:Value>
  </psf:Property>
  <psf:Property name="psf:DefaultValue">
    <psf:Value xsi:type="xs:integer">152400</psf:Value>
  </psf:Property>
  <psf:Property name="psf:Mandatory">
    <psf:Value xsi:type="xs:string">psk:Optional</psf:Value>
  </psf:Property>
</psf:ParameterDef>

Print Schema Specification