ListCollection

ListCollection class

Lagrar och hanterar formatering av punktlistor och numrerade listor som används i ett dokument.

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

public class ListCollection : IEnumerable<List>

Egenskaper

namn	Beskrivning
Count { get; }	Hämtar antalet numrerade och punktlistor i dokumentet.
Document { get; }	Hämtar ägardokumentet.
Item { get; }	Hämtar en lista efter index.

Metoder

namn	Beskrivning
Add(ListTemplate)	Skapar en ny lista baserad på en fördefinierad mall och lägger till den i samlingen av listor i dokumentet.
Add(Style)	Skapar en ny lista som refererar till en liststil och lägger till den i samlingen av listor i dokumentet.
AddCopy(List)	Skapar en ny lista genom att kopiera den angivna listan och lägga till den i samlingen av listor i dokumentet.
GetEnumerator()	Hämtar uppräkningsobjektet som kommer att räkna upp listor i dokumentet.
GetListByListId(int)	Hämtar en lista med en listidentifierare.

Anmärkningar

En lista i ett Microsoft Word-dokument är en uppsättning listformateringsegenskaper. Formateringen av listorna lagras iListCollection samling separat från textstyckena.

Du skapar inte objekt av den här klassen. Det finns alltid bara enListCollection objekt per dokument och det är tillgängligt viaLists fast egendom.

För att skapa en ny lista baserad på en fördefinierad listmall eller baserad på en liststil, användAdd metod.

För att skapa en ny lista med formatering identisk med en befintlig lista, användAddCopy metod.

För att göra ett stycke punktat eller numrerat måste du tillämpa listformatering på ett stycke genom att tilldela enListinvända mot the List egendom avListFormat.

För att ta bort listformatering från ett stycke, användRemoveNumbers metod.

Om du kan lite om WordprocessingML, så kanske du vet att det definierar separata concepts för “list” och “list definition”. Detta motsvarar exakt hur listformatering lagras i ett Microsoft Word-dokument på låg nivå. Listdefinition är som ett “schema” och list är som en instans av en listdefinition.

För att förenkla programmeringsmodellen döljer Aspose.Words skillnaden mellan list och list definition på ungefär samma sätt som Microsoft Word döljer detta i sitt användargränssnitt. Detta gör att du kan koncentrera dig mer på hur du vill att ditt dokument ska se ut, snarare än bygga objekt på låg nivå för att uppfylla kraven i Microsoft Word-filformatet.

Det är inte möjligt att ta bort listor när de väl har skapats i den aktuella versionen av Aspose.Words. Detta liknar Microsoft Word där användaren inte har explicit kontroll över listdefinitioner.

Exempel

Visar hur man skapar ett dokument med ett exempel på alla listor från ett annat dokument.

public void PrintOutAllLists()
{
    Document srcDoc = new Document(MyDir + "Rendering.docx");

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

    foreach (List srcList in srcDoc.Lists)
    {
        List dstList = dstDoc.Lists.AddCopy(srcList);
        AddListSample(builder, dstList);
    }

    dstDoc.Save(ArtifactsDir + "Lists.PrintOutAllLists.docx");
}

private static void AddListSample(DocumentBuilder builder, List list)
{
    builder.Writeln("Sample formatting of list with ListId:" + list.ListId);
    builder.ListFormat.List = list;
    for (int i = 0; i < list.ListLevels.Count; i++)
    {
        builder.ListFormat.ListLevelNumber = i;
        builder.Writeln("Level " + i);
    }

    builder.ListFormat.RemoveNumbers();
    builder.Writeln();
}

Visar hur man startar om numrering i en lista genom att kopiera en lista.

Document doc = new Document();

// 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 en dokumentbyggares "ListFormat"-egenskap.
// Varje stycke som vi lägger till mellan en listas början och slutet kommer att bli ett objekt i listan.
// Skapa en lista från en Microsoft Word-mall och anpassa dess första listnivå.
List list1 = doc.Lists.Add(ListTemplate.NumberArabicParenthesis);
list1.ListLevels[0].Font.Color = Color.Red;
list1.ListLevels[0].Alignment = ListLevelAlignment.Right;

// Tillämpa vår lista på några stycken.
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Writeln("List 1 starts below:");
builder.ListFormat.List = list1;
builder.Writeln("Item 1");
builder.Writeln("Item 2");
builder.ListFormat.RemoveNumbers();

// Vi kan lägga till en kopia av en befintlig lista till dokumentets listsamling
// för att skapa en liknande lista utan att göra ändringar i originalet.
List list2 = doc.Lists.AddCopy(list1);
list2.ListLevels[0].Font.Color = Color.Blue;
list2.ListLevels[0].StartAt = 10;

// Tillämpa den andra listan på nya stycken.
builder.Writeln("List 2 starts below:");
builder.ListFormat.List = list2;
builder.Writeln("Item 1");
builder.Writeln("Item 2");
builder.ListFormat.RemoveNumbers();

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

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 en dokumentbyggares "ListFormat"-egenskap.
// Varje stycke som vi lägger till mellan en listas början och slutet kommer att bli ett objekt i listan.
// Nedan finns 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 objekt.
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 starta en fristående underlista vid det aktuella listobjektet.
// Microsoft Word-listmallen 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:
// Denna lista kommer att tillämpa ett indrag och en punktsymbol ("•") före varje stycke.
// Djupare nivåer i den här listan kommer att använda olika symboler, 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 "List"-flaggan.
builder.ListFormat.List = null;

Assert.False(builder.ListFormat.IsListItem);

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

Se även

• class List
• namnutrymme Aspose.Words.Lists
• hopsättning Aspose.Words