ListFormat

ListFormat class

Consente di controllare quale formattazione dell’elenco viene applicata a un paragrafo.

public class ListFormat

Proprietà

Nome Descrizione
IsListItem { get; } Vero quando al paragrafo è stata applicata una formattazione puntata o numerata.
List { get; set; } Ottiene o imposta l’elenco di cui è membro questo paragrafo.
ListLevel { get; } Restituisce la formattazione a livello di elenco più eventuali sostituzioni di formattazione applicate al paragrafo corrente.
ListLevelNumber { get; set; } Ottiene o imposta il numero a livello di elenco (da 0 a 8) per il paragrafo.

Metodi

Nome Descrizione
ApplyBulletDefault() Avvia un nuovo elenco puntato predefinito e lo applica al paragrafo.
ApplyNumberDefault() Avvia un nuovo elenco numerato predefinito e lo applica al paragrafo.
ListIndent() Aumenta di un livello il livello dell’elenco del paragrafo corrente.
ListOutdent() Diminuisce di un livello il livello dell’elenco del paragrafo corrente.
RemoveNumbers() Rimuove numeri o punti elenco dal paragrafo corrente e imposta il livello dell’elenco su zero.

Osservazioni

Un paragrafo in un documento di Microsoft Word può essere puntato o numerato. Quando un paragrafo è puntato o numerato, si dice che al paragrafo viene applicata la formattazione dell’elenco .

Non crei oggetti delListFormat classe direttamente. Si accedeListFormat come proprietà di un altro oggetto che può avere una formattazione elenco associata. Al momento gli oggetti che possono avere la formattazione della lista sono:Paragraph , Style eDocumentBuilder.

ListFormat di unParagraph specifica quale formattazione e livello di elenco viene applicato a quel particolare paragrafo.

ListFormat di unStyle(applicabile solo agli stili di paragrafo) consente di specificare la formattazione dell’elenco e il livello di elenco da applicare a tutti i paragrafi di quel particolare stile.

ListFormat di unDocumentBuilder fornisce l’accesso alla formattazione dell’elenco nella posizione corrente del cursore all’interno delDocumentBuilder.

La stessa formattazione dell’elenco è memorizzata all’interno di aList oggetto memorizzato separatamente dai paragrafi. L’elenco oggetti sono archiviati all’interno di aListCollection collezione. C’è un singolo ListCollection raccolta perDocument.

I paragrafi non appartengono fisicamente a un elenco. I paragrafi just fanno riferimento a un particolare oggetto elenco tramite ilList property e un livello particolare nell’elenco tramite ilListLevelNumber property. Impostando queste due proprietà si controlla quali elenchi puntati e numerazione vengono applicati a un paragrafo.

Esempi

Mostra come lavorare con i livelli di elenco.

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

Assert.False(builder.ListFormat.IsListItem);

// Un elenco ci consente di organizzare e decorare insiemi di paragrafi con simboli e rientri prefissi.
// Possiamo creare liste nidificate aumentando il livello di rientro. 
// Possiamo iniziare e terminare un elenco utilizzando la proprietà "ListFormat" di un generatore di documenti. 
// Ogni paragrafo che aggiungiamo tra l'inizio e la fine di un elenco diventerà un elemento nell'elenco.
// Di seguito sono riportati due tipi di elenchi che possiamo creare utilizzando un generatore di documenti.
// 1 - Un elenco numerato:
// Gli elenchi numerati creano un ordine logico per i loro paragrafi numerando ogni elemento.
builder.ListFormat.List = doc.Lists.Add(ListTemplate.NumberDefault);

Assert.True(builder.ListFormat.IsListItem);

// Impostando la proprietà "ListLevelNumber", possiamo aumentare il livello dell'elenco
// per iniziare un sottoelenco autonomo all'elemento dell'elenco corrente.
// Il modello di elenco di Microsoft Word chiamato "NumberDefault" utilizza i numeri per creare livelli di elenco per il primo livello di elenco.
// I livelli di elenco più profondi utilizzano lettere e numeri romani minuscoli. 
for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// 2 - Un elenco puntato:
// Questo elenco applicherà un trattino e un simbolo di punto elenco ("•") prima di ogni paragrafo.
// I livelli più profondi di questo elenco utilizzeranno simboli diversi, come "■" e "○".
builder.ListFormat.List = doc.Lists.Add(ListTemplate.BulletDefault);

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

// Possiamo disabilitare la formattazione degli elenchi per non formattare i paragrafi successivi come elenchi deselezionando il flag "Elenco".
builder.ListFormat.List = null;

Assert.False(builder.ListFormat.IsListItem);

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

Guarda anche