NumberingChange Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Previous Paragraph Numbering Properties.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is w:numberingChange.

public class NumberingChange : DocumentFormat.OpenXml.OpenXmlLeafElement

type NumberingChange = class
    inherit OpenXmlLeafElement

Public Class NumberingChange
Inherits OpenXmlLeafElement

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

NumberingChange

Remarks

[ISO/IEC 29500-1 1st Edition]

numberingChange (Previous Numbering Field Properties)

This element specifies the previous state of the numbering displayed by a LISTNUM field (Part 1, §17.16.5.33) within a WordprocessingML document when additional LISTNUM fields are added and revisions are being tracked.

[Rationale: The legacy numbering mechanism provided by the LISTNUM field relies on the presence of fields in the run content of the document, rather than being a paragraph property (as numbering typically is represented). For this reason, these fields must store their previous state as a unique revision type on the field character of the numbering field. end rationale]

If this element is supplied for a field which is not of type LISTNUM as defined by its field codes (Part 1, §17.16.5), then this property shall be ignored.

[Example: Consider the following paragraph containing a single LISTNUM field, as follows:

5ccbfcbb-0568-4f98-b9e6-bc9b07df5295

If another LISTNUM field is added before it in the document, resulting in its evaluation to a different number, as follows:

5df1502e-4833-48c7-aa49-517de8059a13

This revision to the field result would be stored as follows in the WordprocessingML:

<w:fldChar w:fldCharType="begin">  
  <w:numberingChange w:id="0" … w:original="1." />  
</w:fldChar>  
<w:r>  
  <w:instrText>LISTNUM</w:instrText>  
</w:r>  
<w:fldChar w:fldCharType="separate"/>  
<w:r>  
  <w:t>2.</w:t>  
</w:r>  
<w:fldChar w:fldCharType="end" />  

The numberingChange element specifies that the numbering resulting from this LISTNUM field was modified and this change was tracked as a revision. The previous numbering result of 1. is cached in the original attribute. end example]

For numbering fields, the original attribute shall specify the previous numbering displayed by the parent LISTNUM field within a WordprocessingML document. This information is a performance-enhancing cache of the state of the numbering before the revision to allow applications to show the previous state without having to recalculate all of the LISTNUM fields in the document.

If this attribute is omitted, then no previous numbering value is implied and applications can choose to calculate this value, or display no previous numbering value.

[Example: Consider the following paragraph containing a single LISTNUM field with a revision, as follows:

5df1502e-4833-48c7-aa49-517de8059a13

This revision to the field result would be stored as follows in the WordprocessingML:

<w:fldChar w:fldCharType="begin">  
  <w:numberingChange w:id="0" … w:original="1." />  
</w:fldChar>  

The original attribute specifies that the previous numbering value of the field was 1. end example]

Parent Elements
fldChar (Part 1, §17.16.18)

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

[ISO/IEC 29500-1 1st Edition]

numberingChange (Previous Paragraph Numbering Properties)

This element specifies the previous state of the numbering on a paragraph when revisions are being tracked.

[Rationale: This mechanism is simply used to provide storage for revisions to numbering produced by legacy word processing applications, and applications are encouraged to use the pPrChange element to store these changes as changes to the paragraph properties instead. end rationale]

[Example: Consider the following list using Arabic numerals as the numbering, as follows:

f1e61028-5796-4a3c-aaeb-f786fa603b64

Consider a revision where the numbering definition is changed from Arabic numerals to Roman numerals, as follows:

e9f215fe-31e8-463c-a9b7-1f97d607869b

This revision to the numbering definition would be stored as follows in the WordprocessingML:

<w:p>  
<w:pPr>  
<w:numPr>  
<w:ilvl w:val="0" />  
<w:numId w:val="1" />  
<w:numberingChange w:id="0" … w:original="%1:1:0:." />  
</w:numPr>  
</w:pPr>  
<w:r>  
<w:t>one</w:t>  
</w:r>  
</w:p>  
<w:p>  
<w:pPr>  
<w:numPr>  
<w:ilvl w:val="0" />  
<w:numId w:val="1" />  
<w:numberingChange w:id="1" … w:original="%1:2:0:." />  
</w:numPr>  
</w:pPr>  
<w:r>  
<w:t>two</w:t>  
</w:r>  
</w:p>  
<w:p>  
<w:pPr>  
<w:numPr>  
<w:ilvl w:val="0" />  
<w:numId w:val="1" />  
<w:numberingChange w:id="2" … w:original="%1:3:0:." />  
</w:numPr>  
</w:pPr>  
<w:r>  
<w:t>three</w:t>  
</w:r>  
</w:p>  

The numberingChange element specifies that the numbering definition was modified and this change was tracked as a revision. The previous Arabic numeral numbering definition is cached in the original attribute. end example]

For paragraph numbering, the original attribute shall specify the previous numbering definition for an individual paragraph of text within a WordprocessingML document while revisions are being tracked.

The value of original is represented as separate numbering level definitions defined as follows:

<%[numbering level]:[nfc value]:[numbering format]:[separator]>[repeat if more than one level]  

where

• numbering level – The level for which the numbering definition is defined

• nfc value – The value of the numbering style at the specific numbering level

• numbering format – The nfc value of the numbering format, as referenced in the table below.

• separator – The separator used to separate the numbering level definitions

The numbering format values are mapped as follows:

nfc Value

ST_NumberFormat enumeration equivalent

0

decimal

1

upperRoman

2

lowerRoman

3

upperLetter

4

lowerLetter

5

ordinal

6

cardinalText

7

ordinalText

8

hex

9

chicago

10

ideographDigital

11

japaneseCounting

12

Aiueo

13

Iroha

14

decimalFullWidth

15

decimalHalfWidth

16

japaneseLegal

17

japaneseDigitalTenThousand

18

decimalEnclosedCircle

19

decimalFullWidth2

20

aiueoFullWidth

21

irohaFullWidth

22

decimalZero

23

bullet

24

ganada

25

chosung

26

decimalEnclosedFullstop

27

decimalEnclosedParen

28

decimalEnclosedCircleChinese

29

ideographEnclosedCircle

30

ideographTraditional

31

ideographZodiac

32

ideographZodiacTraditional

33

taiwaneseCounting

34

ideographLegalTraditional

35

taiwaneseCountingThousand

36

taiwaneseDigital

37

chineseCounting

38

chineseLegalSimplified

39

chineseCountingThousand

40

Application-defined. Can be ignored.

41

koreanDigital

42

koreanCounting

43

koreanLegal

44

koreanDigital2

45

hebrew1

46

arabicAlpha

47

hebrew2

48

arabicAbjad

49

hindiVowels

50

hindiConsonants

51

hindiNumbers

52

hindiCounting

53

thaiLetters

54

thaiNumbers

55

thaiCounting

56

vietnameseCounting

57

numberInDash

58

russianLower

59

russianUpper

60 or above

Application-defined. Can be ignored.

[Example: Consider the following numbered paragraph where the numbering definition has changed while revisions are being tracked, as follows:

1295cca3-f9de-4aec-9347-8baae6e0f1b0

This revision to the numbered paragraph would be stored as follows in the WordprocessingML:

<w:numPr>  
  …  
  <w:numberingChange … w:original="%1:1:0:.%2:1:2:.%3:1:0:." />  
</w:numPr>  

In the above example there are three levels in the original numbering definition, thus three numbering level definitions are needed to represent the original numbering definition.

The first level is specified by %1, and says that it was number value 1 in the nfc format 0 (arabic).

The original attribute specifies that the previous numbering definition was made up of three levels whose value was 1.i.1.. end example]

Parent Elements
numPr (Part 1, §17.3.1.19)

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

� ISO/IEC29500: 2008.

Constructors

NumberingChange()

Initializes a new instance of the NumberingChange class.

Properties

Author	author Represents the following attribute in the schema: w:author
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Date	date Represents the following attribute in the schema: w:date
DateUtc	dateUtc, this property is only available in Microsoft365 and later. Represents the following attribute in the schema: w16du:dateUtc
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlLeafElement)
Id	Annotation Identifier Represents the following attribute in the schema: w:id
InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement)
InnerXml	Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement)
LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
Original	original Represents the following attribute in the schema: w:original
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index in the current element's list of child elements. (Inherited from OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child elements. (Inherited from OpenXmlElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all child elements of the current element. (Inherited from OpenXmlLeafElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element from the current element's list of child elements. (Inherited from OpenXmlElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)