NumberingInstance class

Office 2013 and later

Numbering Definition Instance. When the object is serialized out as xml, its qualified name is w:num.

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

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

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

[ISO/IEC 29500-1 1st Edition]

num (Numbering Definition Instance)

This element specifies a unique instance of numbering information that can be referenced by zero or more paragraphs within the parent WordprocessingML document.

This instance requires the referencing of a base abstract numbering definition through the abstractNumId child element (§17.9.2). This element also can be used to specify a set of optional overrides applied to zero or more levels from the abstract numbering definition inherited by this instance second though the optional lvlOverride child elements (§17.9.9).

[Example: Consider the WordprocessingML for a document with four numbering definition instances, two of which reference the same underlying abstract numbering definition:

<w:numbering>
  …  <w:num w:numId="2">
    <w:abstractNumId w:val="0" />
  </w:num>
  <w:num w:numId="3">
    <w:abstractNumId w:val="1" />
  </w:num>
  <w:num w:numId="4">
    <w:abstractNumId w:val="4" />
  </w:num>
  <w:num w:numId="5">
    <w:abstractNumId w:val="4" />
  </w:num>
</w:numbering>

As shown above, the first two numbering definition instances reference abstractNumId values of 0 and 1 respectively, and the last two both reference the abstract numbering definition with an abstractNumId of 4. end example]

[Example: Consider a numbering definition instance which inherits its information from the abstract numbering definition with abstractNumId of 4, but wishes to use a different set of properties for level 0 of the numbering definition. The resulting WordprocessingML would look like:

<w:num w:numId="6">
  <w:abstractNumId w:val="4" />
  <w:lvlOverride w:ilvl="0">
    <w:lvl w:ilvl="0">
      <w:start w:val="4" />
      <w:lvlText w:val="%1)" />
      <w:lvlJc w:val="left" />
      <w:pPr>
        <w:ind w:left="360" w:hanging="360" />
      </w:pPr>
    </w:lvl>
  </w:lvlOverride>
</w:num>

The lvlOverride element specifies an override for level 0 of the abstract numbering definition. end example]

Parent Elements

numbering (§17.9.17)

Child Elements

Subclause

abstractNumId (Abstract Numbering Definition Reference)

§17.9.2

lvlOverride (Numbering Level Definition Override)

§17.9.9

Attributes

Description

numId (Numbering Definition Instance ID)

Specifies a unique ID which any numbered paragraph which wishes to inherit these numbering properties shall reference using the numPr element (§17.3.1.19).

[Example: Consider the WordprocessingML below for an example numbered paragraph:

<w:p>
  <w:pPr>
    <w:numPr>
      <w:ilvl w:val="0" />
      <w:numId w:val="5" />
    </w:numPr>
  </w:pPr> 
  …
</w:p>

This paragraph references a numbering definition instance with a numId attribute of 5:

<w:num w:numId="5">
  <w:abstractNumId w:val="4" />
</w:num>

The numbering definition instance with a numId attribute of 5 correlates with the numbered paragraph with the numbering definition instance referent element with a val of 5, so the numbered paragraph inherits its properties. end example]

The possible values for this attribute are defined by the ST_DecimalNumber simple type (§17.18.10).

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

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: