TextInput Class

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

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Wordprocessing.TextInput

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(MaxLength))> _
<ChildElementInfoAttribute(GetType(Format))> _
<ChildElementInfoAttribute(GetType(DefaultTextBoxFormFieldString))> _
<ChildElementInfoAttribute(GetType(TextBoxFormFieldType))> _
Public Class TextInput _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As TextInput

[ChildElementInfoAttribute(typeof(MaxLength))]
[ChildElementInfoAttribute(typeof(Format))]
[ChildElementInfoAttribute(typeof(DefaultTextBoxFormFieldString))]
[ChildElementInfoAttribute(typeof(TextBoxFormFieldType))]
public class TextInput : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

• TextBoxFormFieldType <w:type>

• DefaultTextBoxFormFieldString <w:default>

• MaxLength <w:maxLength>

• Format <w:format>

[ISO/IEC 29500-1 1st Edition]

17.16.28 textInput (Text Box Form Field Properties)

This element specifies a set of properties which shall be associated with the parent FORMTEXT text box form field (§17.16.5.22) within the document.

If the parent form field is not a text box (i.e. its field code does not have a value of FORMTEXT), then these properties can be ignored.

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

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

The textInput element specifies that it contains a set of properties for the parent text box form field. In this case, these properties specify that the drop-down list must contain no more than four characters via the maxLength element (§17.16.26), and that its contents must contain a number via the type element (§17.16.34). end example]

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

© ISO/IEC29500: 2008.

Thread Safety

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

See Also

Reference

TextInput Members

DocumentFormat.OpenXml.Wordprocessing Namespace