EndnoteDocumentWideProperties Class

Document-Wide Endnote Properties.When the object is serialized out as xml, its qualified name is w:endnotePr.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(EndnoteSpecialReference))> _
<ChildElementInfoAttribute(GetType(NumberingFormat))> _
<ChildElementInfoAttribute(GetType(NumberingRestart))> _
<ChildElementInfoAttribute(GetType(EndnotePosition))> _
<ChildElementInfoAttribute(GetType(NumberingStart))> _
Public Class EndnoteDocumentWideProperties _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As EndnoteDocumentWideProperties

[ChildElementInfoAttribute(typeof(EndnoteSpecialReference))]
[ChildElementInfoAttribute(typeof(NumberingFormat))]
[ChildElementInfoAttribute(typeof(NumberingRestart))]
[ChildElementInfoAttribute(typeof(EndnotePosition))]
[ChildElementInfoAttribute(typeof(NumberingStart))]
public class EndnoteDocumentWideProperties : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

• EndnotePosition <w:pos>

• NumberingFormat <w:numFmt>

• NumberingStart <w:numStart>

• NumberingRestart <w:numRestart>

• EndnoteSpecialReference <w:endnote>

[ISO/IEC 29500-1 1st Edition]

17.11.4 endnotePr (Document-Wide Endnote Properties)

This element specifies the endnote properties for the current document. Each of these properties are stored as a child element within the endnotePr element.

These properties can be overridden for a specific section via the section-wide endnotePr element (§17.11.5).

[Example: Consider the following document with two sections, where the endnotes for each section appears at the end of that section and use lower case roman numerals:

Since both sections are identical, the endnote properties are specified as document-wide level properties (this is not necessary but is most efficient) as follows:

<w:settings>
  …  
  <w:endnotePr>
    <w:numFmt w:val="lowerRoman" />
    <w:pos w:val="sectEnd"/>
  </w:endnotePr>
  … 
</w:settings>

Note that the pos element could have been omitted since it is using its default value. end example]

Parent Elements
settings (§17.15.1.78)

Child Elements	Subclause
endnote (Special Endnote List)	§17.11.3
numFmt (Endnote Numbering Format)	§17.11.17
numRestart (Footnote and Endnote Numbering Restart Location)	§17.11.19
numStart (Footnote and Endnote Numbering Starting Value)	§17.11.20
pos (Endnote Placement)	§17.11.22

[Note: The W3C XML Schema definition of this element’s content model (CT_EdnDocProps) 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

EndnoteDocumentWideProperties Members

DocumentFormat.OpenXml.Wordprocessing Namespace