StructuredDocumentTag

StructuredDocumentTag class

Repräsentiert ein strukturiertes Dokument-Tag (SDT oder Content Control) in einem Dokument.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Konstrukteure

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

Eigenschaften

Name Beschreibung
Appearance { get; set; } Erhält/legt das Erscheinungsbild eines strukturierten Dokument-Tags fest.
BuildingBlockCategory { get; set; } Gibt die Kategorie des Bausteins dafür an SDT node. Darf nicht null sein.
BuildingBlockGallery { get; set; } Gibt den Typ des Bausteins dafür an SDT . darf nicht null sein.
CalendarType { get; set; } Gibt den Kalendertyp dafür an SDT . Standard istDefault
Checked { get; set; } Ruft/Setzt den aktuellen Status der Checkbox SDT . Der Standardwert für diese Eigenschaft ist „false“.
ChildNodes { get; } Ruft alle unmittelbar untergeordneten Knoten dieses Knotens ab.
Color { get; set; } Ruft die Farbe des strukturierten Dokument-Tags ab oder legt sie fest.
ContentsFont { get; } Schriftartformatierung, die auf den eingegebenen Text angewendet wird SDT .
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. Darf nicht null sein. Die Daten für Englisch (US) sind “MM/TT/JJJJ”.
DateDisplayLocale { get; set; } Ermöglicht das Festlegen/Abrufen des Sprachformats für das darin angezeigte Datum SDT .
DateStorageFormat { get; set; } Ruft/legt das Format ab, in dem das Datum für einen Datums-SDT gespeichert wird, wenn der SDT ist an einen XML-Knoten im Datenspeicher des Dokuments gebunden. 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 wird SDT .
FirstChild { get; } Ruft das erste untergeordnete Element des Knotens ab.
FullDate { get; set; } Gibt das vollständige Datum und die letzte Uhrzeit an, die hierin eingegeben wurden SDT .
HasChildNodes { get; } Gibt wahr zurück, wenn dieser Knoten untergeordnete Knoten hat.
Id { get; } Gibt eine eindeutige, schreibgeschützte, persistente numerische ID dafür an SDT.
override IsComposite { get; } Gibt wahr zurück, da dieser Knoten untergeordnete Knoten haben kann.
IsShowingPlaceholderText { get; set; } Gibt an, ob der Inhalt dieser SDT soll so interpretiert werden, dass es Platzhaltertext enthält (im Gegensatz zu regulären Textinhalten innerhalb des SDT).
IsTemporary { get; set; } Gibt an, ob dies SDT muss 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, bei der dies der Fall ist SDT kommt im Dokumentbaum vor.
ListItems { get; } erhältSdtListItemCollection damit verbunden SDT .
LockContentControl { get; set; } Wenn diese Eigenschaft auf „true“ gesetzt ist, verhindert sie, dass ein Benutzer dies löscht SDT .
LockContents { get; set; } Wenn diese Eigenschaft auf „true“ gesetzt ist, verbietet es einem Benutzer, den Inhalt von this zu bearbeiten SDT .
Multiline { get; set; } Gibt an, ob dies SDT erlaubt mehrere Textzeilen.
NextSibling { get; } Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
override NodeType { get; } gibt zurück NodeType.StructuredDocumentTag .
ParentNode { get; } Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
Placeholder { get; } Ruft die abBuildingBlock Platzhaltertext enthält, der angezeigt werden soll, wenn der Inhalt dieses SDT-Laufs leer ist, das zugeordnete zugeordnete XML-Element leer ist, wie über angegebenXmlMapping element oder dieIsShowingPlaceholderText Element ist wahr.
PlaceholderName { get; set; } Ruft den Namen der ab oder legt ihn festBuildingBlock mit Platzhaltertext.
PreviousSibling { get; } Ruft den Knoten unmittelbar vor diesem Knoten ab.
Range { get; } Gibt a zurück Bereich Objekt, das den Teil eines Dokuments darstellt, das in diesem Knoten enthalten ist.
SdtType { get; } Ruft diesen Typ ab Strukturiertes 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 dem aktuellen SDT-Knoten zugeordnet ist. Darf nicht null sein.
Title { get; set; } Gibt den zugehörigen Anzeigenamen an SDT . Darf nicht null sein.
WordOpenXML { get; } Ruft eine Zeichenfolge ab, die das XML darstellt, das im Knoten in der enthalten istFlatOpc format.
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, falls definiert.
Clone(bool) Erstellt ein Duplikat des Knotens.
CreateNavigator() Reserviert für Systemnutzung. IXPfadNavigierbar.
GetAncestor(NodeType) Ruft den ersten Vorfahren der 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 von untergeordneten Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator() Bietet Unterstützung für die Iteration für jeden Stil über die untergeordneten Knoten dieses Knotens.
override GetText() Ruft den Text dieses Knotens und aller seiner Kinder ab.
IndexOf(Node) Gibt den Index des angegebenen untergeordneten Knotens im untergeordneten Knotenarray 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 Traversalalgorithmus des Vorbestellungsbaums 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 Traversalalgorithmus des Vorbestellungsbaums 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 alleSmartTag Nachkommenknoten des aktuellen Knotens.
SelectNodes(string) Wählt eine Liste von Knoten aus, die mit dem XPath-Ausdruck übereinstimmen.
SelectSingleNode(string) Wählt den ersten Knoten aus, der mit dem XPath-Ausdruck übereinstimmt.
SetCheckedSymbol(int, string) Legt das Symbol fest, das zur Darstellung des aktivierten Zustands 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 unter Verwendung der angegebenen Speicheroptionen in einen String.

Bemerkungen

Strukturierte Dokument-Tags (SDTs) ermöglichen es, kundendefinierte Semantik sowie deren -Verhalten und -Erscheinungsbild in ein Dokument einzubetten.

In dieser Version bietet Aspose.Words eine Reihe von öffentlichen Methoden und Eigenschaften, um das Verhalten und den Inhalt von zu manipulierenStructuredDocumentTag . Die Zuordnung von SDT-Knoten zu benutzerdefinierten XML-Paketen innerhalb eines Dokuments kann mit 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.
  • Zellenebene - Zwischen Zellen in einer Tabellenzeile, als untergeordnetes Element von aRow Knoten.
  • Inline-Ebene - Unter Inline-Inhalten als untergeordnetes Element von aParagraph.
  • Verschachtelt in einem anderenStructuredDocumentTag.

Beispiele

Zeigt, wie Sie mit Stilen für Inhaltssteuerelemente arbeiten.

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

// Im Folgenden finden Sie zwei Möglichkeiten, einen Stil aus dem Dokument auf ein strukturiertes Dokument-Tag anzuwenden.
// 1 - Wende 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 - 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;

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

Siehe auch