FieldTA
Contenuti
[
Nascondere
]FieldTA class
Implementa il campo TA.
Per saperne di più, visita ilLavorare con i campi articolo di documentazione.
public class FieldTA : Field
Costruttori
Nome | Descrizione |
---|---|
FieldTA() | Default_Costruttore |
Proprietà
Nome | Descrizione |
---|---|
DisplayResult { get; } | Ottiene il testo che rappresenta il risultato del campo visualizzato. |
End { get; } | Ottiene il nodo che rappresenta la fine del campo. |
EntryCategory { get; set; } | Ottiene o imposta la categoria di voce integrale, ovvero un numero che corrisponde all’ordine delle categorie. |
Format { get; } | Ottiene aFieldFormat oggetto che fornisce accesso digitato alla formattazione del campo. |
IsBold { get; set; } | Ottiene o imposta se applicare la formattazione in grassetto al numero di pagina per la voce. |
IsDirty { get; set; } | Ottiene o imposta se il risultato corrente del campo non è più corretto (obsoleto) a causa di altre modifiche apportate al documento. |
IsItalic { get; set; } | Ottiene o imposta se applicare la formattazione corsivo al numero di pagina per la voce. |
IsLocked { get; set; } | Ottiene o imposta se il campo è bloccato (non deve ricalcolare il risultato). |
LocaleId { get; set; } | Ottiene o imposta l’LCID del campo. |
LongCitation { get; set; } | Ottiene o imposta la citazione lunga per la voce. |
PageRangeBookmarkName { get; set; } | Ottiene o imposta il nome del segnalibro che contrassegna un intervallo di pagine inserito come numero di pagina della voce. |
Result { get; set; } | Ottiene o imposta il testo compreso tra il separatore di campo e la fine del campo. |
Separator { get; } | Ottiene il nodo che rappresenta il separatore di campo. Può esserenullo . |
ShortCitation { get; set; } | Ottiene o imposta la citazione breve per la voce. |
Start { get; } | Ottiene il nodo che rappresenta l’inizio del campo. |
virtual Type { get; } | Ottiene il tipo di campo Microsoft Word. |
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
Definisce il testo e il numero di pagina per una voce della tabella delle autorità, utilizzata da un campo TOA.
Esempi
Mostra come creare e personalizzare una tabella di autorità utilizzando i campi TOA e TA.
public void FieldTOA()
{
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Inserisci un campo TOA, che creerà una voce per ciascun campo TA nel documento,
// visualizza citazioni lunghe e numeri di pagina per ciascuna voce.
FieldToa fieldToa = (FieldToa)builder.InsertField(FieldType.FieldTOA, false);
// Imposta la categoria di voce per la nostra tabella. Questo TOA ora includerà solo i campi TA
// che hanno un valore corrispondente nella proprietà EntryCategory.
fieldToa.EntryCategory = "1";
// Inoltre, la categoria della Tabella delle autorità nell'indice 1 è "Casi",
// che apparirà come titolo della nostra tabella se impostiamo questa variabile su true.
fieldToa.UseHeading = true;
// Possiamo filtrare ulteriormente i campi TA nominando un segnalibro che dovrà rientrare nei limiti del TOA.
fieldToa.BookmarkName = "MyBookmark";
// Per impostazione predefinita, tra la citazione del campo TA viene visualizzata una scheda con linea tratteggiata a livello di pagina
// e il suo numero di pagina. Possiamo sostituirlo con qualsiasi testo inserito in questa proprietà.
// L'inserimento di un carattere di tabulazione manterrà la tabulazione originale.
fieldToa.EntrySeparator = " \t p.";
// Se abbiamo più voci TA che condividono la stessa citazione lunga,
// tutti i rispettivi numeri di pagina verranno visualizzati su una riga.
// Possiamo usare questa proprietà per specificare una stringa che separerà i numeri di pagina.
fieldToa.PageNumberListSeparator = " & p. ";
// Possiamo impostarlo su true per fare in modo che la nostra tabella visualizzi la parola "passim"
// se ci sono cinque o più numeri di pagina in una riga.
fieldToa.UsePassim = true;
// Un campo TA può fare riferimento a un intervallo di pagine.
// Possiamo specificare qui una stringa da visualizzare tra i numeri di pagina iniziale e finale per tali intervalli.
fieldToa.PageRangeSeparator = " to ";
// Il formato dei campi TA verrà trasferito nella nostra tabella.
// Possiamo disabilitarlo impostando il flag RemoveEntryFormatting.
fieldToa.RemoveEntryFormatting = true;
builder.Font.Color = Color.Green;
builder.Font.Name = "Arial Black";
Assert.AreEqual(" TOA \\c 1 \\h \\b MyBookmark \\e \" \t p.\" \\l \" & p. \" \\p \\g \" to \" \\f", fieldToa.GetFieldCode());
builder.InsertBreak(BreakType.PageBreak);
// Questo campo TA non apparirà come voce nel TOA poiché è esterno
// i limiti del segnalibro specificati dalla proprietà BookmarkName del TOA.
FieldTA fieldTA = InsertToaEntry(builder, "1", "Source 1");
Assert.AreEqual(" TA \\c 1 \\l \"Source 1\"", fieldTA.GetFieldCode());
// Questo campo TA è all'interno del segnalibro,
// ma la categoria della voce non corrisponde a quella della tabella, quindi il campo TA non la includerà.
builder.StartBookmark("MyBookmark");
fieldTA = InsertToaEntry(builder, "2", "Source 2");
// Questa voce apparirà nella tabella.
fieldTA = InsertToaEntry(builder, "1", "Source 3");
// Una tabella TOA non mostra citazioni brevi,
// ma possiamo usarli come abbreviazione per fare riferimento a nomi di fonti voluminosi a cui fanno riferimento più campi TA.
fieldTA.ShortCitation = "S.3";
Assert.AreEqual(" TA \\c 1 \\l \"Source 3\" \\s S.3", fieldTA.GetFieldCode());
// Possiamo formattare il numero di pagina in grassetto/corsivo utilizzando le seguenti proprietà.
// Vedremo comunque questi effetti se impostiamo la nostra tabella in modo che ignori la formattazione.
fieldTA = InsertToaEntry(builder, "1", "Source 2");
fieldTA.IsBold = true;
fieldTA.IsItalic = true;
Assert.AreEqual(" TA \\c 1 \\l \"Source 2\" \\b \\i", fieldTA.GetFieldCode());
// Possiamo configurare i campi TA per fare in modo che le loro voci TOA facciano riferimento a un intervallo di pagine su cui si estende un segnalibro.
// Nota che questa voce si riferisce alla stessa fonte di quella sopra per condividere una riga nella nostra tabella.
// Questa riga avrà il numero di pagina della voce sopra e l'intervallo di pagine di questa voce,
// con l'elenco delle pagine della tabella e i separatori dell'intervallo dei numeri di pagina tra i numeri di pagina.
fieldTA = InsertToaEntry(builder, "1", "Source 3");
fieldTA.PageRangeBookmarkName = "MyMultiPageBookmark";
builder.StartBookmark("MyMultiPageBookmark");
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);
builder.InsertBreak(BreakType.PageBreak);
builder.EndBookmark("MyMultiPageBookmark");
Assert.AreEqual(" TA \\c 1 \\l \"Source 3\" \\r MyMultiPageBookmark", fieldTA.GetFieldCode());
// Se abbiamo abilitato la funzione "Passim" della nostra tabella, la presenza di 5 o più voci TA con la stessa origine la invocherà.
for (int i = 0; i < 5; i++)
{
InsertToaEntry(builder, "1", "Source 4");
}
builder.EndBookmark("MyBookmark");
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.TOA.TA.docx");
}
private static FieldTA InsertToaEntry(DocumentBuilder builder, string entryCategory, string longCitation)
{
FieldTA field = (FieldTA)builder.InsertField(FieldType.FieldTOAEntry, false);
field.EntryCategory = entryCategory;
field.LongCitation = longCitation;
builder.InsertBreak(BreakType.PageBreak);
return field;
}
Guarda anche
- class Field
- spazio dei nomi Aspose.Words.Fields
- assemblea Aspose.Words