OutlineLevel Class
Defines the OutlineLevel Class.When the object is serialized out as xml, its qualified name is w:outlineLvl.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.DecimalNumberType
DocumentFormat.OpenXml.Wordprocessing.OutlineLevel
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class OutlineLevel _
Inherits DecimalNumberType
'Usage
Dim instance As OutlineLevel
public class OutlineLevel : DecimalNumberType
Remarks
[ISO/IEC 29500-1 1st Edition]
17.3.1.20 outlineLvl (Associated Outline Level)
This element specifies the outline level which shall be associated with the current paragraph in the document. The outline level specifies an integer which defines the level of the associated text. This level shall not affect the appearance of the text in the document, but shall be used to calculate the TOC field (§17.16.5.68) if the appropriate field switches have been set, and can be used by consumers to provide additional application behavior.
The outline level of text in the document (specified using the val attribute) can be from 0 to 9, where 9 specifically indicates that there is no outline level specifically applied to this paragraph. If this element is omitted, then the outline level of the content is assumed to be 9 (no level).
[Example: Consider a paragraph in a document which has outline level 1 applied to it. This paragraph would specify the following WordprocessingML:
<w:pPr> <w:outlineLvl w:val="0" /> </w:pPr>
This paragraph is now of outline level 1, and if a table of contents field is inserted that utilizes outlines levels, the text in this paragraph is at level one in the TOC. end example]
Parent Elements |
|---|
pPr (§17.3.1.26); pPr (§17.3.1.25); pPr (§17.7.5.2); pPr (§17.7.6.1); pPr (§17.9.23); pPr (§17.7.8.2) |
Attributes |
Description |
|---|---|
val (Decimal Number Value) |
Specifies that the contents of this attribute contains a decimal number. The contents of this decimal number are interpreted based on the context of the parent XML element. [Example: Consider the following numeric WordprocessingML property of simple type ST_DecimalNumber: <… w:val="1512645511" /> The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. 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_DecimalNumber) 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.