FieldData Class

Article
08/02/2013

Custom Field Data.When the object is serialized out as xml, its qualified name is w:fldData.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.OpenXmlLeafTextElement
        DocumentFormat.OpenXml.Wordprocessing.FieldData

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

Syntax

'Declaration
Public Class FieldData _
    Inherits OpenXmlLeafTextElement
'Usage
Dim instance As FieldData

public class FieldData : OpenXmlLeafTextElement

Remarks

[ISO/IEC 29500-1 1st Edition]

9.9.1 fldData (Custom Field Data)

This element specifies custom field data which shall be associated with the parent field. No information or semantics are applied to the contents of this data by ISO/IEC 29500, and therefore this field can be used as desired to store additional application-defined data with the field. However, applications should not lose the contents of this custom data if they do not understand or utilize it (i.e. the information should continue to be saved with the file).

If this element is omitted, then no custom field data is stored with the parent field. If the type attribute of the current field character is not start, then his setting can be ignored.

[Example: Consider the following WordprocessingML fragment for a complex field:

<w:r>
<w:fldChar w:fldCharType="start">
<w:fldData xml:space="preserve">///3645ERKJHE</w:fldData>
</w:fldChar>
</w:r>
<w:r>
<w:instrText>PRIVATE</w:instrText>
</w:r>
<w:r>
<w:fldChar w:fldCharType="separate" />
</w:r>
…

The fldData element contains custom data stored with this PRIVATE field (Part 1, §17.16.5.48), the contents of which are determined by a hosting application. end example]

Parent Elements
fldChar (Part 1, §17.16.18)

Attributes	Description
xml:space (Content Contains Significant Whitespace) Namespace: http://www.w3.org/XML/1998/namespace	Specifies how white space should be handled for the contents of this element using the W3C space preservation rules. [Example: Consider the following run contained within a WordprocessingML document: <w:r> <w:t> significant whitespace </w:t> </w:r> Although there are three spaces on each side of the text content in the run, that whitespace has not been specifically marked as significant, therefore it is subject to the space preservation rules currently specified in that run's scope. end example] The possible values for this attribute are defined by §2.10 of the XML 1.0 specification.

xml:space (Content Contains Significant Whitespace)

Namespace: http://www.w3.org/XML/1998/namespace

Specifies how white space should be handled for the contents of this element using the W3C space preservation rules.

[Example: Consider the following run contained within a WordprocessingML document:

<w:r>
<w:t>   significant whitespace   </w:t>
</w:r>

Although there are three spaces on each side of the text content in the run, that whitespace has not been specifically marked as significant, therefore it is subject to the space preservation rules currently specified in that run's scope. end example]

The possible values for this attribute are defined by §2.10 of the XML 1.0 specification.

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

[ISO/IEC 29500-1 1st Edition]

9.9.2 fldData (Custom Field Data)

If this element is omitted, then no custom field data is stored with the parent field.

[Example: Consider the following WordprocessingML fragment for a simple field:

<w:fldSimple w:instr="PRIVATE">
<w:fldData xml:space="preserve">///3645ERKJHE</w:fldData>
</w:fldSimple>