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 avTagg för strukturerat dokument klass.

Egenskaper

namn	Beskrivning
Appearance { get; set; }	Hämtar/ställer in utseendet på en strukturerad dokumenttagg.
BuildingBlockCategory { get; set; }	Anger kategori för byggsten för dettaSDT nod. Kan inte varanull .
BuildingBlockGallery { get; set; }	Anger typ av byggsten för dettaSDT . Kan inte varanull .
CalendarType { get; set; }	Anger kalendertypen för dettaSDT . Standard ärDefault
Checked { get; set; }	Hämtar/ställer in aktuellt tillstånd 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 matas in iSDT .
Count { get; }	Hämtar antalet omedelbara barn till denna nod.
CustomNodeId { get; set; }	Anger anpassad nodidentifierare.
DateDisplayFormat { get; set; }	Sträng som representerar formatet i vilket datum visas.
DateDisplayLocale { get; set; }	Gör det möjligt att ställa in/hämta språkformat för datumet som visas i dettaSDT .
DateStorageFormat { get; set; }	Hämtar/ställer in formatet i vilket datumet för en 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 texten som matas in iSDT .
FirstChild { get; }	Hämtar nodens första barn.
FullDate { get; set; }	Anger det fullständiga datumet och den senast inmatade tiden i dettaSDT .
HasChildNodes { get; }	Returersann om den här noden har några undernoder.
Id { get; }	Anger ett unikt skrivskyddat, beständigt numeriskt ID för dettaSDT.
override IsComposite { get; }	Returersann eftersom denna nod kan ha underordnade noder.
IsShowingPlaceholderText { get; set; }	Anger om innehållet i dettaSDT ska tolkas som att innehålla platshållartext (i motsats till vanligt textinnehåll inom SDT).
IsTemporary { get; set; }	Anger om dettaSDT ska tas bort från WordProcessingML-dokumentet när dess innehåll ändras.
LastChild { get; }	Hämtar nodens sista barn.
Level { get; }	Hämtar nivån vid vilken dettaSDT förekommer i dokumentträdet.
ListItems { get; }	FårSdtListItemCollection i samband med dettaSDT .
LockContentControl { get; set; }	När den är inställd påsann , kommer den här egenskapen att förhindra att en användare tar bort dettaSDT .
LockContents { get; set; }	När den är inställd påsann , kommer den här egenskapen att förhindra att en användare redigerar innehållet i dettaSDT .
Multiline { get; set; }	Anger om dettaSDT tillåter flera rader text.
NextSibling { get; }	Hämtar noden som följer direkt efter denna nod.
override NodeType { get; }	ReturerStructuredDocumentTag .
ParentNode { get; }	Hämtar den omedelbara föräldern till denna nod.
Placeholder { get; }	HämtarBuildingBlock innehåller platshållartext som ska visas när innehållet i denna SDT-körning är tomt, det associerade mappade XML-elementet är tomt enligt anvisningarna viaXmlMapping element ellerIsShowingPlaceholderText elementet ärsann .
PlaceholderName { get; set; }	Hämtar eller anger namnet påBuildingBlock innehåller platshållartext.
PreviousSibling { get; }	Hämtar noden som omedelbart föregår denna nod.
Range { get; }	Returnerar enRangeobjekt som representerar den del av ett dokument som finns i denna nod.
SdtType { get; }	Hämtar typ av dettaTagg för strukturerat dokument .
Style { get; set; }	Hämtar eller ställer in stilen för den strukturerade dokumenttaggen.
StyleName { get; set; }	Hämtar eller anger namnet på den stil som tillämpas på den strukturerade dokumenttaggen.
Tag { get; set; }	Anger en tagg som är associerad med den aktuella SDT-noden. Kan intenull .
Title { get; set; }	Anger det användarvänliga namnet som är associerat med dettaSDT . Kan inte varanull .
WordOpenXML { get; }	Hämtar en sträng som representerar XML-koden som finns i noden iFlatOpc format.
WordOpenXMLMinimal { get; }	Hämtar en sträng som representerar XML-koden som finns i noden iFlatOpc format. Till skillnad frånWordOpenXML egenskapen 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)	Tar emot en besökare.
override AcceptEnd(DocumentVisitor)	Accepterar en besökare för att besöka slutet av StructuredDocumentTag.
override AcceptStart(DocumentVisitor)	Accepterar en besökare för att besöka början av StructuredDocumentTag.
AppendChild<T>(T)	Lägger till den angivna noden i slutet av listan över underordnade noder för denna nod.
Clear()	Rensar innehållet i den här strukturerade dokumenttaggen och visar en platshållare om den är definierad.
Clone(bool)	Skapar en duplikat av noden.
CreateNavigator()	Skapar en 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 live-samling av underordnade noder som matchar den angivna typen.
GetEnumerator()	Ger stöd för iterationen för varje stil över de underordnade noderna till denna nod.
override GetText()	Hämtar texten för denna nod och alla dess underordnade noder.
IndexOf(Node)	Returnerar indexet för den angivna undernoden i undernodsmatrisen.
InsertAfter<T>(T, Node)	Infogar den angivna noden omedelbart efter den angivna referensnoden.
InsertBefore<T>(T, 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ädtraversering.
PrependChild<T>(T)	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 trädtraversering i förbeställning.
Remove()	Tar bort sig själv från föräldern.
RemoveAllChildren()	Tar bort alla undernoder till den aktuella noden.
RemoveChild<T>(T)	Tar bort den angivna undernoden.
RemoveSelfOnly()	Tar bort endast denna SDT-nod, men behåller dess innehåll i dokumentträdet.
RemoveSmartTags()	Tar bort allaSmartTag underordnade 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)	Anger symbolen som används för att representera det markerade tillståndet för en innehållskontroll för kryssrutor.
SetUncheckedSymbol(int, string)	Anger symbolen som används för att representera det okontrollerade tillståndet för en innehållskontroll i kryssrutan.
ToString(SaveFormat)	Exporterar nodens innehåll till en sträng i det angivna formatet.
ToString(SaveOptions)	Exporterar nodens innehåll till en sträng med de angivna sparalternativen.

Anmärkningar

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

den här versionen tillhandahåller Aspose.Words ett antal publika metoder och egenskaper för att manipulera beteendet och innehållet hosStructuredDocumentTag . Mappning av SDT-noder till anpassade XML-paket i ett dokument kan utföras med hjälp av XmlMapping egendom.

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

• Blocknivå - Bland stycken och tabeller, som underordnad till enBody ,HeaderFooter , Comment ,Footnote eller enShape nod.
• Radnivå - Bland rader i en tabell, som underordnad till enTable nod.
• Cellnivå - Bland celler i en tabellrad, som underordnad till enRow nod.
• Inline-nivå - Bland inline-innehåll inuti, som underordnad enhet 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 följer 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 med 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