VariableCollection

VariableCollection class

En samling dokumentvariabler.

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

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

Egenskaper

namnBeskrivning
Count { get; }Hämtar antalet element som finns i samlingen.
Item { get; set; }Hämtar eller anger en dokumentvariabel med det skiftlägeskänsliga namnet. nullvärden är inte tillåtna som höger sida av uppgiften och kommer att ersättas med en tom sträng. (2 indexers)

Metoder

namnBeskrivning
Add(string, string)Lägger till en dokumentvariabel i samlingen.
Clear()Tar bort alla element från samlingen.
Contains(string)Avgör om samlingen innehåller en dokumentvariabel med det angivna namnet.
GetEnumerator()Returnerar ett uppräknarobjekt som kan användas för att iterera över alla variabler i samlingen.
IndexOfKey(string)Returnerar det nollbaserade indexet för den angivna dokumentvariabeln i samlingen.
Remove(string)Tar bort en dokumentvariabel med det angivna namnet från samlingen.
RemoveAt(int)Tar bort en dokumentvariabel vid det angivna indexet.

Anmärkningar

Variabelnamn och värden är strängar.

Variabelnamn är inte skiftlägeskänsliga.

Exempel

Visar hur man arbetar med ett dokuments variabelsamling.

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

// Varje dokument har en samling av nyckel/värde-parvariabler, som vi kan lägga till objekt till.
variables.Add("Home address", "123 Main St.");
variables.Add("City", "London");
variables.Add("Bedrooms", "3");

Assert.AreEqual(3, variables.Count);

// Vi kan visa värdena för variabler i dokumentets innehåll med hjälp av DOCVARIABLE-fält.
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);

// Att tilldela värden till befintliga nycklar kommer att uppdatera dem.
variables.Add("Home address", "456 Queen St.");

// Vi måste sedan uppdatera DOCVARIABLE-fälten för att säkerställa att de visar ett aktuellt värde.
Assert.AreEqual("123 Main St.", field.Result);

field.Update();

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

// Verifiera att dokumentvariablerna med ett visst namn eller värde finns.
Assert.True(variables.Contains("City"));
Assert.True(variables.Any(v => v.Value == "London"));

// Samlingen av variabler sorterar automatiskt variabler alfabetiskt efter namn.
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"]);

// Räkna upp över samlingen av variabler.
using (IEnumerator<KeyValuePair<string, string>> enumerator = doc.Variables.GetEnumerator())
    while (enumerator.MoveNext())
        Console.WriteLine($"Name: {enumerator.Current.Key}, Value: {enumerator.Current.Value}");

// Nedan följer tre sätt att ta bort dokumentvariabler från en samling.
// 1 - Efter namn:
variables.Remove("City");

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

// 2 - Enligt index:
variables.RemoveAt(1);

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

// 3 - Rensa hela samlingen på en gång:
variables.Clear();

Assert.AreEqual(0, variables.Count);

Se även

UnsupportedFileFormatException Class VisitorAction Enum