FieldIndex
Contenuti
[
Nascondere
]FieldIndex class
Implementa il campo INDICE.
Per saperne di più, visita ilLavorare con i campi articolo di documentazione.
public class FieldIndex : Field
Costruttori
| Nome | Descrizione |
|---|---|
| FieldIndex() | Default_Costruttore |
Proprietà
| Nome | Descrizione |
|---|---|
| BookmarkName { get; set; } | Ottiene o imposta il nome del segnalibro che contrassegna la parte del documento utilizzata per creare l’indice. |
| CrossReferenceSeparator { get; set; } | Ottiene o imposta la sequenza di caratteri utilizzata per separare i riferimenti incrociati e altre voci. |
| DisplayResult { get; } | Ottiene il testo che rappresenta il risultato del campo visualizzato. |
| End { get; } | Ottiene il nodo che rappresenta la fine del campo. |
| EntryType { get; set; } | Ottiene o imposta un tipo di voce di indice utilizzato per creare l’indice. |
| Format { get; } | Ottiene aFieldFormat oggetto che fornisce accesso digitato alla formattazione del campo. |
| HasPageNumberSeparator { get; } | Ottiene un valore che indica se un separatore del numero di pagina viene sovrascritto tramite il codice del campo. |
| HasSequenceName { get; } | Ottiene un valore che indica se è necessario utilizzare una sequenza durante la creazione del risultato del campo. |
| Heading { get; set; } | Ottiene o imposta un’intestazione che appare all’inizio di ogni serie di voci per ogni determinata lettera. |
| IsDirty { get; set; } | Ottiene o imposta se il risultato corrente del campo non è più corretto (obsoleto) a causa di altre modifiche apportate al documento. |
| IsLocked { get; set; } | Ottiene o imposta se il campo è bloccato (non deve ricalcolare il risultato). |
| LanguageId { get; set; } | Ottiene o imposta l’ID della lingua utilizzata per generare l’indice. |
| LetterRange { get; set; } | Ottiene o imposta un intervallo di lettere a cui limitare l’indice. |
| LocaleId { get; set; } | Ottiene o imposta l’LCID del campo. |
| NumberOfColumns { get; set; } | Ottiene o imposta il numero di colonne per pagina utilizzate durante la creazione dell’indice. |
| PageNumberListSeparator { get; set; } | Ottiene o imposta la sequenza di caratteri utilizzata per separare due numeri di pagina in un elenco di numeri di pagina. |
| PageNumberSeparator { get; set; } | Ottiene o imposta la sequenza di caratteri utilizzata per separare una voce di indice e il relativo numero di pagina. |
| PageRangeSeparator { get; set; } | Ottiene o imposta la sequenza di caratteri utilizzata per separare l’inizio e la fine di un intervallo di pagine. |
| Result { get; set; } | Ottiene o imposta il testo compreso tra il separatore di campo e la fine del campo. |
| RunSubentriesOnSameLine { get; set; } | Ottiene o imposta se eseguire le voci secondarie nella stessa riga della voce principale. |
| Separator { get; } | Ottiene il nodo che rappresenta il separatore di campo. Può esserenullo . |
| SequenceName { get; set; } | Ottiene o imposta il nome di una sequenza il cui numero è incluso nel numero di pagina. |
| SequenceSeparator { get; set; } | Ottiene o imposta la sequenza di caratteri utilizzata per separare i numeri di sequenza e i numeri di pagina. |
| Start { get; } | Ottiene il nodo che rappresenta l’inizio del campo. |
| virtual Type { get; } | Ottiene il tipo di campo Microsoft Word. |
| UseYomi { get; set; } | Ottiene o imposta se abilitare l’uso del testo yomi per le voci di indice. |
Metodi
| Nome | Descrizione |
|---|---|
| GetFieldCode() | Restituisce il testo compreso tra l’inizio del campo e il separatore di campo (o la fine del campo se non è presente alcun separatore). Sono inclusi sia il codice di campo che il risultato del campo dei campi secondari. |
| GetFieldCode(bool) | Restituisce il testo tra l’inizio del campo e il separatore di campo (o la fine del campo se non è presente alcun separatore). |
| Remove() | Rimuove il campo dal documento. Restituisce un nodo subito dopo il campo. Se la fine del campo è l’ultimo figlio del suo nodo genitore, restituisce il paragrafo genitore. Se il campo è già stato rimosso, restituiscenullo . |
| Unlink() | Esegue lo scollegamento del campo. |
| Update() | Esegue l’aggiornamento del campo. Genera un risultato se il campo è già in fase di aggiornamento. |
| Update(bool) | Esegue un aggiornamento del campo. Genera un risultato se il campo è già in fase di aggiornamento. |
Osservazioni
Crea un indice utilizzando le voci di indice specificate dai campi XE e inserisce l’indice in questa posizione nel documento.
Esempi
Mostra come creare un campo INDICE e quindi utilizzare i campi XE per compilarlo con le voci.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Crea un campo INDICE che visualizzerà una voce per ogni campo XE trovato nel documento.
// Ogni voce visualizzerà il valore della proprietà Text del campo XE sul lato sinistro
// e la pagina contenente il campo XE sulla destra.
// Se i campi XE hanno lo stesso valore nella loro proprietà "Testo",
// il campo INDICE li raggrupperà in un'unica voce.
FieldIndex index = (FieldIndex)builder.InsertField(FieldType.FieldIndex, true);
// Configura il campo INDEX solo per visualizzare i campi XE che rientrano nei limiti
// di un segnalibro denominato "MainBookmark" e le cui proprietà "EntryType" hanno un valore "A".
// Per entrambi i campi INDEX e XE, la proprietà "EntryType" utilizza solo il primo carattere del suo valore di stringa.
index.BookmarkName = "MainBookmark";
index.EntryType = "A";
Assert.AreEqual(" INDEX \\b MainBookmark \\f A", index.GetFieldCode());
// In una nuova pagina, inizia il segnalibro con un nome che corrisponde al valore
// della proprietà "BookmarkName" del campo INDICE.
builder.InsertBreak(BreakType.PageBreak);
builder.StartBookmark("MainBookmark");
// Il campo INDICE rileverà questa voce perché è all'interno del segnalibro,
// e il suo tipo di voce corrisponde anche al tipo di voce del campo INDICE.
FieldXE indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Index entry 1";
indexEntry.EntryType = "A";
Assert.AreEqual(" XE \"Index entry 1\" \\f A", indexEntry.GetFieldCode());
// Inserisci un campo XE che non apparirà nell'INDICE perché i tipi di voce non corrispondono.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Index entry 2";
indexEntry.EntryType = "B";
// Termina il segnalibro e successivamente inserisce un campo XE.
// È dello stesso tipo del campo INDEX, ma non verrà visualizzato
// poiché è fuori dai confini del segnalibro.
builder.EndBookmark("MainBookmark");
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Index entry 3";
indexEntry.EntryType = "A";
doc.UpdatePageLayout();
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.INDEX.XE.Filtering.docx");
Mostra come popolare un campo INDICE con voci utilizzando i campi XE e anche modificarne l’aspetto.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Crea un campo INDICE che visualizzerà una voce per ogni campo XE trovato nel documento.
// Ogni voce visualizzerà il valore della proprietà Text del campo XE sul lato sinistro,
// e il numero della pagina che contiene il campo XE a destra.
// Se i campi XE hanno lo stesso valore nella loro proprietà "Testo",
// il campo INDICE li raggrupperà in un'unica voce.
FieldIndex index = (FieldIndex)builder.InsertField(FieldType.FieldIndex, true);
index.LanguageId = "1033";
// Impostando il valore di questa proprietà su "A" raggrupperà tutte le voci in base alla prima lettera,
// e posiziona la lettera in maiuscolo sopra ciascun gruppo.
index.Heading = "A";
// Imposta la tabella creata dal campo INDEX in modo che si estenda su 2 colonne.
index.NumberOfColumns = "2";
// Imposta tutte le voci con lettere iniziali esterne all'intervallo di caratteri "ac" in modo che vengano omesse.
index.LetterRange = "a-c";
Assert.AreEqual(" INDEX \\z 1033 \\h A \\c 2 \\p a-c", index.GetFieldCode());
// I prossimi due campi XE verranno visualizzati sotto l'intestazione "A",
// con i rispettivi stili di testo applicati anche ai numeri di pagina.
builder.InsertBreak(BreakType.PageBreak);
FieldXE indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Apple";
indexEntry.IsItalic = true;
Assert.AreEqual(" XE Apple \\i", indexEntry.GetFieldCode());
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Apricot";
indexEntry.IsBold = true;
Assert.AreEqual(" XE Apricot \\b", indexEntry.GetFieldCode());
// Entrambi i successivi due campi XE saranno sotto l'intestazione "B" e "C" nel sommario dei campi INDEX.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Banana";
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Cherry";
// I campi INDICE ordinano tutte le voci in ordine alfabetico, quindi questa voce verrà visualizzata sotto "A" con le altre due.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Avocado";
// Questa voce non apparirà perché inizia con la lettera "D",
// che è esterno all'intervallo di caratteri "ac" definito dalla proprietà LetterRange del campo INDEX.
builder.InsertBreak(BreakType.PageBreak);
indexEntry = (FieldXE)builder.InsertField(FieldType.FieldIndexEntry, true);
indexEntry.Text = "Durian";
doc.UpdatePageLayout();
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.INDEX.XE.Formatting.docx");
Guarda anche
- class Field
- spazio dei nomi Aspose.Words.Fields
- assemblea Aspose.Words
