StructuredDocumentTag

StructuredDocumentTag class

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

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Costruttori

Nome Descrizione
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel) Inizializza una nuova istanza di Tag 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 building block per questo SDT node. Non può essere null.
BuildingBlockGallery { get; set; } Specifica il tipo di building block per questo SDT . Non può essere nullo.
CalendarType { get; set; } Specifica il tipo di calendario per questo SDT . L’impostazione predefinita èDefault
Checked { get; set; } Ottiene/imposta lo stato corrente della casella di controllo SDT . Il valore predefinito per questa proprietà è false.
ChildNodes { get; } Ottiene tutti i nodi figlio immediati di questo nodo.
Color { get; set; } Ottiene o imposta il colore del tag del documento strutturato.
ContentsFont { get; } Formattazione del carattere che verrà applicata al testo inserito SDT .
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ò essere null. Le date per l’inglese (Stati Uniti) sono “mm/gg/aaaa”
DateDisplayLocale { get; set; } Consente di impostare/ottenere il formato della lingua per la data visualizzata in questo SDT .
DateStorageFormat { get; set; } Ottiene/imposta il formato in cui viene archiviata la data per un SDT di data quando il SDT è 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 inserito SDT .
FirstChild { get; } Ottiene il primo figlio del nodo.
FullDate { get; set; } Specifica la data e l’ora complete immesse per l’ultima volta SDT .
HasChildNodes { get; } Restituisce true se questo nodo ha nodi figlio.
Id { get; } Specifica un ID numerico persistente di sola lettura univoco per questo SDT.
override IsComposite { get; } Restituisce true poiché questo nodo può avere nodi figlio.
IsShowingPlaceholderText { get; set; } Specifica se il contenuto di questo SDT deve essere interpretato per contenere testo segnaposto (al contrario dei normali contenuti di testo all’interno dell’SDT).
IsTemporary { get; set; } Specifica se questo SDT deve essere 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 questo SDT si verifica nell’albero dei documenti.
ListItems { get; } OttieneSdtListItemCollection associato a questo SDT .
LockContentControl { get; set; } Se impostata su true, questa proprietà vieterà a un utente di eliminarlo SDT .
LockContents { get; set; } Se impostata su true, questa proprietà vieterà a un utente di modificarne il contenuto SDT .
Multiline { get; set; } Specifica se questo SDT consente più righe di testo.
NextSibling { get; } Ottiene il nodo immediatamente successivo a questo nodo.
override NodeType { get; } Restituisce NodeType.StructuredDocumentTag .
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 element o ilIsShowingPlaceholderText elemento è vero.
PlaceholderName { get; set; } Ottiene o imposta il nome delBuildingBlock contenente testo segnaposto.
PreviousSibling { get; } Ottiene il nodo immediatamente precedente a questo nodo.
Range { get; } Restituisce a Gamma oggetto che rappresenta la parte di un documento contenuta in questo nodo.
SdtType { get; } Ottiene il tipo di questo Tag 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ò essere null.
Title { get; set; } Specifica il nome descrittivo associato a questo SDT . Non può essere nullo.
WordOpenXML { get; } Ottiene una stringa che rappresenta l’XML contenuto all’interno del nodo nel fileFlatOpc formato.
XmlMapping { get; } Ottiene un oggetto che rappresenta il mapping di questo tag del documento strutturato ai 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 figlio 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() Riservato per l’uso del sistema. IXPathNavigable.
GetAncestor(NodeType) Ottiene il primo predecessore dell’oggetto specificatoNodeType .
GetAncestor(Type) Ottiene il primo predecessore del tipo di oggetto specificato.
GetChild(NodeType, int, bool) Restituisce un ennesimo 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 del nodo figlio.
InsertAfter(Node, Node) Inserisce il nodo specificato subito 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 figlio 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 tuttoSmartTag nodi discendenti del nodo corrente.
SelectNodes(string) Seleziona un elenco di nodi che corrispondono all’espressione XPath.
SelectSingleNode(string) Seleziona il primo nodo 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 deselezionato 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 strutturati (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à pubblici per manipolare il comportamento e il contenuto diStructuredDocumentTag . È possibile eseguire la mappatura di nodi SDT su pacchetti XML personalizzati all’interno di un documento utilizzando XmlMapping proprietà.

StructuredDocumentTag può verificarsi in un documento nei seguenti luoghi:

  • Block-level - Tra paragrafi e tabelle, da figlio di aBody ,HeaderFooter , Comment ,Footnote o aShape nodo.
  • A 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.
  • Inline-level - Tra i contenuti inline all’interno, da figlio di aParagraph.
  • Nidificato 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 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 - Fai 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;

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

Guarda anche