Share via

2.2.100 property

  • Article

The property element specifies a property of a file that is part of the form template. Each file property MUST be specified by an instance of this element.

Parent Elements

fileProperties

Attributes:

name:  This attribute specifies the name of the file property and MUST be set to one of the following acceptable values. Each property element MUST have a unique name within the set of file properties specified by each fileProperties element. The corresponding acceptable values of the value attribute are listed for each possible value of the name attribute:

  • componentId: The use of this value specifies that the corresponding value attribute value is an identifier that uniquely identifies the form view file. A form view file, as specified in section 2.4, MUST have a file property with this name. The value attribute value MUST be set to a positive integer that is unique among all form view file properties in the form template.

  • dataObject: The use of this value specifies that the parent file element represents an XML schema document used to validate the secondary data source. The value attribute value MUST be set to the value of the name attribute of the file element of the file that is used as a secondary data source.

  • editability: The use of this value specifies that the corresponding value attribute value is the degree to which the XML schema document is editable. The file specifying the XML schema of the form file MUST have a file property with this name. The value attribute value MUST be set to one of the following values:

    • full: This value specifies that the XML schema document MUST be fully editable.

    • partial – This value specifies that the XML schema document MUST be locked for editing. XML schema documents for secondary data sources MUST have an editability property set to this value.

  • fileType: The use of this value specifies that the corresponding value attribute value specifies the file type. The value attribute value MUST be set to one of the following values:

    • pdb: This value specifies that the file MUST be a symbol file. A form template containing business objects MAY have any number of files of this type.

    • refAssembly – This value specifies that the file MUST be a form code assembly other than the main form code assembly. A form template containing business objects MAY have any number of files of this type.

    • rootAssembly: This value specifies that the file refers to the main assembly of the form (1) code. A form template containing business objects MUST have exactly one file property with a "rootAssembly" value.

    • resource: This value specifies that the file MUST be used as a secondary data source.

    • sampleData: This value specifies that the file MUST be a file containing sample data for the form (1).

  • lang: The use of this value specifies that the corresponding value attribute value MUST be the language of the form file. A form view file, as specified in section 2.4, MUST have a file property with this name. The value attribute value MUST be set to the language code identifier (LCID), as specified in [MS-LCID], corresponding to the user locale.

  • namespace: The use of this value specifies that the corresponding value attribute value MUST be the namespace of the XML schema document. An XML schema document MUST have a file property with this name. The value attribute value MUST be set to the namespace of the XML schema document.

  • rootElement: The use of this value specifies that the corresponding value attribute value MUST be the root element of the XML schema document. An XML schema document MUST have a file property with this name. The value attribute value MUST be set to root element of the XML schema document.

  • useOnDemandAlgorithm: The use of this value MUST be ignored.

  • xmlToEditName: The use of this value specifies that the corresponding value attribute value MUST be equal to the value of the value attribute for the componentId file property. A form view file, as specified in section 2.4, MUST have a file property with this name. The value attribute value MUST be set to a positive integer.

type: This attribute MUST be set to "string".

value: This attribute specifies the value of the file property and MUST be set to one of the corresponding acceptable values specified in the name attribute.

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

 <xsd:element name="property">
   <xsd:complexType>
     <xsd:attribute name="name" type="xsd:string" use="required"/>
     <xsd:attribute name="value" type="xsd:string" use="required"/>
     <xsd:attribute name="type" type="xsd:QName" use="required"/>
   </xsd:complexType>
 </xsd:element>