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 del contenuto articolo di documentazione.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Costruttori

Nome	Descrizione
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel)	Inizializza una nuova istanza diTag 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 predefinito per questoSDT node. Non può esserenullo .
BuildingBlockGallery { get; set; }	Specifica il tipo di blocco predefinito per questoSDT . Non può esserenullo .
CalendarType { get; set; }	Specifica il tipo di calendario per questoSDT . L’impostazione predefinita è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 dei caratteri che verrà applicata al testo inseritoSDT .
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. Non può esserenullo . Le date per l’inglese (USA) sono “mm/gg/aaaa”
DateDisplayLocale { get; set; }	Permette di impostare/ottenere il formato della lingua per la data visualizzata in questoSDT .
DateStorageFormat { get; set; }	Ottiene/imposta il formato in cui viene archiviata la data per un SDT di data quandoSDTè associato 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 immessoSDT .
FirstChild { get; }	Ottiene il primo figlio del nodo.
FullDate { get; set; }	Specifica la data e l’ora complete inserite l’ultima voltaSDT .
HasChildNodes { get; }	RestituisceVERO se questo nodo ha nodi figli.
Id { get; }	Specifica un ID numerico persistente univoco di sola lettura per questoSDT.
override IsComposite { get; }	RestituisceVERO poiché questo nodo può avere nodi figli.
IsShowingPlaceholderText { get; set; }	Specifica se il contenuto di thisSDTdeve essere interpretato in modo da contenere 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 i suoi contenuti verranno modificati.
LastChild { get; }	Ottiene l’ultimo figlio del nodo.
Level { get; }	Ottiene il livello al quale thisSDT 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 eliminarloSDT .
LockContents { get; set; }	Quando impostato suVERO , questa proprietà impedirà a un utente di modificarne il contenutoSDT .
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 il fileBuildingBlockcontenente testo segnaposto che dovrebbe essere visualizzato quando i contenuti dell’esecuzione di questo SDT sono vuoti, l’elemento XML mappato associato è vuoto come specificato tramiteXmlMapping element o ilIsShowingPlaceholderText l’elemento èVERO .
PlaceholderName { get; set; }	Ottiene o imposta il nome diBuildingBlock contenente testo segnaposto.
PreviousSibling { get; }	Ottiene il nodo immediatamente precedente questo nodo.
Range { get; }	Restituisce aRange oggetto che rappresenta la porzione di documento contenuta in questo nodo.
SdtType { get; }	Ottiene il tipo di thisTag 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ò esserenullo .
Title { get; set; }	Specifica il nome descrittivo associato a questoSDT . Non può esserenullo .
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 delWordOpenXMLproprietà, questo metodo genera un documento ridotto che esclude qualsiasi parte non correlata al contenuto.
XmlMapping { get; }	Ottiene un oggetto che rappresenta la mappatura di questo tag di documento strutturato su dati XML in una parte XML personalizzata del documento corrente.

Metodi

Nome	Descrizione
override Accept(DocumentVisitor)	Accetta un visitatore.
AppendChild(Node)	Aggiunge il nodo specificato alla fine dell’elenco dei nodi secondari per questo nodo.
Clear()	Cancella il contenuto di questo tag del 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 Nesimo nodo figlio che corrisponde al tipo specificato.
GetChildNodes(NodeType, bool)	Restituisce una raccolta attiva di nodi secondari che corrispondono al tipo specificato.
GetEnumerator()	Fornisce il supporto per l’iterazione di ogni 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 di nodi figlio.
InsertAfter(Node, Node)	Inserisce il nodo specificato immediatamente dopo il nodo di riferimento specificato.
InsertBefore(Node, 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 di preordine.
PrependChild(Node)	Aggiunge il nodo specificato all’inizio dell’elenco dei nodi secondari per questo nodo.
PreviousPreOrder(Node)	Ottiene il nodo precedente in base all’algoritmo di attraversamento dell’albero di preordine.
Remove()	Si rimuove dal genitore.
RemoveAllChildren()	Rimuove tutti i nodi figlio del nodo corrente.
RemoveChild(Node)	Rimuove il nodo figlio specificato.
RemoveSelfOnly()	Rimuove solo questo nodo SDT stesso, ma ne mantiene il contenuto all’interno dell’albero del documento.
RemoveSmartTags()	Rimuove tuttoSmartTagnodi 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 di una 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 documenti strutturati (SDT) consentono di incorporare la semantica definita dal cliente, nonché il suo comportamento e l’aspetto in un documento.

In questa versione Aspose.Words fornisce una serie di metodi e proprietà pubblici 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 ilXmlMapping proprietà.

StructuredDocumentTag può verificarsi in un documento nei seguenti punti:

• Livello di blocco - Tra paragrafi e tabelle, come figlio di aBody ,HeaderFooter , Comment ,Footnote o aShape nodo.
• livello di riga: tra le righe di una tabella, come figlio di aTable nodo.
• A livello di cella: tra le celle in una riga di tabella, come figlio di aRow nodo.
• Livello in linea: tra i contenuti in linea all’interno, come figlio di aParagraph.
• Nidificato dentro un altroStructuredDocumentTag.

Esempi

Mostra come utilizzare 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 di stile dalla raccolta di stili del documento:
Style quoteStyle = doc.Styles[StyleIdentifier.Quote];
StructuredDocumentTag sdtPlainText =
    new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline) { Style = quoteStyle };

// 2 - Fa riferimento a uno stile nel documento per 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