TextBoxFormFieldType class

Office 2013 and later

Text Box Form Field Type. When the object is serialized out as xml, its qualified name is w:type.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.TextBoxFormFieldType

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

public class TextBoxFormFieldType : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

type (Text Box Form Field Type)

This element specifies the type of the contents of the current text box form field. This element shall not be used to prevent the successful loading of any contents in the field, but shall be used to parse the formatting specified in the format element (§17.16.20) and should be used to prevent the addition of illegal content when its contents are edited by an application.

If this element is omitted, then its default value shall be assumed to be regular.

[Example: Consider the following WordprocessingML fragment for the properties of a text box form field:

<w:ffData>
  <w:textInput>
    <w:type w:val="number" />
    <w:maxLength w:val="4" />
    <w:format w:val="0.00" />
  </w:textInput>
</w:ffData>

The type element specifies that the contents of this form field should be handled as a number by an application. end example]

Parent Elements

textInput (§17.16.33)

Attributes

Description

val (Text Box Form Field Type Values)

Specifies the type of the text box form field, as defined by the simple type referenced below.

[Example: Consider the following WordprocessingML fragment for the properties of a text box form field:

<w:ffData>
  <w:textInput>
    <w:type w:val="currentDate" />
  </w:textInput>
</w:ffData>

The val attribute value of currentDate specifies that the contents of this form field should be the current date when the field is updated. end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_FFTextType) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: