<helpText> (Associated Help Text)

This element specifies optional help text which shall be associated with the parent form field. The method or user interface by which this help text may be surfaced is not defined by this Office Open XML Standard.

If this element is omitted, then no help text shall be associated with the current form field.

example: 
<w:fldSimple w:instr="FORMDROPDOWN">
  <w:ffData>
    <w:helpText w:type="text" w:val="Example help text." />
    <w:ddList>
      …
    </w:ddList>
  </w:ffData>
</w:fldSimple>

The <helpText> element specifies the help text for the parent form field - in this case, literal help text consisting of the string Example help text. ]

Parent Elements

<ffData> (§2.16.17)

Attributes

Description

<type> (Help Text Type)

Specifies the type of help text which is specified by this element, defined by the simple type below.

If this attribute is omitted, then its value shall be assumed to be text.

<w:ffData>
  <w:helpText w:type="text" w:val="Example help text." />
</w:ffData>

The <type> attribute has a value of text, which specifies that the text in the @val attribute is the literal help text for this form field. ]

The possible values for this attribute are defined by the ST_InfoTextType simple type (§2.18.49).

<val> (Help Text Value)

Specifies the help text for the current form field. Based on the value of the @type attribute, the contents of this field shall be interpreted as follows:

  • When the @type attribute value is text, contains the literal help text for the form field.

  • When the @type attribute value is autoText, contains the name of a glossary document entry which contains the help text for the form field.

<w:ffData>
  <w:helpText w:type="autoText" w:val="HelpText" />
</w:ffData>

The text in the @val attribute is the name of a glossary document entry containing the help text for this form field, since the <type> attribute has a value of autoText. ]

The possible values for this attribute are defined by the ST_FFHelpTextVal simple type (§2.18.29).

The following XML Schema fragment defines the contents of this element:

<complexType name="CT_FFHelpText">
	<attribute name="type" type="ST_InfoTextType"/>
	<attribute name="val" type="ST_FFHelpTextVal"/>
</complexType>