CustomXmlPartCollection

CustomXmlPartCollection class

représente une collection de composants XML personnalisés. Les éléments sontCustomXmlPart objets.

Pour en savoir plus, visitez leBalises de documents structurés ou contrôle de contenu article de documentation.

public class CustomXmlPartCollection : IEnumerable<CustomXmlPart>

Constructeurs

NomLa description
CustomXmlPartCollection()Default_Constructor

Propriétés

NomLa description
Count { get; }Obtient le nombre d’éléments contenus dans la collection.
Item { get; set; }Obtient ou définit un élément à l’index spécifié.

Méthodes

NomLa description
Add(CustomXmlPart)Ajoute un élément à la collection.
Add(string, string)Crée une nouvelle partie XML avec le XML spécifié et l’ajoute à la collection.
Clear()Supprime tous les éléments de la collection.
Clone()Effectue une copie complète de cette collection et de ses éléments.
GetById(string)Recherche et renvoie une partie XML personnalisée par son identifiant.
GetEnumerator()Renvoie un objet énumérateur qui peut être utilisé pour parcourir tous les éléments de la collection.
RemoveAt(int)Supprime un élément à l’index spécifié.

Remarques

Il n’est généralement pas nécessaire de créer des instances de cette classe. Vous pouvez accéder aux données XML personnalisées data stockées dans un document via leCustomXmlParts propriété.

Exemples

Montre comment créer une balise de document structurée avec des données XML personnalisées.

Document doc = new Document();

// Construisez une partie XML contenant des données et ajoutez-la à la collection du document.
// Si nous activons l'onglet « Développeur » dans Microsoft Word,
// nous pouvons trouver des éléments de cette collection dans le « volet de mappage XML », ainsi que quelques éléments par défaut.
string xmlPartId = Guid.NewGuid().ToString("B");
string xmlPartContent = "<root><text>Hello world!</text></root>";
CustomXmlPart xmlPart = doc.CustomXmlParts.Add(xmlPartId, xmlPartContent);

Assert.AreEqual(Encoding.ASCII.GetBytes(xmlPartContent), xmlPart.Data);
Assert.AreEqual(xmlPartId, xmlPart.Id);

// Vous trouverez ci-dessous deux manières de faire référence aux parties XML.
// 1 - Par un index dans la collection de parties XML personnalisées :
Assert.AreEqual(xmlPart, doc.CustomXmlParts[0]);

// 2 - Par GUID :
Assert.AreEqual(xmlPart, doc.CustomXmlParts.GetById(xmlPartId));

// Ajouter une association de schéma XML.
xmlPart.Schemas.Add("http://www.w3.org/2001/XMLSchema");

// Clonez une partie, puis insérez-la dans la collection.
CustomXmlPart xmlPartClone = xmlPart.Clone();
xmlPartClone.Id = Guid.NewGuid().ToString("B");
doc.CustomXmlParts.Add(xmlPartClone);

Assert.AreEqual(2, doc.CustomXmlParts.Count);

// Parcourez la collection et imprimez le contenu de chaque partie.
using (IEnumerator<CustomXmlPart> enumerator = doc.CustomXmlParts.GetEnumerator())
{
    int index = 0;
    while (enumerator.MoveNext())
    {
        Console.WriteLine($"XML part index {index}, ID: {enumerator.Current.Id}");
        Console.WriteLine($"\tContent: {Encoding.UTF8.GetString(enumerator.Current.Data)}");
        index++;
    }
}

// Utilisez la méthode « RemoveAt » pour supprimer la partie clonée par index.
doc.CustomXmlParts.RemoveAt(1);

Assert.AreEqual(1, doc.CustomXmlParts.Count);

// Clonez la collection de pièces XML, puis utilisez la méthode « Clear » pour supprimer tous ses éléments à la fois.
CustomXmlPartCollection customXmlParts = doc.CustomXmlParts.Clone();
customXmlParts.Clear();

// Créez une balise de document structurée qui affichera le contenu de notre partie et l'insérera dans le corps du document.
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Block);
tag.XmlMapping.SetMapping(xmlPart, "/root[1]/text[1]", string.Empty);

doc.FirstSection.Body.AppendChild(tag);

doc.Save(ArtifactsDir + "StructuredDocumentTag.CustomXml.docx");

Voir également

CustomXmlPart Class CustomXmlProperty Class