StructuredDocumentTag

StructuredDocumentTag class

Rappresenta un tag di documento strutturato (SDT o controllo del contenuto) in un documento.

Per saperne di più, visita ilTag di documenti strutturati o controllo dei contenuti articolo di documentazione.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Costruttori

Nome	Descrizione
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel)	Inizializza una nuova istanza diTag del documento strutturato classe.

Proprietà

Nome	Descrizione
Appearance { get; set; }	Ottiene/imposta l’aspetto di un tag di documento strutturato.
BuildingBlockCategory { get; set; }	Specifica la categoria del blocco di costruzione per questoSDT node. Non può esserenull .
BuildingBlockGallery { get; set; }	Specifica il tipo di blocco di costruzione per questoSDT . Non può esserenull .
CalendarType { get; set; }	Specifica il tipo di calendario per questoSDT . Il valore predefinito èDefault
Checked { get; set; }	Ottiene/imposta lo stato corrente della casella di controlloSDT . Il valore predefinito per questa proprietà èfalso .
Color { get; set; }	Ottiene o imposta il colore del tag del documento strutturato.
ContentsFont { get; }	Formattazione del carattere che verrà applicata al testo immesso inSDT .
Count { get; }	Ottiene il numero di figli immediati di questo nodo.
CustomNodeId { get; set; }	Specifica l’identificatore del nodo personalizzato.
DateDisplayFormat { get; set; }	Stringa che rappresenta il formato in cui vengono visualizzate le date.
DateDisplayLocale { get; set; }	Consente di impostare/ottenere il formato della lingua per la data visualizzata in questoSDT .
DateStorageFormat { get; set; }	Ottiene/imposta il formato in cui viene memorizzata la data per una data SDT quandoSDT è legato a un nodo XML nell’archivio dati del documento. Il valore predefinito èDateTime
virtual Document { get; }	Ottiene il documento a cui appartiene questo nodo.
EndCharacterFont { get; }	Formattazione del carattere che verrà applicata all’ultimo carattere del testo immesso inSDT .
FirstChild { get; }	Ottiene il primo figlio del nodo.
FullDate { get; set; }	Specifica la data e l’ora complete inserite per l’ultima volta in questoSDT .
HasChildNodes { get; }	RestituisceVERO se questo nodo ha nodi figlio.
Id { get; }	Specifica un ID numerico persistente di sola lettura univoco per questoSDT.
override IsComposite { get; }	RestituisceVERO poiché questo nodo può avere nodi figlio.
IsShowingPlaceholderText { get; set; }	Specifica se il contenuto di questoSDT deve essere interpretato come contenente testo segnaposto (al contrario dei normali contenuti di testo all’interno dell’SDT).
IsTemporary { get; set; }	Specifica se questoSDT verrà rimosso dal documento WordProcessingML quando il suo contenuto viene modificato.
LastChild { get; }	Ottiene l’ultimo figlio del nodo.
Level { get; }	Ottiene il livello a cui questoSDT si verifica nell’albero del documento.
ListItems { get; }	OttieneSdtListItemCollection associato a questoSDT .
LockContentControl { get; set; }	Quando impostato suVERO , questa proprietà impedirà a un utente di eliminare questoSDT .
LockContents { get; set; }	Quando impostato suVERO , questa proprietà impedirà a un utente di modificare il contenuto di questoSDT .
Multiline { get; set; }	Specifica se questoSDT consente più righe di testo.
NextSibling { get; }	Ottiene il nodo immediatamente successivo a questo nodo.
override NodeType { get; }	RestituisceStructuredDocumentTag .
ParentNode { get; }	Ottiene il genitore immediato di questo nodo.
Placeholder { get; }	Ottiene ilBuildingBlock contenente testo segnaposto che dovrebbe essere visualizzato quando il contenuto di questa esecuzione SDT è vuoto, l’elemento XML mappato associato è vuoto come specificato tramiteXmlMapping elemento o ilIsShowingPlaceholderText l’elemento èVERO .
PlaceholderName { get; set; }	Ottiene o imposta il nome delBuildingBlock contenente testo segnaposto.
PreviousSibling { get; }	Ottiene il nodo immediatamente precedente questo nodo.
Range { get; }	Restituisce unRangeoggetto che rappresenta la porzione di un documento contenuta in questo nodo.
SdtType { get; }	Ottiene il tipo di questoTag del documento strutturato .
Style { get; set; }	Ottiene o imposta lo stile del tag del documento strutturato.
StyleName { get; set; }	Ottiene o imposta il nome dello stile applicato al tag del documento strutturato.
Tag { get; set; }	Specifica un tag associato al nodo SDT corrente. Non può esserenull .
Title { get; set; }	Specifica il nome descrittivo associato a questoSDT . Non può esserenull .
WordOpenXML { get; }	Ottiene una stringa che rappresenta l’XML contenuto nel nodo inFlatOpc formato.
WordOpenXMLMinimal { get; }	Ottiene una stringa che rappresenta l’XML contenuto nel nodo inFlatOpc format. A differenza delWordOpenXML proprietà, questo metodo genera un documento ridotto che esclude tutte le parti non correlate al contenuto.
XmlMapping { get; }	Ottiene un oggetto che rappresenta la mappatura di questo tag di documento strutturato ai dati XML in una parte XML personalizzata del documento corrente.

Metodi

Nome	Descrizione
override Accept(DocumentVisitor)	Accetta un visitatore.
override AcceptEnd(DocumentVisitor)	Accetta un visitatore per aver visitato la fine dello StructuredDocumentTag.
override AcceptStart(DocumentVisitor)	Accetta un visitatore per aver visitato l’inizio dello StructuredDocumentTag.
AppendChild<T>(T)	Aggiunge il nodo specificato alla fine dell’elenco dei nodi figlio per questo nodo.
Clear()	Cancella il contenuto di questo tag di documento strutturato e visualizza un segnaposto se definito.
Clone(bool)	Crea un duplicato del nodo.
CreateNavigator()	Crea un navigatore che può essere utilizzato per attraversare e leggere i nodi.
GetAncestor(NodeType)	Ottiene il primo antenato dell’oggetto specificatoNodeType .
GetAncestor(Type)	Ottiene il primo antenato del tipo di oggetto specificato.
GetChild(NodeType, int, bool)	Restituisce un N-esimo nodo figlio che corrisponde al tipo specificato.
GetChildNodes(NodeType, bool)	Restituisce una raccolta live di nodi figlio che corrispondono al tipo specificato.
GetEnumerator()	Fornisce supporto per ogni iterazione di stile sui nodi figlio di questo nodo.
override GetText()	Ottiene il testo di questo nodo e di tutti i suoi figli.
IndexOf(Node)	Restituisce l’indice del nodo figlio specificato nell’array dei nodi figlio.
InsertAfter<T>(T, Node)	Inserisce il nodo specificato subito dopo il nodo di riferimento specificato.
InsertBefore<T>(T, Node)	Inserisce il nodo specificato immediatamente prima del nodo di riferimento specificato.
NextPreOrder(Node)	Ottiene il nodo successivo in base all’algoritmo di attraversamento dell’albero preordinato.
PrependChild<T>(T)	Aggiunge il nodo specificato all’inizio dell’elenco dei nodi figlio per questo nodo.
PreviousPreOrder(Node)	Ottiene il nodo precedente secondo l’algoritmo di attraversamento dell’albero preordinato.
Remove()	Si rimuove dal genitore.
RemoveAllChildren()	Rimuove tutti i nodi figlio del nodo corrente.
RemoveChild<T>(T)	Rimuove il nodo figlio specificato.
RemoveSelfOnly()	Rimuove solo questo nodo SDT, ma ne mantiene il contenuto all’interno dell’albero del documento.
RemoveSmartTags()	Rimuove tuttoSmartTag nodi discendenti del nodo corrente.
SelectNodes(string)	Seleziona un elenco di nodi che corrispondono all’espressione XPath.
SelectSingleNode(string)	Seleziona il primoNode che corrisponde all’espressione XPath.
SetCheckedSymbol(int, string)	Imposta il simbolo utilizzato per rappresentare lo stato selezionato di un controllo del contenuto della casella di controllo.
SetUncheckedSymbol(int, string)	Imposta il simbolo utilizzato per rappresentare lo stato non selezionato di un controllo del contenuto di una casella di controllo.
ToString(SaveFormat)	Esporta il contenuto del nodo in una stringa nel formato specificato.
ToString(SaveOptions)	Esporta il contenuto del nodo in una stringa utilizzando le opzioni di salvataggio specificate.

Osservazioni

I tag di documento strutturato (SDT) consentono di incorporare la semantica definita dal cliente, nonché il suo comportamento e aspetto, in un documento.

In questa versione Aspose.Words fornisce una serie di metodi e proprietà pubbliche per manipolare il comportamento e il contenuto diStructuredDocumentTag . La mappatura dei nodi SDT su pacchetti XML personalizzati all’interno di un documento può essere eseguita utilizzando XmlMapping proprietà.

StructuredDocumentTag può verificarsi in un documento nei seguenti punti:

• A livello di blocco - Tra paragrafi e tabelle, come figlio di unBody ,HeaderFooter , Comment ,Footnote o unShape nodo.
• Livello di riga - Tra le righe di una tabella, come figlio di unaTable nodo.
• A livello di cella - Tra le celle in una riga di tabella, come figlio di unaRow nodo.
• Livello in linea - Tra i contenuti in linea all’interno, come figlio di unParagraph.
• Annidato dentro un altroStructuredDocumentTag.

Esempi

Mostra come lavorare con gli stili per gli elementi di controllo del contenuto.

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

// Di seguito sono riportati due modi per applicare uno stile dal documento a un tag di documento strutturato.
// 1 - Applica un oggetto stile dalla raccolta stili del documento:
Style quoteStyle = doc.Styles[StyleIdentifier.Quote];
StructuredDocumentTag sdtPlainText =
    new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline) { Style = quoteStyle };

// 2 - Riferimento a uno stile nel documento tramite il nome:
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);
}

Guarda anche

• class CompositeNode
• interface IStructuredDocumentTag
• spazio dei nomi Aspose.Words.Markup
• assemblea Aspose.Words