NumberingChange Class

  • Article

Previous Paragraph Numbering Properties.When the object is serialized out as xml, its qualified name is w:numberingChange.

Inheritance Hierarchy

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

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

Syntax

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

public class NumberingChange : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

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

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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:

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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)

Attributes

Description

author (Annotation Author)

Specifies the author for an annotation within a WordprocessingML document.

If this attribute is omitted, then no author shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:author="Example Author">
  …
</…>

The author attribute specifies that the author of the current annotation is Example Author, which can be used as desired. end example]

The possible values for this attribute are defined by the ST_String simple type (Part 1, §22.9.2.13).

date (Annotation Date)

Specifies the date information for an annotation within a WordprocessingML document. The use of this information is outside of the scope of ISO/IEC 29500.

If this attribute is omitted, then no date information shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:date="2006-01-01T10:00:00">
  …
</…>

The date attribute specifies that the date of the current annotation is January 1st 2006 at 10:00 AM, which can be used as desired. end example]

The possible values for this attribute are defined by the ST_DateTime simple type (Part 1, §17.18.9).

id (Annotation Identifier)

Specifies a unique identifier for an annotation within a WordprocessingML document. The restrictions on the id attribute, if any, are defined by the parent XML element.

If this attribute is omitted, then the document is non-conformant.

[Example: Consider an annotation represented using the following WordprocessingML fragment:

<… w:id="1" … >
  …
</…>

The id attribute specifies that the ID of the current annotation is 1. This value is used to uniquely identify this annotation within the document content. end example]

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

original (Previous Numbering Value)

Specifies the previous numbering displayed by the parent numbering change revision. Its format is specified by the parent element.

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:

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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]

The possible values for this attribute are defined by the ST_String simple type (Part 1, §22.9.2.13).

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

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

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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:

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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)

Attributes

Description

author (Annotation Author)

Specifies the author for an annotation within a WordprocessingML document.

If this attribute is omitted, then no author shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:author="Example Author">
  …
</…>

The author attribute specifies that the author of the current annotation is Example Author, which can be used as desired. end example]

The possible values for this attribute are defined by the ST_String simple type (Part 1, §22.9.2.13).

date (Annotation Date)

Specifies the date information for an annotation within a WordprocessingML document. The use of this information is outside of the scope of ISO/IEC 29500.

If this attribute is omitted, then no date information shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:date="2006-01-01T10:00:00">
  …
</…>

The date attribute specifies that the date of the current annotation is January 1st 2006 at 10:00 AM, which can be used as desired. end example]

The possible values for this attribute are defined by the ST_DateTime simple type (Part 1, §17.18.9).

id (Annotation Identifier)

Specifies a unique identifier for an annotation within a WordprocessingML document. The restrictions on the id attribute, if any, are defined by the parent XML element.

If this attribute is omitted, then the document is non-conformant.

[Example: Consider an annotation represented using the following WordprocessingML fragment:

<… w:id="1" … >
  …
</…>

The id attribute specifies that the ID of the current annotation is 1. This value is used to uniquely identify this annotation within the document content. end example]

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

original (Previous Numbering Value)

Specifies the previous numbering displayed by the parent numbering change revision. Its format is specified by the parent element.

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:

DocumentFormat.OpenXml.Wordprocessing.NumberingCha

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]

The possible values for this attribute are defined by the ST_String simple type (Part 1, §22.9.2.13).

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

NumberingChange Members

DocumentFormat.OpenXml.Wordprocessing Namespace