FormFieldData Class
Form Field Properties.When the object is serialized out as xml, its qualified name is w:ffData.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Wordprocessing.FormFieldData
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(FormFieldName))> _
<ChildElementInfoAttribute(GetType(Enabled))> _
<ChildElementInfoAttribute(GetType(CalculateOnExit))> _
<ChildElementInfoAttribute(GetType(EntryMacro))> _
<ChildElementInfoAttribute(GetType(ExitMacro))> _
<ChildElementInfoAttribute(GetType(HelpText))> _
<ChildElementInfoAttribute(GetType(StatusText))> _
<ChildElementInfoAttribute(GetType(CheckBox))> _
<ChildElementInfoAttribute(GetType(DropDownListFormField))> _
<ChildElementInfoAttribute(GetType(TextInput))> _
Public Class FormFieldData _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As FormFieldData
[ChildElementInfoAttribute(typeof(FormFieldName))]
[ChildElementInfoAttribute(typeof(Enabled))]
[ChildElementInfoAttribute(typeof(CalculateOnExit))]
[ChildElementInfoAttribute(typeof(EntryMacro))]
[ChildElementInfoAttribute(typeof(ExitMacro))]
[ChildElementInfoAttribute(typeof(HelpText))]
[ChildElementInfoAttribute(typeof(StatusText))]
[ChildElementInfoAttribute(typeof(CheckBox))]
[ChildElementInfoAttribute(typeof(DropDownListFormField))]
[ChildElementInfoAttribute(typeof(TextInput))]
public class FormFieldData : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
FormFieldName <w:name>
Enabled <w:enabled>
CalculateOnExit <w:calcOnExit>
EntryMacro <w:entryMacro>
ExitMacro <w:exitMacro>
HelpText <w:helpText>
StatusText <w:statusText>
CheckBox <w:checkBox>
DropDownListFormField <w:ddList>
TextInput <w:textInput>
[ISO/IEC 29500-1 1st Edition]
17.16.12 ffData (Form Field Properties)
This element specifies a set of properties which shall be associated with the parent form field within the document. This form field can be of any of the following types (with the associated field codes in parentheses):
Checkbox (FORMCHECKBOX)
Drop-down List (FORMDROPDOWN)
Text box (FORMTEXT)
If this element is present and the field codes for the document do not specify a form field of one of these types, then the document shall be considered non-conformant.
If this element is omitted, then the properties associated with the parent form field shall be determined based on their default values.
[Example: Consider the following WordprocessingML fragment for a text box form field:
<w:fldSimple w:instr="FORMTEXT"> <w:ffData> <w:name w:val="TextTextBox" /> <w:enabled w:val="false"/> <w:textInput> <w:maxLength w:val="10" /> </w:textInput> </w:ffData> </w:fldSimple>
The ffData element specifies the set of properties for this text box form field; in this example, a form field name of TestTextBox via the name element (§17.16.27), a disabled state via the enabled element (§17.16.14), and a maximum character length of 10 characters via the maxLength element (§17.16.26). end example]
Parent Elements |
|---|
fldChar (§17.16.18) |
Child Elements |
Subclause |
|---|---|
calcOnExit (Recalculate Fields When Current Field Is Modified) |
§17.16.6 |
checkBox (Checkbox Form Field Properties) |
§17.16.7 |
ddList (Drop-Down List Form Field Properties) |
§17.16.9 |
enabled (Form Field Enabled) |
§17.16.14 |
entryMacro (Script Function to Execute on Form Field Entry) |
§17.16.15 |
exitMacro (Script Function to Execute on Form Field Exit) |
§17.16.16 |
helpText (Associated Help Text) |
§17.16.21 |
label (Form Field Label) |
§17.16.24 |
name (Form Field Name) |
§17.16.27 |
statusText (Associated Status Text) |
§17.16.31 |
tabIndex (Form Field Navigation Order Index) |
§17.16.32 |
textInput (Text Box Form Field Properties) |
§17.16.33 |
[Note: The W3C XML Schema definition of this element’s content model (CT_FFData) 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.