2.2.2 Field

This element is used to describe the promoted properties for the form. The type of Field element is PropertyPromotionFieldType.

Parent Elements

Fields

Attributes:

Aggregation:  This specifies the way that multiple values from a form are reduced to a single value. If the XPath expression, as specified in [XPATH], given in the Node attribute is evaluated against the form and produces either a collection of values or a rich text box control, as specified in [MS-IPFF2], section 2.3.1.13, then this attribute MUST be set. Otherwise, this attribute MUST NOT be present.

DisplayName: If the Type attribute equals "Signature", "ProgID", or "Link", then this MUST NOT be specified. Otherwise, this MUST be set to the display name that is used to identify this Field.

Format: This MUST be set to "DateOnly" when the XSD data type of the field in the form given by the Node attribute is "xsd:date". Otherwise, this MUST NOT be present.

Hidden: This specifies whether this Field is completely hidden from the user interface. "TRUE" or "true" hides this Field completely, and "FALSE" or "false" allows it to be displayed.

MaxLength: This defines the maximum length of the content in bytes for the data resulting from this Field entry. This MUST NOT be specified.

Name: Specifies a unique name for the Field. This MUST be set for all Field elements, except those whose Type attribute is "ProgID", "Link" or "Signature". For those elements, this attribute MUST NOT be present.

Node: Specifies the XPath expression for the field in the form to promote. When the Type attribute is "ProgID" or "Link", this attribute MUST NOT be specified. For all other elements, this MUST be specified.

PIAttribute: Specifies which attribute of the XML processing instruction given by the PITarget attribute in the form file to process. If the PIAttribute attribute is specified, then the PITarget attribute MUST be specified and the Node attribute MUST NOT be specified.

PITarget: Specifies which XML processing instruction on the form files to process. If the PITarget attribute is specified, then the PIAttribute attribute MUST be set and the Node attribute MUST NOT be present.

ReadOnly: Specifies if the value can be edited and saved to the document library. This MUST be set to "TRUE" or "true" for all elements, except those whose Type attribute equals "Link". In that case, the ReadOnly attribute MUST NOT be present.

Sortable: Specifies whether the resulting data from this Field can be sorted or not. It MUST be set to "FALSE" if the Type attribute equals "Note". Otherwise, this attribute MUST NOT be specified.

Type: Specifies the data type of the Field.

Viewable: Specifies whether this Field is added to the default view. "TRUE" or "true" adds this Field to the default view, while "FALSE" or "false" does not. If the Type attribute is "ProgID", "Link" or "Signature", it MUST be set to "FALSE". Otherwise, it MUST NOT be specified.

XName: This MUST have the same value as the Name attribute.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

 <xs:element name="Field" type="pp:PropertyPromotionFieldType"/>
 <xs:complexType name="PropertyPromotionFieldType">
   <xs:attribute name="Type" type="pp:FieldType" use="optional" default="Text"/>
   <xs:attribute name="ReadOnly" type="pp:TrueFalse" use="optional" default="FALSE"/>
   <xs:attribute name="Hidden" type="pp:TrueFalse" use="optional" default="FALSE"/>
   <xs:attribute name="Viewable" type="pp:TrueFalse" use="optional" default="TRUE"/>
   <xs:attribute name="PITarget" type="xs:string" use="optional"/>
   <xs:attribute name="PIAttribute" type="xs:string" use="optional"/>
   <xs:attribute name="Node" type="xs:string" use="optional"/>
   <xs:attribute name="DisplayName" type="xs:string" use="optional"/>
   <xs:attribute name="Name" type="xs:string" use="optional"/>
   <xs:attribute name="XName" type="xs:string" use="optional"/>
   <xs:attribute name="Aggregation" type="pp:Aggregation" use="optional"/>
   <xs:attribute name="Sortable" type="pp:TrueFalse" use="optional" default="TRUE"/>
   <xs:attribute name="Format" type="xs:string" use="optional"/>
   <xs:attribute name="MaxLength" type="xs:integer" use="optional"/>
 </xs:complexType>