ListFormat

ListFormat class

Gör det möjligt att styra vilken listformatering som tillämpas på ett stycke.

För att lära dig mer, besökArbeta med listor dokumentationsartikel.

public class ListFormat

Egenskaper

namnBeskrivning
IsListItem { get; }Sant när stycket har punktmarkerad eller numrerad formatering.
List { get; set; }Hämtar eller ställer in listan som detta stycke är medlem i.
ListLevel { get; }Returnerar formateringen på listnivå plus eventuella formateringsöverskridanden som tillämpats på det aktuella stycket.
ListLevelNumber { get; set; }Hämtar eller anger listnivånumret (0 till 8) för stycket.

Metoder

namnBeskrivning
ApplyBulletDefault()Startar en ny standardpunktlista och tillämpar den på stycket.
ApplyNumberDefault()Startar en ny standardnumrerad lista och tillämpar den på stycket.
ListIndent()Ökar listnivån för det aktuella stycket med en nivå.
ListOutdent()Minskar listnivån för det aktuella stycket med en nivå.
RemoveNumbers()Tar bort siffror eller punkter från det aktuella stycket och ställer in listnivån till noll.

Anmärkningar

Ett stycke i ett Microsoft Word-dokument kan vara punktformaterat eller numrerat. När ett stycke är punktformaterat eller numrerat sägs det att listformatering tillämpas på stycket.

Du skapar inte objekt avListFormat klass direkt. Du får åtkomstListFormatsom en egenskap för ett annat objekt som kan ha listformatering associerad med sig. För närvarande är objekten som kan ha listformatering:Paragraph , Style ochDocumentBuilder.

ListFormat av enParagraph anger vilken listformatering och listnivå som tillämpas på just det stycket.

ListFormat av enStyle (applicable endast för styckeformat) låter dig ange vilken listformatering och list level som ska tillämpas på alla stycken i det specifika formatet.

ListFormat av enDocumentBuilder ger åtkomst till listformateringen vid markörens aktuella position inutiDocumentBuilder.

Själva listformateringen lagras inuti enList -objekt som lagras separat från styckena. Listobjekten lagras inuti ettListCollection samling. Det finns en enda ListCollection samling perDocument.

Styckena hör inte fysiskt till en lista. Styckena refererar bara till ett visst listobjekt viaList property och en viss nivå i listan viaListLevelNumber property. Genom att ställa in dessa två egenskaper styr du vilka punkter och numreringar som tillämpas på ett stycke.

Exempel

Visar hur man arbetar med listnivåer.

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

Assert.False(builder.ListFormat.IsListItem);

// En lista låter oss organisera och dekorera uppsättningar av stycken med prefixsymboler och indrag.
 // Vi kan skapa kapslade listor genom att öka indragsnivån.
 // Vi kan börja och avsluta en lista genom att använda dokumentbyggarens "ListFormat"-egenskap.
// Varje stycke som vi lägger till mellan en listas början och slut blir ett objekt i listan.
// Nedan följer två typer av listor som vi kan skapa med hjälp av en dokumentbyggare.
// 1 - En numrerad lista:
// Numrerade listor skapar en logisk ordning för sina stycken genom att numrera varje element.
builder.ListFormat.List = doc.Lists.Add(ListTemplate.NumberDefault);

Assert.True(builder.ListFormat.IsListItem);

// Genom att ställa in egenskapen "ListLevelNumber" kan vi öka listnivån
// för att börja en fristående underlista vid det aktuella listobjektet.
// Listmallen i Microsoft Word som heter "NumberDefault" använder siffror för att skapa listnivåer för den första listnivån.
 // Djupare listnivåer använder bokstäver och gemener romerska siffror.
for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// 2 - En punktlista:
// Den här listan kommer att lägga till ett indrag och en punktsymbol ("•") före varje stycke.
// Djupare nivåer i den här listan kommer att använda andra symboler, såsom "■" och "○".
builder.ListFormat.List = doc.Lists.Add(ListTemplate.BulletDefault);

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

// Vi kan inaktivera listformatering för att inte formatera några efterföljande stycken som listor genom att avaktivera flaggan "Lista".
builder.ListFormat.List = null;

Assert.False(builder.ListFormat.IsListItem);

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

Se även

ListCollection Class ListLabel Class