Class ListLevel

Represents a list level in a document.

Inheritance
System.Object
ContentElement
ListLevel
Implements
IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
Inherited Members
Namespace: IronWord.Models.List
Assembly: IronWord.dll
Syntax
public class ListLevel : ContentElement

A ListLevel is the formatting definition for one level of a numbered or bulleted list, the rules that decide how that tier of the list looks and counts. A document outline that nests several tiers has one of these per level, each describing the symbol or number shown, how it is formatted, and how its counter behaves. It is the per-level detail behind the lists a MultiLevelTextList assembles, separate from the ListItem entries that carry the actual content.

Create a level with new ListLevel() and set the string properties that shape it. Its members group into a few concerns. **Appearance and counting**: LevelText is the displayed pattern for the level, NumberingFormat selects the numbering style, StartNumberingValue sets where the count begins, and LevelRestart controls when it restarts. **Layout**: LevelJustification aligns the marker and LevelSuffix sets what follows it. **Bullets and styles**: LevelPictureBulletId points at a picture bullet, NumberingSymbolRunProperties styles the symbol's run, and ParagraphStyleIdInLevel links a paragraph style to the level. **Compatibility**: IsLegalNumberingStyle, LegacyNumbering, and PreviousParagraphProperties preserve older numbering behaviour. Because the type derives from ContentElement, it also carries the shared Clone, Replace, Remove, and Parent members.

Set only the properties the level needs and leave the rest at their defaults. Define the levels first, then build the list and its items around them so the numbering and indentation render as intended.

var level = new ListLevel
{
    NumberingFormat = "decimal",
    LevelText = "%1.",
    StartNumberingValue = "1"
};

The add list example builds a multi-level list, the add bullet list example shows a bulleted variant, and the document element tutorial explains how elements like this fit together.

Constructors

ListLevel()

Declaration
public ListLevel()

Properties

IsLegalNumberingStyle

Gets or sets the legal numbering style setting for the list level.

Declaration
public string IsLegalNumberingStyle { get; set; }
Property Value
Type Description
System.String

LegacyNumbering

Gets or sets the legacy numbering setting for the list level.

Declaration
public string LegacyNumbering { get; set; }
Property Value
Type Description
System.String

LevelJustification

Gets or sets the level justification for the list level.

Declaration
public string LevelJustification { get; set; }
Property Value
Type Description
System.String

LevelPictureBulletId

Gets or sets the level picture bullet ID for the list level.

Declaration
public string LevelPictureBulletId { get; set; }
Property Value
Type Description
System.String

LevelRestart

Gets or sets the level restart setting for the list level.

Declaration
public string LevelRestart { get; set; }
Property Value
Type Description
System.String

LevelSuffix

Gets or sets the level suffix for the list level.

Declaration
public string LevelSuffix { get; set; }
Property Value
Type Description
System.String

LevelText

Gets or sets the level text for the list level.

Declaration
public string LevelText { get; set; }
Property Value
Type Description
System.String

NumberingFormat

Gets or sets the numbering format for the list level.

Declaration
public string NumberingFormat { get; set; }
Property Value
Type Description
System.String

NumberingSymbolRunProperties

Gets or sets the numbering symbol run properties for the list level.

Declaration
public string NumberingSymbolRunProperties { get; set; }
Property Value
Type Description
System.String

ParagraphStyleIdInLevel

Gets or sets the paragraph style ID in the level for the list level.

Declaration
public string ParagraphStyleIdInLevel { get; set; }
Property Value
Type Description
System.String

PreviousParagraphProperties

Gets or sets the previous paragraph properties for the list level.

Declaration
public string PreviousParagraphProperties { get; set; }
Property Value
Type Description
System.String

StartNumberingValue

Gets or sets the start numbering value for the list level.

Declaration
public string StartNumberingValue { get; set; }
Property Value
Type Description
System.String

Implements

IronSoftware.Abstractions.Word.IWordDocumentObject
IronSoftware.Abstractions.IDocumentObject
System.ICloneable

Inherited members

Replace(IWordDocumentObject)
Remove()
GetIndex<T>()
Clone()
CloneObject()
Parent
Status