NumberingFormat Class

Footnote Numbering Format.When the object is serialized out as xml, its qualified name is w:numFmt.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.NumberingFormat

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

Syntax

'Declaration
Public Class NumberingFormat _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As NumberingFormat

public class NumberingFormat : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.9.18 numFmt (Numbering Format)

This element specifies the number format which shall be used to display all numbering at this level in the numbering definition. This information is used to replace the level text string %x, where x is a particular one-based level index, with the appropriate value. This value shall be calculated by counting the number of paragraphs at this level since the last restart using the numbering system defined in the val attribute.

When a document has a custom number format specified by the format attribute, it shall use the referenced number format. If the referenced number format cannot be resolved as a number format the consumer shall use the number format specified by the value of the val attribute. If the corresponding value of the val attribute is custom, the result is implementation-defined.

If this element is omitted, the level shall be assumed to be of level type decimal.

[Example: Consider the following WordprocessingML fragment for a numbering level in a numbering definition:

<w:lvl w:ilvl="2">
  <w:start w:val="1" />
  <w:numFmt w:val="lowerRoman" />
  <w:lvlRestart w:val="0" />
  <w:lvlText w:val="%3)" />
  <w:lvlJc w:val="left" />
  <w:pPr>
    <w:ind w:left="1080" w:hanging="360" />
  </w:pPr>
  <w:rPr>
    <w:rFonts w:hint="default" />
  </w:rPr>
</w:lvl>

A numFmt value of lowerLetter indicates that a consumer must use lowercase letters for all numbering of this level: a,b,c… end example]

Parent Elements
lvl (§17.9.6); lvl (§17.9.7)

Attributes	Description
format (Custom Defined Number Format)	Specifies a custom number format using the syntax defined by the XSLT 1.0 format attribute. This format shall be used for all numbering in the parent object. [Example: A value of ア indicates that a consumer must use Katakana numbering. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).
val (Numbering Format Type)	Specifies the number format that shall be used for all numbering in the parent object. [Example: A value of lowerLetter indicates that a consumer must use lowercase letters for each number in this grouping: a,b,c… end example] The possible values for this attribute are defined by the ST_NumberFormat simple type (§17.18.59).

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

[ISO/IEC 29500-1 1st Edition]

17.11.17 numFmt (Endnote Numbering Format)

This element specifies the numbering format which shall be used to determine the footnote or endnote reference mark value for all automatically numbered footnote and endnote reference marks (those without the suppressRef attribute set).

If this element is omitted, then the numbering format shall be assume to be decimal.

[Example: Consider the following footnote reference with the number format set to upper case letters:

This footnote numbering format is specified by the following WordprocessingML:

<w:footnotePr>
<w:numFmt w:val="upperLetter" />
</w:footnotePr>

end example]

Parent Elements
endnotePr (§17.11.4); endnotePr (§17.11.5)

Attributes	Description
format (Custom Defined Number Format)	Specifies a custom number format using the syntax defined by the XSLT 1.0 format attribute. This format shall be used for all numbering in the parent object. [Example: A value of ア indicates that a consumer must use Katakana numbering. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).
val (Numbering Format Type)	Specifies the number format that shall be used for all numbering in the parent object. [Example: A value of lowerLetter indicates that a consumer must use lowercase letters for each number in this grouping: a,b,c… end example] The possible values for this attribute are defined by the ST_NumberFormat simple type (§17.18.59).

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

[ISO/IEC 29500-1 1st Edition]

17.11.18 numFmt (Footnote Numbering Format)

This element specifies the numbering format which shall be used to determine the footnote or endnote reference mark value for all automatically numbered footnote and endnote reference marks (those without the suppressRef attribute set).

If this element is omitted, then the numbering format shall be assume to be decimal.

[Example: Consider the following footnote reference with the number format set to upper case letters:

This footnote numbering format is specified by the following WordprocessingML:

<w:footnotePr>
<w:numFmt w:val="upperLetter" />
</w:footnotePr>

end example]

Parent Elements
footnotePr (§17.11.12); footnotePr (§17.11.11)

Attributes	Description
format (Custom Defined Number Format)	Specifies a custom number format using the syntax defined by the XSLT 1.0 format attribute. This format shall be used for all numbering in the parent object. [Example: A value of ア indicates that a consumer must use Katakana numbering. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).
val (Numbering Format Type)	Specifies the number format that shall be used for all numbering in the parent object. [Example: A value of lowerLetter indicates that a consumer must use lowercase letters for each number in this grouping: a,b,c… end example] The possible values for this attribute are defined by the ST_NumberFormat simple type (§17.18.59).

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

NumberingFormat Members

DocumentFormat.OpenXml.Wordprocessing Namespace