Level Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Numbering Level Definition.

This class is available in Office 2007 and above.

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

public class Level : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Level = class
    inherit OpenXmlCompositeElement

Public Class Level
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Level

Remarks

[ISO/IEC 29500-1 1st Edition]

lvl (Numbering Level Override Definition)

This element specifies the appearance and behavior of a specific numbering level within a given numbering level definition override defined using the lvlOverride element (§17.9.9).

A numbering level override definition is identical to a numbering level definition, except for the fact that it is defined as part of a numbering definition instance using the num element (§17.9.16) rather than as part of an abstract numbering definition using the abstractNum element (§17.9.1).

[Example: Consider a numbering definition instance which inherits its information from the abstract numbering definition with abstractNumId of 4, but should 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>  

This numbering definition instance overrides level 0 of the list with the specified numbering level override definition, replacing those in the abstract numbering level definition. end example]

[Note: The ability to set level overrides optimizes use of numbering in WordprocessingML as it prevents writing out redundant abstract numbering definitions if numbering sets only slightly differ.

Consider using WordprocessingML to create two numbered sets that only differ only in the appearance and style of the first numbering level. Both could use the same abstract numbering definition as long as each references a different numbering definition instance with one of the numbering definition instances leveraging a level override for the first numbering level. Below is WordprocessingML that illustrates this:

<w:num w:numId="5">  
  <w:abstractNumId w:val="4" />  
</w:num>  
<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>  

end note]

Parent Elements
lvlOverride (§17.9.9)

Child Elements	Subclause
isLgl (Display All Levels Using Arabic Numerals)	§17.9.4
legacy (Legacy Numbering Level Properties)	§17.9.5
lvlJc (Justification)	§17.9.8
lvlPicBulletId (Picture Numbering Symbol Definition Reference)	§17.9.10
lvlRestart (Restart Numbering Level Symbol)	§17.9.11
lvlText (Numbering Level Text)	§17.9.12
numFmt (Numbering Format)	§17.9.18
pPr (Numbering Level Associated Paragraph Properties)	§17.9.23
pStyle (Paragraph Style's Associated Numbering Level)	§17.9.24
rPr (Numbering Symbol Run Properties)	§17.9.25
start (Starting Value)	§17.9.26
suff (Content Between Numbering Symbol and Paragraph Text)	§17.9.29

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

[ISO/IEC 29500-1 1st Edition]

lvl (Numbering Level Definition)

This element specifies the appearance and behavior of a numbering level within a given abstract numbering definition. A numbering level contains a set of properties for the display of the numbering for a given numbering level within an abstract numbering definition.

A numbering level definition is identical to a numbering level override definition, except for the fact that it is defined as part of a numbering definition instance using the abstractNum element (§17.9.1) rather than as part of an abstract numbering definition using the num element (§17.9.16).

[Example: Consider the WordprocessingML below:

<w:abstractNum w:abstractNumId="4">  
  <w:nsid w:val="1DE04504" />  
  <w:multiLevelType w:val="hybridMultilevel" />  
  <w:lvl w:ilvl="0" w:tplc="">  
    …  </w:lvl>  
  <w:lvl w:ilvl="1" w:tplc="04090019">  
    …  </w:lvl>  
  <w:lvl w:ilvl="2" w:tplc="04090019">  
    …  </w:lvl>  
  <w:lvl w:ilvl="3" w:tplc="">  
    …  </w:lvl>  
  …</w:abstractNum>  

This example shows that any paragraph whose numbering properties use the ilvl elements with the attribute val set equal to 0, 1, 2, or 3 has the appearance and behavior of their first four numbered levels specified by the lvl elements given above (assuming that no level overrides have been specified). end example]

Parent Elements
abstractNum (§17.9.1)

Child Elements	Subclause
isLgl (Display All Levels Using Arabic Numerals)	§17.9.4
legacy (Legacy Numbering Level Properties)	§17.9.5
lvlJc (Justification)	§17.9.8
lvlPicBulletId (Picture Numbering Symbol Definition Reference)	§17.9.10
lvlRestart (Restart Numbering Level Symbol)	§17.9.11
lvlText (Numbering Level Text)	§17.9.12
numFmt (Numbering Format)	§17.9.18
pPr (Numbering Level Associated Paragraph Properties)	§17.9.23
pStyle (Paragraph Style's Associated Numbering Level)	§17.9.24
rPr (Numbering Symbol Run Properties)	§17.9.25
start (Starting Value)	§17.9.26
suff (Content Between Numbering Symbol and Paragraph Text)	§17.9.29

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

� ISO/IEC29500: 2008.

Constructors

Level()	Initializes a new instance of the Level class.
Level(IEnumerable<OpenXmlElement>)	Initializes a new instance of the Level class with the specified child elements.
Level(OpenXmlElement[])	Initializes a new instance of the Level class with the specified child elements.
Level(String)	Initializes a new instance of the Level class from outer XML.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
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 current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
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 OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
IsLegalNumberingStyle	Display All Levels Using Arabic Numerals. Represents the following element tag in the schema: w:isLgl.
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LegacyNumbering	Legacy Numbering Level Properties. Represents the following element tag in the schema: w:legacy.
LevelIndex	Numbering Level Represents the following attribute in the schema: w:ilvl
LevelJustification	Justification. Represents the following element tag in the schema: w:lvlJc.
LevelPictureBulletId	Picture Numbering Symbol Definition Reference. Represents the following element tag in the schema: w:lvlPicBulletId.
LevelRestart	Restart Numbering Level Symbol. Represents the following element tag in the schema: w:lvlRestart.
LevelSuffix	Content Between Numbering Symbol and Paragraph Text. Represents the following element tag in the schema: w:suff.
LevelText	Numbering Level Text. Represents the following element tag in the schema: w:lvlText.
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)
NumberingFormat	Numbering Format. Represents the following element tag in the schema: w:numFmt.
NumberingSymbolRunProperties	Numbering Symbol Run Properties. Represents the following element tag in the schema: w:rPr.
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
ParagraphStyleIdInLevel	Paragraph Style's Associated Numbering Level. Represents the following element tag in the schema: w:pStyle.
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PreviousParagraphProperties	Numbering Level Associated Paragraph Properties. Represents the following element tag in the schema: w:pPr.
StartNumberingValue	Starting Value. Represents the following element tag in the schema: w:start.
TemplateCode	Template Code Represents the following attribute in the schema: w:tplc
Tentative	Tentative Numbering Represents the following attribute in the schema: w:tentative
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)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
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 OpenXmlCompositeElement)
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 OpenXmlCompositeElement)
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 of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
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 nodes. (Inherited from OpenXmlCompositeElement)
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 of the current element's child elements. (Inherited from OpenXmlCompositeElement)
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. (Inherited from OpenXmlCompositeElement)
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 one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
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)