AbstractNum Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(Nsid))> _
<ChildElementInfoAttribute(GetType(MultiLevelType))> _
<ChildElementInfoAttribute(GetType(TemplateCode))> _
<ChildElementInfoAttribute(GetType(AbstractNumDefinitionName))> _
<ChildElementInfoAttribute(GetType(StyleLink))> _
<ChildElementInfoAttribute(GetType(NumberingStyleLink))> _
<ChildElementInfoAttribute(GetType(Level))> _
Public Class AbstractNum _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As AbstractNum
[ChildElementInfoAttribute(typeof(Nsid))]
[ChildElementInfoAttribute(typeof(MultiLevelType))]
[ChildElementInfoAttribute(typeof(TemplateCode))]
[ChildElementInfoAttribute(typeof(AbstractNumDefinitionName))]
[ChildElementInfoAttribute(typeof(StyleLink))]
[ChildElementInfoAttribute(typeof(NumberingStyleLink))]
[ChildElementInfoAttribute(typeof(Level))]
public class AbstractNum : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • Nsid <w:nsid>

  • MultiLevelType <w:multiLevelType>

  • TemplateCode <w:tmpl>

  • AbstractNumDefinitionName <w:name>

  • StyleLink <w:styleLink>

  • NumberingStyleLink <w:numStyleLink>

  • Level <w:lvl>

[ISO/IEC 29500-1 1st Edition]

17.9.1 abstractNum (Abstract Numbering Definition)

This element specifies a set of properties which shall dictate the appearance and behavior of a set of numbered paragraphs in a WordprocessingML document. These properties are collectively called an abstract numbering definition, and are the basis for all numbering information in a WordprocessingML document.

Although an abstract numbering definition contains a complete set of numbering, it shall not be directly referenced by content (hence the use of abstract). Instead, these properties shall be inherited by a numbering definition instance using the num element (§17.9.16), which can then itself be referenced by content.

[Example: Consider the following example of an abstractNum in a WordprocessingML document:

<w:abstractNum w:abstractNumId="4">
<w:nsid w:val="FFFFFF7F" />
<w:multiLevelType w:val="singleLevel" />
<w:lvl w:ilvl="0">
<w:start w:val="1" />
<w:lvlText w:val="%1." />
<w:lvlJc w:val="left" />
<w:pPr>
<w:tabs>
<w:tab w:val="num" w:pos="720" />
</w:tabs>
<w:ind w:left="720" w:hanging="360" />
</w:pPr>
</w:lvl>
</w:abstractNum>

This abstractNum element defines an abstract numbering definition which must be inherited by any numbering definition instance which inherits from abstract numbering definition with an abstractNumId equal to 4. end example]

Parent Elements

numbering (§17.9.17)

Child Elements

Subclause

lvl (Numbering Level Definition)

§17.9.7

multiLevelType (Abstract Numbering Definition Type)

§17.9.13

name (Abstract Numbering Definition Name)

§17.9.14

nsid (Abstract Numbering Definition Identifier)

§17.9.15

numStyleLink (Numbering Style Reference)

§17.9.22

styleLink (Numbering Style Definition)

§17.9.28

tmpl (Numbering Template Code)

§17.9.30

Attributes

Description

abstractNumId (Abstract Numbering Definition ID)

Specifies a unique number which shall be used as the identifier for this abstract numbering definition. This unique number shall be referenced by any numbering definition instance in order to inherit the properties specified by this abstract numbering definition.

[Example: Consider the WordprocessingML for an abstract numbering definition with an abstractNumId attribute of 4:

<w:abstractNum w:abstractNumId="4">
<w:nsid w:val="FFFFFF7F" />
<w:multiLevelType w:val="singleLevel" />
<w:lvl w:ilvl="0">
<w:start w:val="1" />
<w:lvlText w:val="%1." />
<w:lvlJc w:val="left" />
<w:pPr>
<w:tabs>
<w:tab w:val="num" w:pos="720" />
</w:tabs>
<w:ind w:left="720"/>
</w:pPr>
</w:lvl>
</w:abstractNum>

The abstractNumId attribute serves as a unique identifier for the abstract numbering definition, allowing numbering definition instances (§17.9.16) with a abstractNumId element with a matching attribute value to inherit the abstract numbering definition properties, for example:

<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>

In this case, the final two numbering definition instances both inherit from the abstract numbering definition with a abstractNumId of 4. 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_AbstractNum) 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

AbstractNum Members

DocumentFormat.OpenXml.Wordprocessing Namespace