DocumentPropertyCollection

DocumentPropertyCollection class

Basklass förBuiltInDocumentProperties ochCustomDocumentProperties samlingar.

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

public abstract class DocumentPropertyCollection : IEnumerable<DocumentProperty>

Egenskaper

namnBeskrivning
Count { get; }Hämtar antalet objekt i samlingen.
Item { get; }Returnerar enDocumentProperty objekt av index.
virtual Item { get; }Returnerar enDocumentProperty objekt med egenskapens namn.

Metoder

namnBeskrivning
Clear()Tar bort alla egenskaper från samlingen.
Contains(string)Returersann om en egenskap med det angivna namnet finns i samlingen.
GetEnumerator()Returnerar ett uppräknarobjekt som kan användas för att iterera över alla objekt i samlingen.
IndexOf(string)Hämtar indexet för en egenskap efter namn.
Remove(string)Tar bort en egenskap med det angivna namnet från samlingen.
RemoveAt(int)Tar bort en egenskap vid det angivna indexet.

Anmärkningar

Namnen på egenskaperna är inte skiftlägeskänsliga.

Egenskaperna i samlingen är sorterade alfabetiskt efter namn.

Exempel

Visar hur man arbetar med ett dokuments anpassade egenskaper.

Document doc = new Document();
CustomDocumentProperties properties = doc.CustomDocumentProperties;

Assert.AreEqual(0, properties.Count);

// Anpassade dokumentegenskaper är nyckel-värde-par som vi kan lägga till i dokumentet.
properties.Add("Authorized", true);
properties.Add("Authorized By", "John Doe");
properties.Add("Authorized Date", DateTime.Today);
properties.Add("Authorized Revision", doc.BuiltInDocumentProperties.RevisionNumber);
properties.Add("Authorized Amount", 123.45);

// Samlingen sorterar de anpassade egenskaperna i alfabetisk ordning.
Assert.AreEqual(1, properties.IndexOf("Authorized Amount"));
Assert.AreEqual(5, properties.Count);

// Skriv ut alla anpassade egenskaper i dokumentet.
using (IEnumerator<DocumentProperty> enumerator = properties.GetEnumerator())
{
    while (enumerator.MoveNext())
        Console.WriteLine($"Name: \"{enumerator.Current.Name}\"\n\tType: \"{enumerator.Current.Type}\"\n\tValue: \"{enumerator.Current.Value}\"");
}

// Visa värdet för en anpassad egenskap med hjälp av ett DOCPROPERTY-fält.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocProperty field = (FieldDocProperty)builder.InsertField(" DOCPROPERTY \"Authorized By\"");
field.Update();

Assert.AreEqual("John Doe", field.Result);

// Vi hittar dessa anpassade egenskaper i Microsoft Word via "Arkiv" -> "Egenskaper" > "Avancerade egenskaper" > "Anpassad".
doc.Save(ArtifactsDir + "DocumentProperties.DocumentPropertyCollection.docx");

// Nedan följer tre sätt att ta bort anpassade egenskaper från ett dokument.
// 1 - Ta bort via index:
properties.RemoveAt(1);

Assert.False(properties.Contains("Authorized Amount"));
Assert.AreEqual(4, properties.Count);

// 2 - Ta bort efter namn:
properties.Remove("Authorized Revision");

Assert.False(properties.Contains("Authorized Revision"));
Assert.AreEqual(3, properties.Count);

// 3 - Töm hela samlingen på en gång:
properties.Clear();

Assert.AreEqual(0, properties.Count);

Se även

DocumentProperty Class DocumentSecurity Enum