StructuredDocumentTag

StructuredDocumentTag class

Representerar en strukturerad dokumenttagg (SDT eller innehållskontroll) i ett dokument.

För att lära dig mer, besökStrukturerade dokumenttaggar eller innehållskontroll dokumentationsartikel.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Konstruktörer

namn	Beskrivning
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel)	Initierar en ny instans avStrukturerad dokumenttagg class.

Egenskaper

namn	Beskrivning
Appearance { get; set; }	Får/ställer in utseendet på en strukturerad dokumenttagg.
BuildingBlockCategory { get; set; }	Anger kategori av byggblock för dettaSDT node. Kan inte varanull .
BuildingBlockGallery { get; set; }	Anger typ av byggblock för dettaSDT . Kan inte varanull .
CalendarType { get; set; }	Anger typen av kalender för dettaSDT . Standard ärDefault
Checked { get; set; }	Hämtar/ställer in aktuell status för kryssrutanSDT . Standardvärdet för den här egenskapen ärfalsk .
Color { get; set; }	Hämtar eller ställer in färgen på den strukturerade dokumenttaggen.
ContentsFont { get; }	Teckensnittsformatering som kommer att tillämpas på text som skrivs inSDT .
Count { get; }	Hämtar antalet omedelbara barn till denna nod.
CustomNodeId { get; set; }	Anger anpassad nodidentifierare.
DateDisplayFormat { get; set; }	Sträng som representerar formatet som datum visas i. Kan inte varanull . Datumen för engelska (USA) är “mm/dd/åååå”
DateDisplayLocale { get; set; }	Tillåter att ställa in/hämta språkformatet för datumet som visas i dennaSDT .
DateStorageFormat { get; set; }	Hämtar/ställer in format i vilket datumet för ett datum SDT lagras närSDTär bunden till en XML-nod i dokumentets datalager. Standardvärdet ärDateTime
virtual Document { get; }	Hämtar dokumentet som denna nod tillhör.
EndCharacterFont { get; }	Teckensnittsformatering som kommer att tillämpas på det sista tecknet i text som skrivs inSDT .
FirstChild { get; }	Får det första barnet i noden.
FullDate { get; set; }	Anger fullständigt datum och tid som senast angavs i dettaSDT .
HasChildNodes { get; }	ReturnerarSann om denna nod har några undernoder.
Id { get; }	Anger ett unikt skrivskyddat beständigt numeriskt ID för dettaSDT.
override IsComposite { get; }	ReturnerarSann eftersom denna nod kan ha underordnade noder.
IsShowingPlaceholderText { get; set; }	Anger om innehållet i dettaSDTska tolkas att innehålla platshållare text (i motsats till vanligt textinnehåll inom SDT).
IsTemporary { get; set; }	Anger om dettaSDT ska tas bort från WordProcessingML-dokumentet när dess contents ändras.
LastChild { get; }	Hämtar nodens sista underordnade.
Level { get; }	Får nivån på vilken dettaSDT förekommer i dokumentträdet.
ListItems { get; }	BlirSdtListItemCollection i samband med dettaSDT .
LockContentControl { get; set; }	När inställd påSann , kommer den här egenskapen att förbjuda en användare att ta bort dettaSDT .
LockContents { get; set; }	När inställd påSann , kommer den här egenskapen att förbjuda en användare från att redigera innehållet i dennaSDT .
Multiline { get; set; }	Anger om dettaSDT tillåter flera textrader.
NextSibling { get; }	Hämtar noden omedelbart efter denna nod.
override NodeType { get; }	ReturnerarStructuredDocumentTag .
ParentNode { get; }	Hämtar den omedelbara föräldern till denna nod.
Placeholder { get; }	FårBuildingBlocksom innehåller platshållartext som ska visas när detta SDT-körningsinnehåll är tomt, det associerade mappade XML-elementet är tomt som specificerats viaXmlMapping element ellerIsShowingPlaceholderText element ärSann .
PlaceholderName { get; set; }	Hämtar eller sätter Namn påBuildingBlock som innehåller platshållartext.
PreviousSibling { get; }	Hämtar noden omedelbart före denna nod.
Range { get; }	Returnerar enRange objekt som representerar den del av ett dokument som finns i denna nod.
SdtType { get; }	Får typ av dettaStrukturerad dokumenttagg .
Style { get; set; }	Hämtar eller ställer in stilen för den strukturerade dokumenttaggen.
StyleName { get; set; }	Hämtar eller ställer in namnet på stilen som tillämpas på den strukturerade dokumenttaggen.
Tag { get; set; }	Anger en tagg som är associerad med den aktuella SDT-noden. Kan inte varanull .
Title { get; set; }	Anger det vänliga namnet som är associerat med dettaSDT . Kan inte varanull .
WordOpenXML { get; }	Får en sträng som representerar XML som finns i noden iFlatOpc format.
WordOpenXMLMinimal { get; }	Får en sträng som representerar XML som finns i noden iFlatOpc format. Till skillnad frånWordOpenXMLegenskapen genererar den här metoden ett avskalat dokument som exkluderar alla delar som inte är innehållsrelaterade.
XmlMapping { get; }	Hämtar ett objekt som representerar mappningen av denna strukturerade dokumenttagg till XML data i en anpassad XML-del av det aktuella dokumentet.

Metoder

namn	Beskrivning
override Accept(DocumentVisitor)	Accepterar en besökare.
AppendChild(Node)	Lägger till den angivna noden i slutet av listan över underordnade noder för denna nod.
Clear()	Rensar innehållet i denna strukturerade dokumenttagg och visar en platshållare om den är definierad.
Clone(bool)	Skapar en dubblett av noden.
CreateNavigator()	Skapar navigator som kan användas för att korsa och läsa noder.
GetAncestor(NodeType)	Hämtar den första förfadern till den angivnaNodeType .
GetAncestor(Type)	Hämtar den första förfadern till den angivna objekttypen.
GetChild(NodeType, int, bool)	Returnerar en N:te underordnad nod som matchar den angivna typen.
GetChildNodes(NodeType, bool)	Returnerar en aktiv samling av underordnade noder som matchar den angivna typen.
GetEnumerator()	Tillhandahåller stöd för varje stiliteration över undernoderna för denna nod.
override GetText()	Hämtar texten för denna nod och alla dess underordnade.
IndexOf(Node)	Returnerar indexet för den angivna undernoden i den underordnade nodmatrisen.
InsertAfter(Node, Node)	Infogar den angivna noden omedelbart efter den angivna referensnoden.
InsertBefore(Node, Node)	Infogar den angivna noden omedelbart före den angivna referensnoden.
NextPreOrder(Node)	Hämtar nästa nod enligt algoritmen för förbeställningsträdet.
PrependChild(Node)	Lägger till den angivna noden i början av listan över underordnade noder för denna nod.
PreviousPreOrder(Node)	Hämtar föregående nod enligt algoritmen för förbeställningsträdet.
Remove()	Tar bort sig själv från föräldern.
RemoveAllChildren()	Tar bort alla undernoder för den aktuella noden.
RemoveChild(Node)	Tar bort den angivna underordnade noden.
RemoveSelfOnly()	Tar bara bort denna SDT-nod själv, men behåller innehållet i den i dokumentträdet.
RemoveSmartTags()	Tar bort allaSmartTagunderliggande noder till den aktuella noden.
SelectNodes(string)	Väljer en lista med noder som matchar XPath-uttrycket.
SelectSingleNode(string)	Väljer den förstaNode som matchar XPath-uttrycket.
SetCheckedSymbol(int, string)	Ställer in symbolen som används för att representera det kontrollerade tillståndet för en innehållskontroll i kryssrutan.
SetUncheckedSymbol(int, string)	Ställer in symbolen som används för att representera det omarkerade tillståndet för en innehållskontroll i kryssrutan.
ToString(SaveFormat)	Exporterar innehållet i noden till en sträng i angivet format.
ToString(SaveOptions)	Exporterar innehållet i noden till en sträng med de angivna sparalternativen.

Anmärkningar

Strukturerade dokumenttaggar (SDT) gör det möjligt att bädda in kunddefinierad semantik såväl som dess beteende och utseende i ett dokument.

I denna version tillhandahåller Aspose.Words ett antal offentliga metoder och egenskaper för att manipulera beteendet och innehållet iStructuredDocumentTag . Mappning av SDT-noder till anpassade XML-paket i ett dokument kan utföras med hjälp av XmlMapping fast egendom.

StructuredDocumentTag kan förekomma i ett dokument på följande platser:

• Blocknivå - Bland stycken och tabeller, som barn till enBody ,HeaderFooter , Comment ,Footnote eller aShape nod.
• Radnivå - Bland rader i en tabell, som barn till enTable nod.
• Cell-nivå - Bland celler i en tabellrad, som ett barn till enRow nod.
• Inline-level - Bland inline-innehåll inuti, som barn till enParagraph.
• Kapslad inuti en annanStructuredDocumentTag.

Exempel

Visar hur man arbetar med stilar för innehållskontrollelement.

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

// Nedan finns två sätt att tillämpa en stil från dokumentet på en strukturerad dokumenttagg.
// 1 - Använd ett stilobjekt från dokumentets stilsamling:
Style quoteStyle = doc.Styles[StyleIdentifier.Quote];
StructuredDocumentTag sdtPlainText =
    new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline) { Style = quoteStyle };

// 2 - Referera till en stil i dokumentet efter namn:
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);
}

Se även

• class CompositeNode
• interface IStructuredDocumentTag
• namnutrymme Aspose.Words.Markup
• hopsättning Aspose.Words