Wie man mit benutzerdefiniertem XML Markup in .NET arbeitet

Schritt 1: Benutzerdefinierte XML-Daten aus einem Dokument lesen

Document.CustomXmlParts gibt ein CustomXmlPartCollection zurück — derselbe Mechanismus, den Word verwendet, um XML-zugeordnete Inhaltssteuerelemente zu unterstützen. Durchlaufen Sie die Sammlung oder rufen Sie GetById(id) auf, wenn Sie bereits wissen, welchen Teil Sie benötigen, um ein CustomXmlPart zu erhalten. Jeder Teil stellt Id bereit, ein Data-Byte-Array, das das rohe XML enthält, ein DataChecksum zum Erkennen, ob sich die Daten geändert haben, ohne einen vollständigen Byte-Vergleich durchzuführen, und Schemas — ein CustomXmlSchemaCollection, das die mit ihm verbundenen XML-Schemata auflistet.

Schritt 2: Einen benutzerdefinierten XML-Teil hinzufügen oder aktualisieren

Rufen Sie CustomXmlPartCollection.Add(id, xml) mit einem ID-String und dem XML-Inhalt auf, um ein Teil direkt zu erstellen, oder erzeugen Sie ein CustomXmlPart separat und übergeben es an Add(part). Um Daten zu entfernen, verwenden Sie RemoveAt(index) an einer bestimmten Position oder Clear(), um jedes Teil zu entfernen. Beim Kopieren benutzerdefinierter XML-Daten zwischen Dokumenten verwenden Sie CustomXmlPart.Clone() (oder das Clone() der Sammlung) am Quellteil, anstatt den rohen XML erneut zu lesen und hinzuzufügen, und fügen dann das Duplikat zum Document.CustomXmlParts des Zieldokuments hinzu.

Schritt 3: Verwalten der mit einem Teil verknüpften Schemas

CustomXmlPart.Schemas erreicht ein CustomXmlSchemaCollection, das die mit dem Teil verknüpften Schema-URIs als einfache Zeichenketten statt als geparste Schemaobjekte verfolgt. Verwenden Sie Add(value), um eine Schema-URI zu registrieren, Remove(name) oder RemoveAt(index), um eine zu entfernen, IndexOf(value), um eine zu finden, und Clear(), um alle zu entfernen. Count gibt an, wie viele Schema-URIs derzeit mit dem Teil verknüpft sind.

Schritt 4: Arbeiten mit benutzerdefinierten Teilen auf Paketebene

Nicht jedes nicht sichtbare Teil in einem OOXML-Paket ist ein benutzerdefiniertes XML. Document.PackageCustomParts gibt ein CustomPartCollection von CustomPart-Objekten zurück – beliebige Teile, die im Paket gespeichert sind, wie z. B. Teile, die von einer anderen Anwendung hinzugefügt wurden, die die Datei berührt hat. Jeder CustomPart hat ein Name, ContentType, RelationshipType, ein Data-Byte-Array und ein IsExternal-Flag, das angibt, ob es sich um eine externe Referenz statt eingebetteten Inhalts handelt. Add(part), RemoveAt(index) und Clear() verwalten die Sammlung auf dieselbe Weise wie CustomXmlPartCollection. Prüfen Sie PackageCustomParts – nicht CustomXmlParts – wenn ein Teil, das Ihr Dokument enthalten sollte, nicht in der benutzerdefinierten XML-Sammlung erscheint.

Schritt 5: Untersuchen von Legacy-Smart-Tags und deren Eigenschaften

SmartTag ist ein Knotentyp (NodeType.SmartTag, erstellt mit SmartTag(doc)), der ein Legacy-Word-Smart-Tag darstellt, das um erkannten Text gewickelt ist. Prüfen Sie Element und Uri zusammen, um zu ermitteln, welcher Erkenner das Tag erstellt hat, und lesen Sie dann Properties – ein CustomXmlPropertyCollection – für die strukturierten Daten, die der Erkenner angehängt hat. Innerhalb eines CustomXmlPropertyCollection suchen der Indexierer (z. B. properties["MyProp"]) oder Contains(name) eine bestimmte Eigenschaft, IndexOfKey(name) gibt deren Position zurück, und Remove(name)/RemoveAt(index)/Clear() entfernen Einträge; jedes CustomXmlProperty wird mit CustomXmlProperty(name, uri, value) erstellt und stellt Name, Uri und Value bereit. Da SmartTag von CompositeNode abgeleitet ist, nimmt es wie andere Knoten am Dokumentbaum teil und unterstützt Accept(visitor), AcceptStart(visitor) und AcceptEnd(visitor) für eine DocumentVisitor-basierte Traversierung.