SaveFormsData Class

Only Save Form Field Content.When the object is serialized out as xml, its qualified name is w:saveFormsData.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffType
        DocumentFormat.OpenXml.Wordprocessing.SaveFormsData

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

Syntax

'Declaration
Public Class SaveFormsData _
    Inherits OnOffType
'Usage
Dim instance As SaveFormsData
public class SaveFormsData : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.73 saveFormsData (Only Save Form Field Content)

This element specifies that saving the contents of this document shall only save the contents of WordprocessingML form fields defined using the FORMTEXT, FORMCHECKBOX, and FORMDROPDOWN field codes in a comma-delimited text format which does not conform to ISO/IEC 29500 (i.e. it is a one-way export from a WordprocessingML document).

[Rationale: This setting is typically used to allow duplication of paper forms in electronic WordprocessingML document form, allowing the resulting content to be extracted as a comma-delimited text file. end rationale]

If this element is omitted, then the contents of the entire document (not just form fields) should be saved according to the definition of WordprocessingML in ISO/IEC 29500.

[Example: Consider a WordprocessingML document which has form fields in the top right and bottom left corners of the first page, as follows (with the text box form fields shaded in grey):

DocumentFormat.OpenXml.Wordprocessing.SaveFormsDat

If the only content which must be saved are the form fields' contents, this requirement is specified using the following WordprocessingML in the document settings:

<w:saveFormsData w:val="true" />

The saveFormsData element's val attribute as a value of true, specifying that only form field data must be saved, resulting in output as follows in a text file:

one,two

end example]

Parent Elements

settings (§17.15.1.78)

This element’s content model is defined by the common boolean property definition in §17.17.4.

© 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

SaveFormsData Members

DocumentFormat.OpenXml.Wordprocessing Namespace