Arbeiten mit Kommentaren
In diesem Thema wird die Open XML SDK für Office-Klasse Comment und ihre Beziehung zum PresentationML-Schema des Open XML-Dateiformats erläutert. Weitere Informationen zur Gesamtstruktur der Teile und Elemente eines PresentationML-Dokuments finden Sie unter Struktur eines PresentationML-Dokuments.
Kommentare in PresentationML
Die SPEZIFIKATION ISO/IEC 29500 beschreibt den Abschnitt Comments des Open XML PresentationML-Frameworks wie folgt:
Ein Kommentar ist eine an eine Folie angefügte Textnotiz und hat den Hauptzweck, den Lesern der Präsentation die Möglichkeit zu bieten, dem Autor der Präsentation Feedback zu geben. Jeder Kommentar besteht aus einer unformatierten Textzeichenfolge sowie Informationen zum Autor und ist an einer bestimmten Stelle einer Folie angefügt. Kommentare können beim Bearbeiten der Bildschirmpräsentation sichtbar sein, sie werden jedoch beim Halten der Präsentation nicht angezeigt. Die anzeigende Anwendung bestimmt, wann Kommentare angezeigt werden sollen, und deren visuelle Darstellung.
Die ISO/IEC 29500-Spezifikation beschreibt das Open XML PresentationML-Element <cm/> , das zur Darstellung von Kommentaren in einem PresentationML-Dokument verwendet wird, wie folgt:
Dieses Element gibt einen einzelnen an eine Folie angefügten Kommentar an. Es enthält den Text des Kommentars, seine Position auf der Folie und die Attribute bezüglich Autor und Datum.
Beispiel:
<p:cm authorId="0" dt="2006-08-28T17:26:44.129" idx="1">
<p:pos x="10" y="10"/>
<p:text\>Add diagram to clarify.</p:text>
</p:cm>
In der folgenden Tabelle sind die untergeordneten Elemente des Elements aufgeführt, die <cm/> beim Arbeiten mit Kommentaren verwendet werden, und die Open XML SDK-Klassen, die ihnen entsprechen.
| PresentationML-Element | Open XML SDK-Klasse |
|---|---|
<extLst/> |
ExtensionListWithModification |
<pos/> |
Position |
<text/> |
Text |
The following table from the ISO/IEC 29500 specification describes the attributes of the <cm/> element.
| Attribute | Beschreibung |
|---|---|
| authorId | Dieses Attribut gibt den Autor des Kommentars an. Er bezieht sich auf die ID eines Autors in der Kommentarautorliste für das Dokument. Die möglichen Werte für dieses Attribut werden durch den W3C-XML-Schemadatentyp unsignedInt definiert. |
| Dt | Dieses Attribut gibt das Datum und die Uhrzeit der letzten Änderung dieses Kommentars an. Die möglichen Werte für dieses Attribut werden durch den W3C-XML-Schemadatentyp datetime definiert. |
| idx | Dieses Attribut gibt eine Kennung dieses Kommentars an, die in einer Liste aller Kommentare dieses Autors in diesem Dokument eindeutig ist. Der erste Kommentar eines Autors in einem Dokument hat den Index 1. Hinweis: Da der Index nur für den Kommentarautor eindeutig ist, kann ein Dokument mehrere Kommentare mit demselben Index enthalten, der von verschiedenen Autoren erstellt wurde. Die möglichen Werte dieses Attributs werden durch den einfachen Typ ST_Index angegeben (§19.7.3). |
Open XML SDK Comment-Klasse
Die OXML SDK-Klasse Comment stellt das Element dar, das <cm/> im Open XML-Dateiformatschema für PresentationML-Dokumente definiert ist. Verwenden Sie die Comment -Klasse, um einzelne <cm/> Elemente in einem PresentationML-Dokument zu bearbeiten.
Klassen, die untergeordnete Elemente des <cm/> Elements darstellen und daher häufig der Comment Klasse zugeordnet sind, werden in der folgenden Liste angezeigt.
ExtensionListWithModification-Klasse
Die ExtensionListWithModification -Klasse entspricht dem <extLst/>-Element. Die folgenden Informationen aus der SPEZIFIKATION ISO/IEC 29500 führen das <extLst/> Element ein:
Dieses Element gibt die Erweiterungsliste mit Änderungsmöglichkeit an, in der alle zukünftigen Erweiterungen des Elementtyps <ext/> definiert sind. Die Erweiterung wird gemeinsam mit den entsprechenden künftigen Erweiterungen genutzt, um die Speicherfähigkeit des PresentationML-Frameworks zu vergrößern. Dadurch können verschiedene neue Arten von Daten systeminhärent im Framework gespeichert werden.
Hinweis
Mithilfe dieses extLst Elements kann die generierende Anwendung speichern, ob diese Erweiterungseigenschaft geändert wurde. Endnote
Position-Klasse
Die Position -Klasse entspricht dem <pos/>-Element. Die folgenden Informationen aus der SPEZIFIKATION ISO/IEC 29500 führen das <pos/> Element ein:
Dieses Element gibt die Positionierungsinformationen zum Platzieren eines Kommentars auf einer Folienoberfläche an. In LNR-Versionen der generierenden Anwendung sollten sich die Positionsinformationen auf den oberen linken Punkt der Kommentarform beziehen. In RNL-Versionen der generierenden Anwendung sollten sich diese Positionsinformationen auf den oberen rechten Punkt der Kommentarform beziehen.
[Hinweis: Der Ankerpunkt auf der Folienoberfläche ist von einer Änderung des Layouts von rechts nach links oder von links nach rechts nicht betroffen. Dies bedeutet, dass der Ankerpunkt für alle Sprachversionen identisch ist. Ende des Hinweises]
[Hinweis: Da es keine angegebene Größe oder Formatierung für Kommentare gibt, kann dieses Benutzeroberflächenwidget, das zum Anzeigen eines Kommentars verwendet wird, eine beliebige Größe aufweisen. Daher wird der untere rechte Punkt der Kommentarform davon bestimmt, wie die Anzeigeanwendung Kommentare anzeigt. Ende des Hinweises]
[Beispiel: <p:pos x="1426" y="660"/> Endbeispiel]
Text-Klasse
Die Text -Klasse entspricht dem <text/> -Element. Die folgenden Informationen aus der SPEZIFIKATION ISO/IEC 29500 führen das <text/> Element ein:
Mit diesem Element wird der Inhalt eines Kommentars angegeben. Hierbei handelt es sich um den Text, den der Autor an die Folie angefügt hat.
Die möglichen Werte für dieses Element werden durch den W3C XML-Schema-Datentyp string definiert.
Arbeiten mit der Kommentarklasse
Ein Kommentar ist eine an eine Folie angefügte Textnotiz und hat den Hauptzweck, den Lesern der Präsentation die Möglichkeit zu bieten, dem Autor der Präsentation Feedback zu geben. Jeder Kommentar besteht aus einer unformatierten Textzeichenfolge sowie Informationen zum Autor und ist an einer bestimmten Stelle einer Folie angefügt. Kommentare können beim Bearbeiten der Präsentation sichtbar sein, sie werden jedoch beim Halten der Bildschirmpräsentation nicht angezeigt. Die anzeigende Anwendung bestimmt, wann Kommentare angezeigt werden sollen, und deren visuelle Darstellung.
Wie im folgenden Codebeispiel des Open XML SDK gezeigt, ist jede instance der Comment Klasse einem instance der Klasse zugeordnet, die SlideCommentsPart einen Folienkommentarteil, einen der Teile eines PresentationML-Präsentationsdateipakets und einen Teil darstellt, der für jede Folie in einer Präsentationsdatei erforderlich ist, die Kommentare enthält. Jede Comment Klasse instance ist auch einem instance der -Klasse zugeordnet, die CommentAuthor wiederum einem ähnlich benannten Präsentationsteil zugeordnet ist, der von der CommentAuthorsPart -Klasse dargestellt wird. Kommentarautoren für eine Präsentation werden in einer Kommentarautorliste angegeben, die durch die CommentAuthorList -Klasse dargestellt wird, während Kommentare für jede Folie in einer Kommentarliste für diese Folie aufgeführt werden, die durch die CommentList -Klasse dargestellt wird.
Die Comment -Klasse, die das <cm/> -Element darstellt, ist daher auch anderen Klassen zugeordnet, die die untergeordneten Elemente des <cm/> Elements darstellen. Zu diesen Klassen gehören, wie im folgenden Codebeispiel gezeigt, die die Position Position des Kommentars relativ zur Folie angibt, und die Text -Klasse, die den Textinhalt des Kommentars angibt.
Open XML SDK-Codebeispiel
Das folgende Codesegment aus dem Artikel Vorgehensweise: Hinzufügen eines Kommentars zu einer Folie in einer Präsentation fügt einer vorhandenen Folie in einer Präsentation einen neuen Kommentarteil hinzu (wenn die Folie noch keine Kommentare enthält) und erstellt eine instance einer Open XML SDK-Klasse Comment im Folienkommentarteil. Außerdem wird dem Kommentarteil eine Kommentarliste hinzugefügt, indem eine instance der CommentList Klasse erstellt wird, sofern noch keine vorhanden ist. Dem Kommentar wird eine ID zugewiesen. Anschließend wird der Kommentarliste ein Kommentar hinzugefügt, indem ein instance der Comment Klasse erstellt und die erforderlichen Attributwerte zugewiesen werden. Darüber hinaus werden Instanzen der Klassen und Text erstellt, die Position der neuen Comment Klasse instance zugeordnet sind. Das vollständige Codebeispiel finden Sie im oben genannten Artikel.