LegacyNumbering Class

Legacy Numbering Level Properties.When the object is serialized out as xml, its qualified name is w:legacy.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class LegacyNumbering _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As LegacyNumbering
public class LegacyNumbering : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.9.5 legacy (Legacy Numbering Level Properties)

This element specifies that a given numbering level is from an earlier word processing application which did not support the full richness of the numbering properties supported by WordprocessingML.

These properties shall be used to render any numbered paragraph which references this numbering level if the legacy attribute is set. [Note: Using this element in generated WordprocessingML documents is not recommended, as updated numbering structures in WordprocessingML should be used in its place. This element is provided solely to save and roundtrip the numbering properties of legacy word processing products in WordprocessingML such that they are recreated if the document is resaved in an older word processor format. end note]

[Example: Consider the following WordprocessingML numbering level:

<w:lvl w:ilvl="0">
  …
  <w:legacy w:legacySpace="820" w:legacyIndent="960" /> 
  <w:lvlJc w:val="left" /> 
  <w:pPr>
    <w:ind w:left="360" w:hanging="360" /> 
  </w:pPr>
</w:lvl>

This level has the legacy element present, therefore the legacy numbering level properties must be used to format all paragraphs which reference this level. end example]

Parent Elements

lvl (§17.9.6); lvl (§17.9.7)

Attributes

Description

legacy (Use Legacy Numbering Properties)

Specifies whether the legacy numbering properties present for this numbering level shall be used to format the numbering for any paragraph which references it.

A value of on, 1, or true for this attribute value specifies that the legacy numbering properties shall be applied. This is the default value for this attribute, and is implied when the attribute is omitted.

A value of off, 0, or false for this attribute value specifies that the legacy numbering properties shall not be used, and shall be explicitly turned off.

[Example: For example, consider the set of legacy numbering properties from a document:

<w:legacy w:legacy="off" w:legacySpace="820" w:legacyIndent="960" /> 

This set of legacy properties are explicitly not used when processing the numbering level via the fact that the legacy attribute is turned off for this example. end example]

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

legacyIndent (Legacy Indent)

Specifies the indentation which shall be applied to a legacy numbering symbol from the text margin of the document. This value is specified in twentieths of a point.

If this attribute is not present, then no indentation shall be applied with respect to the margin.

[Example: For example, consider the set of legacy numbering properties from a document:

<w:legacy w:legacySpace="820" w:legacyIndent="960" /> 

This set of legacy properties specify that there must be exactly 960 twentieths of a point (⅔ of an inch) between the text margin and the start of the numbering on the paragraph. end example]

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

legacySpace (Legacy Spacing)

Specifies the indentation which shall be applied between a legacy numbering symbol and the accompanying text of the associated paragraph in the document. This value is specified in twentieths of a point.

If this attribute is not present, then no indentation shall be applied with respect to the paragraph text.

[Example: For example, consider the set of legacy numbering properties from a document:

<w:legacy w:legacySpace="820" w:legacyIndent="960" /> 

This set of legacy properties specify that there must be exactly 860 twentieths of a point between the end of the numbering on the paragraph and the associated paragraph text. end example]

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

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

LegacyNumbering Members

DocumentFormat.OpenXml.Wordprocessing Namespace