DocumentPropertyCollection

DocumentPropertyCollection class

Classe base perBuiltInDocumentProperties ECustomDocumentProperties collezioni.

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

public abstract class DocumentPropertyCollection : IEnumerable<DocumentProperty>

Proprietà

NomeDescrizione
Count { get; }Ottiene il numero di elementi nella raccolta.
Item { get; }Restituisce unDocumentProperty oggetto per indice.
virtual Item { get; }Restituisce unDocumentProperty oggetto in base al nome della proprietà.

Metodi

NomeDescrizione
Clear()Rimuove tutte le proprietà dalla raccolta.
Contains(string)RestituisceVERO se nella raccolta esiste una proprietà con il nome specificato.
GetEnumerator()Restituisce un oggetto enumeratore che può essere utilizzato per scorrere tutti gli elementi nella raccolta.
IndexOf(string)Ottiene l’indice di una proprietà in base al nome.
Remove(string)Rimuove una proprietà con il nome specificato dalla raccolta.
RemoveAt(int)Rimuove una proprietà all’indice specificato.

Osservazioni

I nomi delle proprietà non fanno distinzione tra maiuscole e minuscole.

Le proprietà nella raccolta sono ordinate alfabeticamente in base al nome.

Esempi

Mostra come lavorare con le proprietà personalizzate di un documento.

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

Assert.AreEqual(0, properties.Count);

// Le proprietà personalizzate del documento sono coppie chiave-valore che possiamo aggiungere al documento.
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);

// La raccolta ordina le proprietà personalizzate in ordine alfabetico.
Assert.AreEqual(1, properties.IndexOf("Authorized Amount"));
Assert.AreEqual(5, properties.Count);

// Stampa tutte le proprietà personalizzate nel documento.
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}\"");
}

// Visualizza il valore di una proprietà personalizzata utilizzando un campo DOCPROPERTY.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDocProperty field = (FieldDocProperty)builder.InsertField(" DOCPROPERTY \"Authorized By\"");
field.Update();

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

// Possiamo trovare queste proprietà personalizzate in Microsoft Word tramite "File" -> "Proprietà" > "Proprietà avanzate" > "Personalizzate".
doc.Save(ArtifactsDir + "DocumentProperties.DocumentPropertyCollection.docx");

// Di seguito sono riportati tre modi per rimuovere le proprietà personalizzate da un documento.
// 1 - Rimuovi per indice:
properties.RemoveAt(1);

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

// 2 - Rimuovi per nome:
properties.Remove("Authorized Revision");

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

// 3 - Svuota l'intera raccolta in una volta sola:
properties.Clear();

Assert.AreEqual(0, properties.Count);

Guarda anche

DocumentProperty Class DocumentSecurity Enum