ListFormat

ListFormat class

Ermöglicht die Steuerung, welche Listenformatierung auf einen Absatz angewendet wird.

Um mehr zu erfahren, besuchen Sie dieArbeiten mit Listen Dokumentationsartikel.

public class ListFormat

Eigenschaften

NameBeschreibung
IsListItem { get; }Wahr, wenn auf den Absatz Aufzählungszeichen oder Nummerierungen angewendet wurden.
List { get; set; }Ruft die Liste ab oder legt sie fest, zu der dieser Absatz gehört.
ListLevel { get; }Gibt die Formatierung auf Listenebene sowie alle auf den aktuellen Absatz angewendeten Formatierungsüberschreibungen zurück.
ListLevelNumber { get; set; }Ruft die Listenebenennummer (0 bis 8) für den Absatz ab oder legt sie fest.

Methoden

NameBeschreibung
ApplyBulletDefault()Startet eine neue Standardaufzählungsliste und wendet sie auf den Absatz an.
ApplyNumberDefault()Startet eine neue standardmäßige nummerierte Liste und wendet sie auf den Absatz an.
ListIndent()Erhöht die Listenebene des aktuellen Absatzes um eine Ebene.
ListOutdent()Verringert die Listenebene des aktuellen Absatzes um eine Ebene.
RemoveNumbers()Entfernt Nummerierungen oder Aufzählungszeichen aus dem aktuellen Absatz und setzt die Listenebene auf Null.

Bemerkungen

Ein Absatz in einem Microsoft Word-Dokument kann mit Aufzählungszeichen oder Nummerierungen versehen sein. Wenn ein Absatz mit Aufzählungszeichen oder Nummerierungen versehen ist, wird auf den Absatz die Listenformatierung angewendet.

Sie erstellen keine Objekte desListFormat Klasse direkt. Sie greifenListFormatals Eigenschaft eines anderen Objekts, dem eine Listenformatierung zugeordnet werden kann. Derzeit sind dies die Objekte, die eine Listenformatierung haben können:Paragraph , Style UndDocumentBuilder.

ListFormat einesParagraph gibt an , welche Listenformatierung und Listenebene auf diesen bestimmten Absatz angewendet wird.

ListFormat einesStyle (gilt nur für Absatzformate ) ermöglicht die Angabe, welche Listenformatierung und Listenebene auf alle Absätze dieses bestimmten Formats angewendet wird.

ListFormat einesDocumentBuilder ermöglicht den Zugriff auf die Listenformatierung an der aktuellen Cursorposition innerhalb derDocumentBuilder.

Die Listenformatierung selbst wird in einemList Objekt, das getrennt von den Absätzen gespeichert wird. Die Listenobjekte werden in einemListCollection Sammlung. Es gibt eine einzelne ListCollection Sammlung proDocument.

Die Absätze gehören physisch nicht zu einer Liste. Die Absätze verweisen lediglich auf ein bestimmtes Listenobjekt über dieList property und einer bestimmten Ebene in der Liste über dieListLevelNumber property. Durch Festlegen dieser beiden Eigenschaften steuern Sie, welche Aufzählungszeichen und Nummerierungen auf einen Absatz angewendet werden.

Beispiele

Zeigt, wie mit Listenebenen gearbeitet wird.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Assert.False(builder.ListFormat.IsListItem);

// Eine Liste ermöglicht es uns, Absatzsätze mit Präfixsymbolen und Einzügen zu organisieren und zu dekorieren.
    // Wir können verschachtelte Listen erstellen, indem wir die Einrückungsebene erhöhen.
    // Wir können eine Liste beginnen und beenden, indem wir die Eigenschaft „ListFormat“ eines Dokument-Generators verwenden.
// Jeder Absatz, den wir zwischen dem Anfang und dem Ende einer Liste hinzufügen, wird zu einem Element in der Liste.
// Unten sind zwei Arten von Listen, die wir mit einem Dokumentgenerator erstellen können.
// 1 - Eine nummerierte Liste:
// Nummerierte Listen erstellen eine logische Reihenfolge ihrer Absätze, indem sie jedes Element nummerieren.
builder.ListFormat.List = doc.Lists.Add(ListTemplate.NumberDefault);

Assert.True(builder.ListFormat.IsListItem);

// Durch Setzen der Eigenschaft „ListLevelNumber“ können wir die Listenebene erhöhen
// um eine in sich geschlossene Unterliste beim aktuellen Listenelement zu beginnen.
// Die Microsoft Word-Listenvorlage mit dem Namen „NumberDefault“ verwendet Zahlen, um Listenebenen für die erste Listenebene zu erstellen.
    // Tiefere Listenebenen verwenden Buchstaben und römische Ziffern in Kleinbuchstaben.
for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// 2 - Eine Aufzählungsliste:
// Diese Liste wendet vor jedem Absatz einen Einzug und ein Aufzählungszeichen („•“) an.
// Tiefere Ebenen dieser Liste verwenden andere Symbole, wie „■“ und „○“.
builder.ListFormat.List = doc.Lists.Add(ListTemplate.BulletDefault);

for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// Wir können die Listenformatierung deaktivieren, um nachfolgende Absätze nicht als Listen zu formatieren, indem wir das Flag „Liste“ deaktivieren.
builder.ListFormat.List = null;

Assert.False(builder.ListFormat.IsListItem);

doc.Save(ArtifactsDir + "Lists.SpecifyListLevel.docx");

Siehe auch

ListCollection Class ListLabel Class