Captions Klasse

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Paket:

DocumentFormat.OpenXml v3.0.1

Beschriftungseinstellungen.

Diese Klasse ist in Office 2007 und höher verfügbar.

Wenn das Objekt als XML serialisiert wird, lautet der qualifizierte Name w:captions.

public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Captions = class
    inherit OpenXmlCompositeElement

Public Class Captions
Inherits OpenXmlCompositeElement

Vererbung

Object

OpenXmlElement

OpenXmlCompositeElement

Captions

Hinweise

[ISO/IEC 29500-1 1. Auflage]

captions (Caption Settings)

Dieses Element gibt das Vorhandensein von Informationen zu Beschriftungen in einem bestimmten WordprocessingML-Dokument an. Diese Informationen sind in zwei Komponenten unterteilt:

• Das untergeordnete Element Untertitel definiert das Format für einen einzelnen Typ von Untertitel, der dem Dokument automatisch hinzugefügt werden soll.

• Das untergeordnete Element autoCaptions definiert die Objekttypen, auf die automatisch ein Untertitel Format angewendet werden soll.

Diese Informationen sollten verwendet werden, um die Beschriftungen zu bestimmen, die automatisch zu Objekten hinzugefügt werden, wenn sie in ein WordprocessingML-Dokument eingefügt werden. [Hinweis: Diese Einstellung wird in der Regel ignoriert, es sei denn, sie ist in der Standardvorlage einer Anwendung angegeben. Ende des Hinweises]

[Beispiel: Betrachten Sie das folgende Diagramm, das ein WordprocessingML-Dokument veranschaulicht, das eine Tabelle enthält, die mit einer Untertitel beschriftet wurde:

9512a3b0-3be8-461e-b333-2dafe873ea54

In diesem Diagramm wurde die im WordprocessingML-Dokument enthaltene Tabelle beschriftet, indem eine Untertitel unterhalb der Tabelle eingefügt wurde, die aus der Zeichenfolge Tabelle gefolgt von einer Dezimalzahl besteht. Dies wird automatisch eingefügt, Untertitel Format mithilfe des folgenden WordprocessingML angegeben wird:

<w:captions>  
  <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />   
</w:captions>  

Hier gibt das captions-Element das Vorhandensein eines oder mehrerer Untertitel Formatein einem bestimmten WordprocessingML-Dokument an, dessen untergeordnetes Element Untertitel. Insbesondere gibt das untergeordnete Element Untertitel einen einzelnen Typ von Untertitel an, der innerhalb des WordprocessingML-Dokuments verwendet werden soll. Ende des Beispiels]

Die Beschriftung nutzt Felder (§17.16.5), um Objekte mit Verweis auf eines der folgenden Elemente zu bezeichnen:

• Andere beschriftete Objekte in einem bestimmten Dokument

• Andere beschriftete Objekte innerhalb desselben Kapitels in einem bestimmten Dokument (wenn Kapitelnummern durch Angabe des chapNum-Attributs für den Untertitel-Typ hinzugefügt werden. Ein Kapitel ist ein Textabschnitt in einem WordprocessingML-Dokument, dem Inhalt mit einer Formatvorlage vorangestellt wird, die von zum Abgrenzen von Kapiteln in Dokumenten angegeben wurde. Es kann nur eine Formatvorlage angegeben werden, die für einen einzelnen Untertitel Typ verwendet wird, um Kapitel in einem Dokument abzugrenzen. Ein Kapitel endet unmittelbar über dem nächsten instance mit dem Stil, der zum Abgrenzen von Kapiteln verwendet wird.

[Beispiel: Betrachten Sie das folgende Diagramm:

ca416e21-0d37-4bbe-9fbc-0ad6b52b74da

83cd18d0-32ad-47ac-8475-614beb06001a

Dieses Diagramm zeigt ein WordprocessingML-Dokument mit zwei Kapiteln, die jeweils zwei Tabellen mit Beschriftungen enthalten. Der mit der Kapitelabgrenzung verknüpfte Stil wurde in diesem Dokument auf die Zeichenfolgen Kapitel 1 – GJ02 und Kapitel 2 – GJ03 angewendet. Die Formatvorlage, die zum Abgrenzen von Kapiteln verwendet wird, ist die Formatvorlage, deren styleID-Attribut gleich Heading2 ist, wie durch den Überschriftenattributwert von WordprocessingML für das Untertitel Format angegeben:

<w:caption w:name="Table" w:pos="below" w:chapNum="1" w:heading="2" w:numFmt="upperLetter" w:sep="8212" />   

Mit anderen Worten, das obige WordprocessingML kann verwendet werden, um Objekte (in diesem Fall Tabellen) zu bezeichnen, die in einem bestimmten WordprocessingML-Dokument eingefügt wurden, das von einer Anwendung mit einem Untertitel bestehend aus: der Zeichenfolge Tabelle gefolgt von einer Dezimalzahl, die der Kapitelnummer entspricht, in der die Tabelle vorhanden ist, einem Bindestrich und einem englischen Großbuchstabe, der dem Index der angegebenen Tabelle innerhalb des angegebenen Kapitels entspricht. Ende des Beispiels]

[Hinweis: WordprocessingML ist so konzipiert, dass das Untertitel-Element in Verbindung mit Anwendungen verwendet werden kann, um eine dynamische Beschriftungsfunktion bereitzustellen. Anders ausgedrückt: Eine Anwendung kann wordprocessingML im obigen Beispiel verwenden, um automatisch einen Untertitel einzufügen, der aus der Zeichenfolgentabelle besteht, gefolgt von einem inkrementierenden Dezimalzahlfeld unterhalb von Tabellen, wenn Tabellen in ein WordprocessingML-Dokument eingefügt werden, wie durch das autoCaption-Element definiert (§17.15.1.7). Ende des Hinweises]

Übergeordnete Elemente
Einstellungen (§17.15.1.78)

Untergeordnete Elemente	Subclause
autoCaptions (Einstellungen für automatische Beschriftung)	§17.15.1.8
Untertitel (Definition des einzelnen Beschriftungstyps)	§17.15.1.16

[Hinweis: Die W3C-XML-Schemadefinition des Inhaltsmodells (CT_Captions) dieses Elements befindet sich in §A.1. Ende des Hinweises]

ISO/IEC29500: 2008.

Konstruktoren

Captions()	Initialisiert einen neuen instance der Captions-Klasse.
Captions(IEnumerable<OpenXmlElement>)	Initialisiert eine neue instance der Captions-Klasse mit den angegebenen untergeordneten Elementen.
Captions(OpenXmlElement[])	Initialisiert eine neue instance der Captions-Klasse mit den angegebenen untergeordneten Elementen.
Captions(String)	Initialisiert eine neue instance der Captions-Klasse aus äußerem XML.

Eigenschaften

ChildElements	Ruft alle untergeordneten Knoten des aktuellen Elements ab. (Geerbt von OpenXmlElement)
ExtendedAttributes	Ruft alle erweiterten Attribute (Attribute, die im Schema nicht definiert sind) des aktuellen Elements ab. (Geerbt von OpenXmlElement)
Features	Ruft ein IFeatureCollection für das aktuelle Element ab. Diese Featuresammlung ist schreibgeschützt, erbt jedoch Features von ihrem übergeordneten Teil und Paket, falls verfügbar. (Geerbt von OpenXmlElement)
FirstChild	Ruft das erste untergeordnete Element des aktuellen OpenXmlElement-Elements ab. (Geerbt von OpenXmlCompositeElement)
HasAttributes	Ruft einen Wert ab, der angibt, ob das aktuelle Element über Attribute verfügt. (Geerbt von OpenXmlElement)
HasChildren	Ruft einen Wert ab, der angibt, ob das aktuelle Element über untergeordnete Elemente verfügt. (Geerbt von OpenXmlCompositeElement)
InnerText	Ruft die verketteten Werte des aktuellen Knotens und aller untergeordneten Elemente ab oder legt diese fest. (Geerbt von OpenXmlCompositeElement)
InnerXml	Ruft das Markup ab, das nur die untergeordneten Knoten des aktuellen Knotens darstellt, oder legt dieses fest. (Geerbt von OpenXmlCompositeElement)
LastChild	Ruft das letzte untergeordnete Element des aktuellen OpenXmlElement-Elements ab. Gibt null (Nothing in Visual Basic) zurück, wenn kein solches OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlCompositeElement)
LocalName	Ruft den lokalen Namen des aktuellen Elements ab. (Geerbt von OpenXmlElement)
MCAttributes	Ruft die Markupkompatibilitätsattribute ab oder legt sie fest. Gibt NULL zurück, wenn für das aktuelle Element keine Markupkompatibilitätsattribute definiert sind. (Geerbt von OpenXmlElement)
NamespaceDeclarations	Ruft alle im aktuellen Element definierten Namespacedeklarationen ab. Gibt einen leeren Enumerator zurück, wenn keine Namespacedeklaration vorhanden ist. (Geerbt von OpenXmlElement)
NamespaceUri	Ruft den Namespace-URI des aktuellen Elements ab. (Geerbt von OpenXmlElement)
OpenXmlElementContext	Ruft den OpenXmlElementContext des aktuellen Elements ab. (Geerbt von OpenXmlElement)
OuterXml	Ruft das Markup ab, das das aktuelle Element und alle untergeordneten Elemente darstellt. (Geerbt von OpenXmlElement)
Parent	Ruft das übergeordnete Element des aktuellen Elements ab. (Geerbt von OpenXmlElement)
Prefix	Ruft das Namespacepräfix des aktuellen Elements ab. (Geerbt von OpenXmlElement)
XmlQualifiedName	Ruft den qualifizierten Namen des aktuellen Elements ab. (Geerbt von OpenXmlElement)
XName	Ruft den qualifizierten Namen des aktuellen Elements ab. (Geerbt von OpenXmlElement)

Methoden

AddAnnotation(Object)	Fügt der Liste der Anmerkungen des aktuellen OpenXmlElement-Elements ein -Objekt hinzu. (Geerbt von OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Fügt dem Element das angegebene Element hinzu, wenn es sich um ein bekanntes untergeordnetes Element handelt. Dadurch wird das -Element an der richtigen Position gemäß dem Schema hinzugefügt. (Geerbt von OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Fügt dem aktuellen Knoten eine Namespacedeklaration hinzu. (Geerbt von OpenXmlElement)
Ancestors()	Listet alle Vorgängerelemente des aktuellen Elements auf. (Geerbt von OpenXmlElement)
Ancestors<T>()	Listet nur die Vorgänger des aktuellen Elements auf, die den angegebenen Typ aufweisen. (Geerbt von OpenXmlElement)
Annotation(Type)	Ruft das erste Anmerkungsobjekt des angegebenen Typs aus dem aktuellen OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Annotation<T>()	Ruft das erste Anmerkungsobjekt des angegebenen Typs aus dem aktuellen OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Annotations(Type)	Ruft eine Auflistung von Anmerkungen mit dem angegebenen Typ für das aktuelle OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Annotations<T>()	Ruft eine Auflistung von Anmerkungen mit dem angegebenen Typ für das aktuelle OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Fügt jedes Element aus einer Liste von Elementen an das Ende der Liste der untergeordneten Elemente des aktuellen Elements an. (Geerbt von OpenXmlElement)
Append(OpenXmlElement[])	Fügt jedes Element aus einem Array von Elementen an das Ende der Liste der untergeordneten Elemente des aktuellen Elements an. (Geerbt von OpenXmlElement)
AppendChild<T>(T)	Fügt das angegebene Element am Ende der Liste der untergeordneten Knoten des aktuellen Elements an. (Geerbt von OpenXmlCompositeElement)
ClearAllAttributes()	Löscht alle Attribute, einschließlich bekannter und erweiterter Attribute. (Geerbt von OpenXmlElement)
Clone()	Erstellt ein Duplikat des aktuellen Knotens. (Geerbt von OpenXmlElement)
CloneNode(Boolean)	Erstellt ein Duplikat dieses Knotens.
Descendants()	Listet alle Nachfolger des aktuellen Elements auf. (Geerbt von OpenXmlElement)
Descendants<T>()	Listet alle Nachfolger des aktuellen Elements vom Typ T auf. (Geerbt von OpenXmlElement)
Elements()	Listet alle untergeordneten Elemente des aktuellen Elements auf. (Geerbt von OpenXmlElement)
Elements<T>()	Listet nur die untergeordneten Elemente des aktuellen Elements auf, die den angegebenen Typ aufweisen. (Geerbt von OpenXmlElement)
ElementsAfter()	Listet alle gleichgeordneten Elemente auf, die dem aktuellen Element folgen und dasselbe übergeordnete Element wie das aktuelle Element haben. (Geerbt von OpenXmlElement)
ElementsBefore()	Listet alle gleichgeordneten Elemente auf, die dem aktuellen Element vorausgehen und dasselbe übergeordnete Element wie das aktuelle Element haben. (Geerbt von OpenXmlElement)
GetAttribute(String, String)	Ruft ein Open XML-Attribut mit dem angegebenen Tagnamen und Namespace-URI ab. (Geerbt von OpenXmlElement)
GetAttributes()	Ruft eine Liste ab, die eine Kopie aller Attribute enthält. (Geerbt von OpenXmlElement)
GetEnumerator()	Gibt einen Enumerator zurück, der die untergeordnete Auflistung durchläuft. (Geerbt von OpenXmlElement)
GetFirstChild<T>()	Sucht das erste untergeordnete Element im Typ T. (Geerbt von OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Fügt das angegebene Element unmittelbar nach dem angegebenen Verweiselement ein. (Geerbt von OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Fügt das angegebene Element unmittelbar nach dem aktuellen Element ein. (Geerbt von OpenXmlElement)
InsertAt<T>(T, Int32)	Fügt das angegebene Element am angegebenen Index der untergeordneten Elemente des aktuellen Elements ein. (Geerbt von OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Fügt das angegebene Element unmittelbar vor dem angegebenen Verweiselement ein. (Geerbt von OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Fügt das angegebene Element unmittelbar vor dem aktuellen Element ein. (Geerbt von OpenXmlElement)
IsAfter(OpenXmlElement)	Bestimmt, ob das aktuelle Element nach einem angegebenen Element in Dokumentreihenfolge angezeigt wird. (Geerbt von OpenXmlElement)
IsBefore(OpenXmlElement)	Bestimmt, ob das aktuelle Element vor einem angegebenen Element in Dokumentreihenfolge angezeigt wird. (Geerbt von OpenXmlElement)
LookupNamespace(String)	Löst das Namespacepräfix im Kontext des aktuellen Knotens auf. (Geerbt von OpenXmlElement)
LookupPrefix(String)	Sucht das entsprechende Präfix für einen Namespace-URI im aktuellen Elementbereich. (Geerbt von OpenXmlElement)
NextSibling()	Ruft das OpenXmlElement-Element ab, das unmittelbar auf das aktuelle OpenXmlElement-Element folgt. Gibt null (Nothing in Visual Basic) zurück, wenn kein nächstes OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
NextSibling<T>()	Ruft das OpenXmlElement-Element mit dem angegebenen Typ ab, der auf das aktuelle OpenXmlElement-Element folgt. Gibt null (Nothing in Visual Basic) zurück, wenn kein nächstes OpenXmlElement vorhanden ist. (Geerbt von OpenXmlElement)
PrependChild<T>(T)	Fügt das angegebene Element am Anfang der Liste der untergeordneten Knoten des aktuellen Elements ein. (Geerbt von OpenXmlCompositeElement)
PreviousSibling()	Ruft das OpenXmlElement-Element ab, das unmittelbar vor dem aktuellen OpenXmlElement-Element steht. Gibt null (Nothing in Visual Basic ) zurück, wenn kein vorangehendes OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
PreviousSibling<T>()	Ruft das OpenXmlElement-Element mit dem angegebenen Typ ab, der dem aktuellen OpenXmlElement vorangestellt ist. Gibt null (Nothing in Visual Basic) zurück, wenn kein vorheriges OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
Remove()	Entfernt das aktuelle Element aus dem übergeordneten Element. (Geerbt von OpenXmlElement)
RemoveAllChildren()	Entfernt alle untergeordneten Elemente des aktuellen Elements. (Geerbt von OpenXmlCompositeElement)
RemoveAllChildren<T>()	Entfernen Sie alle untergeordneten Elemente des aktuellen Elements vom Typ T. (Geerbt von OpenXmlElement)
RemoveAnnotations(Type)	Entfernt die Anmerkungen des angegebenen Typs aus dem aktuellen OpenXmlElement-Element. (Geerbt von OpenXmlElement)
RemoveAnnotations<T>()	Entfernt die Anmerkungen mit dem angegebenen Typ aus dem aktuellen OpenXmlElement-Element. (Geerbt von OpenXmlElement)
RemoveAttribute(String, String)	Entfernt das Attribut aus dem aktuellen Element. (Geerbt von OpenXmlElement)
RemoveChild<T>(T)	Entfernt das angegebene untergeordnete Element. (Geerbt von OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Entfernt die Namespacedeklaration für das angegebene Präfix. Entfernt nichts, wenn kein Präfix vorhanden ist. (Geerbt von OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Ersetzt eines der untergeordneten Elemente des aktuellen Elements durch ein anderes OpenXmlElement-Element. (Geerbt von OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Legt ein Attribut auf das angegebene Element fest. Wenn das Attribut ein bekanntes Attribut ist, wird der Wert des Attributs festgelegt. Wenn es sich bei dem Attribut um ein erweitertes Attribut handelt, wird das "openxmlAttribute" der Liste der erweiterten Attribute hinzugefügt. (Geerbt von OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Legt eine Reihe von Attributen für das -Element fest. Wenn ein Attribut ein bekanntes Attribut ist, wird der Wert des Attributs festgelegt. Wenn ein Attribut ein erweitertes Attribut ist, wird das "openxmlAttribute" der Liste der erweiterten Attribute hinzugefügt. (Geerbt von OpenXmlElement)
WriteTo(XmlWriter)	Speichert den aktuellen Knoten im angegebenen XmlWriter. (Geerbt von OpenXmlElement)

Explizite Schnittstellenimplementierungen

IEnumerable.GetEnumerator()	Beschriftungseinstellungen. Diese Klasse ist in Office 2007 und höher verfügbar. Wenn das Objekt als XML serialisiert wird, lautet der qualifizierte Name w:captions. (Geerbt von OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Gibt einen Enumerator zurück, der die untergeordnete Auflistung durchläuft. (Geerbt von OpenXmlElement)