VariableCollection

VariableCollection class

Una raccolta di variabili del documento.

Per saperne di più, visita ilLavorare con le proprietà del documento articolo di documentazione.

public class VariableCollection : IEnumerable<KeyValuePair<string, string>>

Proprietà

NomeDescrizione
Count { get; }Ottiene il numero di elementi contenuti nella raccolta.
Item { get; set; }Ottiene o imposta una variabile di documento in base al nome senza distinzione tra maiuscole e minuscole. null valori non sono consentiti come lato destro dell’assegnazione e saranno sostituiti da una stringa vuota. (2 indexers)

Metodi

NomeDescrizione
Add(string, string)Aggiunge una variabile di documento alla raccolta.
Clear()Rimuove tutti gli elementi dalla raccolta.
Contains(string)Determina se la raccolta contiene una variabile di documento con il nome specificato.
GetEnumerator()Restituisce un oggetto enumeratore che può essere utilizzato per scorrere tutte le variabili nella raccolta.
IndexOfKey(string)Restituisce l’indice basato su zero della variabile del documento specificata nella raccolta.
Remove(string)Rimuove una variabile di documento con il nome specificato dalla raccolta.
RemoveAt(int)Rimuove una variabile del documento all’indice specificato.

Osservazioni

I nomi e i valori delle variabili sono stringhe.

I nomi delle variabili non fanno distinzione tra maiuscole e minuscole.

Esempi

Mostra come lavorare con la raccolta di variabili di un documento.

Document doc = new Document();
VariableCollection variables = doc.Variables;

// Ogni documento ha una raccolta di variabili di coppia chiave/valore, a cui possiamo aggiungere elementi.
variables.Add("Home address", "123 Main St.");
variables.Add("City", "London");
variables.Add("Bedrooms", "3");

Assert.AreEqual(3, variables.Count);

// Possiamo visualizzare i valori delle variabili nel corpo del documento utilizzando i campi DOCVARIABLE.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocVariable field = (FieldDocVariable)builder.InsertField(FieldType.FieldDocVariable, true);
field.VariableName = "Home address";
field.Update();

Assert.AreEqual("123 Main St.", field.Result);

// L'assegnazione di valori alle chiavi esistenti le aggiornerà.
variables.Add("Home address", "456 Queen St.");

// Dovremo quindi aggiornare i campi DOCVARIABLE per garantire che visualizzino un valore aggiornato.
Assert.AreEqual("123 Main St.", field.Result);

field.Update();

Assert.AreEqual("456 Queen St.", field.Result);

// Verifica che esistano variabili del documento con un certo nome o valore.
Assert.True(variables.Contains("City"));
Assert.True(variables.Any(v => v.Value == "London"));

// La raccolta di variabili ordina automaticamente le variabili in ordine alfabetico in base al nome.
Assert.AreEqual(0, variables.IndexOfKey("Bedrooms"));
Assert.AreEqual(1, variables.IndexOfKey("City"));
Assert.AreEqual(2, variables.IndexOfKey("Home address"));

Assert.AreEqual("3", variables[0]);
Assert.AreEqual("London", variables["City"]);

// Enumera la raccolta di variabili.
using (IEnumerator<KeyValuePair<string, string>> enumerator = doc.Variables.GetEnumerator())
    while (enumerator.MoveNext())
        Console.WriteLine($"Name: {enumerator.Current.Key}, Value: {enumerator.Current.Value}");

// Di seguito sono riportati tre metodi per rimuovere le variabili del documento da una raccolta.
// 1 - Per nome:
variables.Remove("City");

Assert.False(variables.Contains("City"));

// 2 - Per indice:
variables.RemoveAt(1);

Assert.False(variables.Contains("Home address"));

// 3 - Cancella l'intera collezione in una volta sola:
variables.Clear();

Assert.AreEqual(0, variables.Count);

Guarda anche

UnsupportedFileFormatException Class VisitorAction Enum