StructuredDocumentTag

StructuredDocumentTag class

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

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

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Konstrukteure

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

Eigenschaften

Name	Beschreibung
Appearance { get; set; }	Ruft das Erscheinungsbild eines strukturierten Dokument-Tags ab bzw. legt es fest.
BuildingBlockCategory { get; set; }	Gibt die Kategorie des Bausteins dafür anSDT node. Kann nicht seinNull .
BuildingBlockGallery { get; set; }	Gibt den Typ des Bausteins dafür anSDT . Kann nicht seinNull .
CalendarType { get; set; }	Gibt den Kalendertyp hierfür anSDT . Standard istDefault
Checked { get; set; }	Ruft den aktuellen Status des Kontrollkästchens ab bzw. legt diesen festSDT . Der Standardwert für diese Eigenschaft istFALSCH .
Color { get; set; }	Ruft die Farbe des strukturierten Dokument-Tags ab oder legt diese fest.
ContentsFont { get; }	Schriftartformatierung, die auf den eingegebenen Text angewendet wirdSDT .
Count { get; }	Ruft die Anzahl der unmittelbaren Kinder dieses Knotens ab.
CustomNodeId { get; set; }	Gibt die benutzerdefinierte Knotenkennung an.
DateDisplayFormat { get; set; }	Zeichenfolge, die das Format darstellt, in dem Datumsangaben angezeigt werden. Kann nicht seinNull . Das Datum für Englisch (USA) ist „mm/tt/jjjj“.
DateDisplayLocale { get; set; }	Ermöglicht das Festlegen/Abrufen des Sprachformats für das hier angezeigte DatumSDT .
DateStorageFormat { get; set; }	Ruft das Format ab bzw. legt es fest, in dem das Datum für eine Datums-SDT gespeichert wird, wenn dasSDTist 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; }	Schriftartformatierung, 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 an, die zuletzt eingegeben wurdenSDT .
HasChildNodes { get; }	Gibt zurückWAHR wenn dieser Knoten untergeordnete Knoten hat.
Id { get; }	Gibt hierfür eine eindeutige, schreibgeschützte, persistente numerische ID anSDT.
override IsComposite { get; }	Gibt zurückWAHR da dieser Knoten untergeordnete Knoten haben kann.
IsShowingPlaceholderText { get; set; }	Gibt an, ob der Inhalt davonSDTwird so interpretiert, dass es Platzhaltertext enthält (im Gegensatz zu regulären Textinhalten innerhalb des SDT).
IsTemporary { get; set; }	Gibt an, ob dies der Fall istSDT wird aus dem WordProcessingML-Dokument entfernt, wenn dessen Inhalt geändert wird.
LastChild { get; }	Ruft das letzte untergeordnete Element des Knotens ab.
Level { get; }	Ruft die Ebene ab, auf der dies geschiehtSDT kommt im Dokumentenbaum vor.
ListItems { get; }	Ruft abSdtListItemCollection damit verbundenSDT .
LockContentControl { get; set; }	Wenn eingestellt aufWAHR , verhindert diese Eigenschaft, dass ein Benutzer dies löschen kannSDT .
LockContents { get; set; }	Wenn eingestellt aufWAHR , verhindert diese Eigenschaft, dass ein Benutzer den Inhalt dieser Datei bearbeitetSDT .
Multiline { get; set; }	Gibt an, ob dies der Fall istSDT Ermöglicht mehrere Textzeilen.
NextSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
override NodeType { get; }	Gibt zurückStructuredDocumentTag .
ParentNode { get; }	Ruft das unmittelbare übergeordnete Element dieses Knotens ab.
Placeholder { get; }	Ruft die abBuildingBlockenthält Platzhaltertext, der angezeigt werden soll, wenn der Inhalt dieses SDT-Laufs leer ist, das zugehörige zugeordnete XML-Element ist leer, wie über angegebenXmlMapping element oder dieIsShowingPlaceholderText Element istWAHR .
PlaceholderName { get; set; }	Ruft den Namen ab oder legt ihn festBuildingBlock enthält Platzhaltertext.
PreviousSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar vorangeht.
Range { get; }	Gibt a zurückRange Objekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
SdtType { get; }	Ruft den Typ davon abStrukturiertes Dokument-Tag .
Style { get; set; }	Ruft den Stil des strukturierten Dokument-Tags ab oder legt diesen fest.
StyleName { get; set; }	Ruft den Namen des Stils ab, der auf das strukturierte Dokument-Tag angewendet wird, oder legt diesen fest.
Tag { get; set; }	Gibt ein Tag an, das dem aktuellen SDT-Knoten zugeordnet ist. Kann nicht seinNull .
Title { get; set; }	Gibt den damit verbundenen Anzeigenamen anSDT . Kann nicht seinNull .
WordOpenXML { get; }	Ruft eine Zeichenfolge ab, die das im Knoten im enthaltene XML darstelltFlatOpc format.
WordOpenXMLMinimal { get; }	Ruft eine Zeichenfolge ab, die das im Knoten im enthaltene XML darstelltFlatOpc format. Im Gegensatz zuWordOpenXML-Eigenschaft generiert diese Methode ein reduziertes Dokument, das alle nicht inhaltsbezogenen Teile ausschließt.
XmlMapping { get; }	Ruft ein Objekt ab, das die Zuordnung dieses strukturierten Dokument-Tags zu XML-Daten in einem benutzerdefinierten XML-Teil des aktuellen Dokuments darstellt.

Methoden

Name	Beschreibung
override Accept(DocumentVisitor)	Akzeptiert einen Besucher.
AppendChild(Node)	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, sofern 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 angegebenen abNodeType .
GetAncestor(Type)	Ruft den ersten Vorfahren 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 untergeordneter Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator()	Bietet Unterstützung für die Iteration jedes 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(Node, Node)	Fügt den angegebenen Knoten unmittelbar nach dem angegebenen Referenzknoten ein.
InsertBefore(Node, 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(Node)	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(Node)	Entfernt den angegebenen untergeordneten Knoten.
RemoveSelfOnly()	Entfernt nur diesen SDT-Knoten selbst, behält aber seinen Inhalt im Dokumentbaum.
RemoveSmartTags()	Entfernt alleSmartTagNachkommenknoten des aktuellen Knotens.
SelectNodes(string)	Wählt eine Liste von Knoten aus, die dem XPath-Ausdruck entsprechen.
SelectSingleNode(string)	Wählt den ersten ausNode das entspricht dem XPath-Ausdruck.
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 verwendet wird, um den deaktivierten Zustand eines Kontrollkästchen-Inhaltssteuerelements darzustellen.
ToString(SaveFormat)	Exportiert den Inhalt des Knotens in einen String im angegebenen Format.
ToString(SaveOptions)	Exportiert den Inhalt des Knotens mit den angegebenen Speicheroptionen in einen String.

Bemerkungen

Strukturierte Dokument-Tags (SDTs) ermöglichen die Einbettung kundenspezifischer Semantik sowie seines Verhaltens und Aussehens in ein Dokument.

In dieser Version stellt Aspose.Words eine Reihe öffentlicher Methoden und Eigenschaften bereit, um das Verhalten und den Inhalt von zu manipulierenStructuredDocumentTag . Die Zuordnung von SDT-Knoten zu benutzerdefinierten XML-Paketen innerhalb eines Dokuments kann mit using durchgeführt werdenXmlMapping Eigentum.

StructuredDocumentTag kann in einem Dokument an folgenden Stellen vorkommen:

• Blockebene – Zwischen Absätzen und Tabellen, als untergeordnetes Element von aBody ,HeaderFooter , Comment ,Footnote oder einShape Knoten.
• Zeilenebene – Zwischen Zeilen in einer Tabelle, als untergeordnetes Element von aTable Knoten.
• Zellebene – Zwischen Zellen in einer Tabellenzeile, als untergeordnetes Element von aRow Knoten.
• Inline-Ebene – Unter Inline-Inhalten im Inneren, als untergeordnetes Element von aParagraph.
• In einem anderen verschachteltStructuredDocumentTag.

Beispiele

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

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

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

// 2 – Einen Stil im Dokument namentlich referenzieren:
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