StructuredDocumentTag

StructuredDocumentTag class

Stellt ein strukturiertes Dokument-Tag (SDT oder Inhaltssteuerelement) in einem Dokument dar.

Um mehr zu erfahren, besuchen Sie dieStrukturierte Dokument-Tags oder Inhaltssteuerung Dokumentationsartikel.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Konstrukteure

Name	Beschreibung
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel)	Initialisiert eine neue Instanz desStrukturiertes Dokument-Tag Klasse.

Eigenschaften

Name	Beschreibung
Appearance { get; set; }	Ruft das Erscheinungsbild eines strukturierten Dokument-Tags ab/legt es fest.
BuildingBlockCategory { get; set; }	Gibt die Kategorie des Bausteins für diesesSDT node. Kann nichtnull .
BuildingBlockGallery { get; set; }	Gibt den Typ des Bausteins für diesesSDT . Kann nicht seinnull .
CalendarType { get; set; }	Gibt den Kalendertyp für diesesSDT . Standard istDefault
Checked { get; set; }	Ruft den aktuellen Status des Kontrollkästchens ab/setzt ihnSDT . Der Standardwert für diese Eigenschaft istFALSCH .
Color { get; set; }	Ruft die Farbe des strukturierten Dokument-Tags ab oder legt sie fest.
ContentsFont { get; }	Schriftformatierung, die auf den eingegebenen Text angewendet wirdSDT .
Count { get; }	Ruft die Anzahl der unmittelbar untergeordneten Elemente dieses Knotens ab.
CustomNodeId { get; set; }	Gibt die benutzerdefinierte Knotenkennung an.
DateDisplayFormat { get; set; }	Zeichenfolge, die das Format darstellt, in dem Datumsangaben angezeigt werden.
DateDisplayLocale { get; set; }	Ermöglicht das Festlegen/Abrufen des Sprachformats für das in diesemSDT .
DateStorageFormat { get; set; }	Ruft das Format ab, in dem das Datum für ein Datums-SDT gespeichert wird, wenn dieSDT ist an einen XML-Knoten im Datenspeicher des Dokuments gebunden. Der Standardwert istDateTime
virtual Document { get; }	Ruft das Dokument ab, zu dem dieser Knoten gehört.
EndCharacterFont { get; }	Schriftformatierung, die auf das letzte Zeichen des eingegebenen Textes angewendet wirdSDT .
FirstChild { get; }	Ruft das erste untergeordnete Element des Knotens ab.
FullDate { get; set; }	Gibt das vollständige Datum und die Uhrzeit der letzten Eingabe in diesesSDT .
HasChildNodes { get; }	RückgabenWAHR wenn dieser Knoten untergeordnete Knoten hat.
Id { get; }	Gibt eine eindeutige, schreibgeschützte, persistente numerische ID für diesesSDT.
override IsComposite { get; }	RückgabenWAHR da dieser Knoten untergeordnete Knoten haben kann.
IsShowingPlaceholderText { get; set; }	Gibt an, ob der Inhalt dieserSDT muss so interpretiert werden, dass es Platzhaltertext enthält (im Gegensatz zu regulärem Textinhalt innerhalb des SDT).
IsTemporary { get; set; }	Gibt an, ob dieseSDT soll aus dem WordProcessingML-Dokument entfernt werden, wenn sein Inhalt geändert wird.
LastChild { get; }	Ruft das letzte untergeordnete Element des Knotens ab.
Level { get; }	Ruft die Ebene ab, auf der diesesSDT tritt im Dokumentbaum auf.
ListItems { get; }	Ruft abSdtListItemCollection damit verbundenSDT .
LockContentControl { get; set; }	Wenn eingestellt aufWAHR , verhindert diese Eigenschaft, dass ein Benutzer dieseSDT .
LockContents { get; set; }	Wenn eingestellt aufWAHR , verhindert diese Eigenschaft, dass ein Benutzer den Inhalt dieserSDT .
Multiline { get; set; }	Gibt an, ob dieseSDT erlaubt mehrere Textzeilen.
NextSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
override NodeType { get; }	RückgabenStructuredDocumentTag .
ParentNode { get; }	Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
Placeholder { get; }	Ruft dieBuildingBlock Enthält Platzhaltertext, der angezeigt werden soll, wenn der Inhalt dieses SDT-Laufs leer ist, das zugehörige zugeordnete XML-Element leer ist, wie über dieXmlMapping element oder dasIsShowingPlaceholderText Element istWAHR .
PlaceholderName { get; set; }	Ruft den Namen desBuildingBlock mit Platzhaltertext.
PreviousSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar vorausgeht.
Range { get; }	Gibt einenRangeObjekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
SdtType { get; }	Ruft den Typ diesesStrukturiertes Dokument-Tag .
Style { get; set; }	Ruft den Stil des strukturierten Dokument-Tags ab oder legt ihn fest.
StyleName { get; set; }	Ruft den Namen des Stils ab, der auf das strukturierte Dokument-Tag angewendet wird, oder legt ihn fest.
Tag { get; set; }	Gibt ein Tag an, das mit dem aktuellen SDT-Knoten verknüpft ist. Kann nichtnull .
Title { get; set; }	Gibt den Anzeigenamen an, der mit diesemSDT . Kann nicht seinnull .
WordOpenXML { get; }	Ruft eine Zeichenfolge ab, die das XML darstellt, das im Knoten imFlatOpc format.
WordOpenXMLMinimal { get; }	Ruft eine Zeichenfolge ab, die das XML darstellt, das im Knoten imFlatOpc format. Im Gegensatz zu denWordOpenXML Diese Methode generiert ein abgespecktes Dokument, das alle nicht inhaltsbezogenen Teile ausschließt.
XmlMapping { get; }	Ruft ein Objekt ab, das die Zuordnung dieses strukturierten Dokumenttags zu XML-Daten in einem benutzerdefinierten XML-Teil des aktuellen Dokuments darstellt.

Methoden

Name	Beschreibung
override Accept(DocumentVisitor)	Nimmt einen Besucher auf.
override AcceptEnd(DocumentVisitor)	Akzeptiert einen Besucher für den Besuch des Endes des StructuredDocumentTag.
override AcceptStart(DocumentVisitor)	Akzeptiert einen Besucher für den Besuch des Anfangs des StructuredDocumentTag.
AppendChild<T>(T)	Fügt den angegebenen Knoten am Ende der Liste der untergeordneten Knoten für diesen Knoten hinzu.
Clear()	Löscht den Inhalt dieses strukturierten Dokument-Tags und zeigt einen Platzhalter an, falls dieser definiert ist.
Clone(bool)	Erstellt ein Duplikat des Knotens.
CreateNavigator()	Erstellt einen Navigator, der zum Durchlaufen und Lesen von Knoten verwendet werden kann.
GetAncestor(NodeType)	Ruft den ersten Vorfahren des angegebenenNodeType .
GetAncestor(Type)	Ruft den ersten Vorgänger des angegebenen Objekttyps ab.
GetChild(NodeType, int, bool)	Gibt einen N-ten untergeordneten Knoten zurück, der dem angegebenen Typ entspricht.
GetChildNodes(NodeType, bool)	Gibt eine Live-Sammlung von untergeordneten Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator()	Bietet Unterstützung für die Iteration des For-Each-Stils über die untergeordneten Knoten dieses Knotens.
override GetText()	Ruft den Text dieses Knotens und aller seiner untergeordneten Knoten ab.
IndexOf(Node)	Gibt den Index des angegebenen untergeordneten Knotens im untergeordneten Knoten-Array zurück.
InsertAfter<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar nach dem angegebenen Referenzknoten ein.
InsertBefore<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar vor dem angegebenen Referenzknoten ein.
NextPreOrder(Node)	Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
PrependChild<T>(T)	Fügt den angegebenen Knoten am Anfang der Liste der untergeordneten Knoten für diesen Knoten hinzu.
PreviousPreOrder(Node)	Ruft den vorherigen Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
Remove()	Entfernt sich selbst vom übergeordneten Element.
RemoveAllChildren()	Entfernt alle untergeordneten Knoten des aktuellen Knotens.
RemoveChild<T>(T)	Entfernt den angegebenen untergeordneten Knoten.
RemoveSelfOnly()	Entfernt nur diesen SDT-Knoten selbst, behält aber seinen Inhalt im Dokumentbaum.
RemoveSmartTags()	Entfernt alleSmartTag Nachkommenknoten des aktuellen Knotens.
SelectNodes(string)	Wählt eine Liste von Knoten aus, die dem XPath-Ausdruck entsprechen.
SelectSingleNode(string)	Wählt den erstenNode das dem XPath-Ausdruck entspricht.
SetCheckedSymbol(int, string)	Legt das Symbol fest, das zur Darstellung des aktivierten Status eines Kontrollkästchen-Inhaltssteuerelements verwendet wird.
SetUncheckedSymbol(int, string)	Legt das Symbol fest, das zur Darstellung des deaktivierten Status eines Kontrollkästchen-Inhaltssteuerelements verwendet wird.
ToString(SaveFormat)	Exportiert den Inhalt des Knotens in eine Zeichenfolge im angegebenen Format.
ToString(SaveOptions)	Exportiert den Inhalt des Knotens unter Verwendung der angegebenen Speicheroptionen in eine Zeichenfolge.

Bemerkungen

Strukturierte Dokument-Tags (SDTs) ermöglichen die Einbettung kundendefinierter Semantik sowie des Verhaltens und Erscheinungsbilds in ein Dokument.

In dieser Version bietet Aspose.Words eine Reihe öffentlicher Methoden und Eigenschaften, um das Verhalten und den Inhalt vonStructuredDocumentTag . Die Zuordnung von SDT-Knoten zu benutzerdefinierten XML-Paketen innerhalb eines Dokuments kann mithilfe von erfolgen.XmlMapping Eigentum.

StructuredDocumentTag kann in einem Dokument an folgenden Stellen vorkommen:

• Blockebene - Zwischen Absätzen und Tabellen, als Kind einesBody ,HeaderFooter , Comment ,Footnote oder einShape Knoten.
• Zeilenebene - Unter den Zeilen einer Tabelle, als Kind einerTable Knoten.
• Zellenebene - Unter den Zellen einer Tabellenzeile als Kind einerRow Knoten.
• Inline-Ebene - Unter Inline-Inhalten innerhalb, als Kind einesParagraph.
• Ineinander verschachteltStructuredDocumentTag.

Beispiele

Zeigt, wie mit Stilen für Inhaltssteuerelemente gearbeitet wird.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Unten finden Sie zwei Möglichkeiten, einen Stil aus dem Dokument auf ein strukturiertes Dokument-Tag anzuwenden.
// 1 – Wenden Sie ein Stilobjekt aus der Stilsammlung des Dokuments an:
Style quoteStyle = doc.Styles[StyleIdentifier.Quote];
StructuredDocumentTag sdtPlainText =
    new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline) { Style = quoteStyle };

// 2 - Verweisen Sie im Dokument anhand des Namens auf einen Stil:
StructuredDocumentTag sdtRichText =
    new StructuredDocumentTag(doc, SdtType.RichText, MarkupLevel.Inline) { StyleName = "Quote" };

builder.InsertNode(sdtPlainText);
builder.InsertNode(sdtRichText);

Assert.AreEqual(NodeType.StructuredDocumentTag, sdtPlainText.NodeType);

NodeCollection tags = doc.GetChildNodes(NodeType.StructuredDocumentTag, true);

foreach (Node node in tags)
{
    StructuredDocumentTag sdt = (StructuredDocumentTag)node;

    Console.WriteLine(sdt.WordOpenXMLMinimal);

    Assert.AreEqual(StyleIdentifier.Quote, sdt.Style.StyleIdentifier);
    Assert.AreEqual("Quote", sdt.StyleName);
}

Siehe auch

• class CompositeNode
• interface IStructuredDocumentTag
• namensraum Aspose.Words.Markup
• Montage Aspose.Words