StructuredDocumentTag

StructuredDocumentTag class

Représente une balise de document structurée (SDT ou contrôle de contenu) dans un document.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Constructeurs

Nom La description
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel) Initialise une nouvelle instance du Balise de document structurée classe.

Propriétés

Nom La description
Appearance { get; set; } Obtient/définit l’apparence d’une balise de document structuré.
BuildingBlockCategory { get; set; } Spécifie la catégorie de bloc de construction pour ce TDS node. Ne peut pas être null.
BuildingBlockGallery { get; set; } Spécifie le type de bloc de construction pour ce TDS . Ne peut pas être nul.
CalendarType { get; set; } Spécifie le type de calendrier pour ce TDS . La valeur par défaut estDefault
Checked { get; set; } Obtient/Définit l’état actuel de la case à cocher TDS . La valeur par défaut de cette propriété est false.
ChildNodes { get; } Obtient tous les nœuds enfants immédiats de ce nœud.
Color { get; set; } Obtient ou définit la couleur de la balise de document structuré.
ContentsFont { get; } Formatage de la police qui sera appliqué au texte saisi dans TDS .
Count { get; } Obtient le nombre d’enfants immédiats de ce nœud.
CustomNodeId { get; set; } Spécifie l’identifiant de nœud personnalisé.
DateDisplayFormat { get; set; } Chaîne qui représente le format dans lequel les dates sont affichées. Ne peut pas être nul. Les dates pour l’anglais (US) sont “mm/dd/yyyy”
DateDisplayLocale { get; set; } Permet de définir/obtenir le format de langue pour la date affichée dans ce TDS .
DateStorageFormat { get; set; } Obtient/définit le format dans lequel la date d’une date SDT est stockée lorsque le TDS est lié à un nœud XML dans le magasin de données du document. La valeur par défaut estDateTime
virtual Document { get; } Obtient le document auquel ce nœud appartient.
EndCharacterFont { get; } Formatage de la police qui sera appliqué au dernier caractère du texte saisi dans TDS .
FirstChild { get; } Obtient le premier enfant du nœud.
FullDate { get; set; } Spécifie la date et l’heure complètes saisies pour la dernière fois dans ce TDS .
HasChildNodes { get; } Renvoie vrai si ce nœud a des nœuds enfants.
Id { get; } Spécifie un identifiant numérique persistant unique en lecture seule pour ce TDS.
override IsComposite { get; } Renvoie true car ce nœud peut avoir des nœuds enfants.
IsShowingPlaceholderText { get; set; } Spécifie si le contenu de ce TDS doit être interprété comme contenant un espace réservé text (par opposition au contenu textuel normal dans le SDT).
IsTemporary { get; set; } Spécifie si cela TDS doit être supprimé du document WordProcessingML lorsque son contenu est modifié.
LastChild { get; } Obtient le dernier enfant du nœud.
Level { get; } Obtient le niveau auquel cette TDS se produit dans l’arborescence du document.
ListItems { get; } ObtientSdtListItemCollection associé à ce TDS .
LockContentControl { get; set; } Lorsqu’elle est définie sur true, cette propriété interdit à un utilisateur de supprimer ce TDS .
LockContents { get; set; } Lorsqu’elle est définie sur true, cette propriété interdit à un utilisateur de modifier le contenu de ce TDS .
Multiline { get; set; } Spécifie si cela TDS autorise plusieurs lignes de texte.
NextSibling { get; } Obtient le nœud suivant immédiatement ce nœud.
override NodeType { get; } Retours NodeType.StructuredDocumentTag .
ParentNode { get; } Obtient le parent immédiat de ce nœud.
Placeholder { get; } Obtient leBuildingBlock contenant un texte d’espace réservé qui doit être affiché lorsque le contenu de cette exécution SDT est vide, l’élément XML mappé associé est vide comme spécifié via leXmlMapping element ou leIsShowingPlaceholderText l’élément est vrai.
PlaceholderName { get; set; } Obtient ou définit le nom duBuildingBlock contenant du texte d’espace réservé.
PreviousSibling { get; } Obtient le nœud précédant immédiatement ce nœud.
Range { get; } Renvoie un Intervalle objet qui représente la partie d’un document contenue dans ce nœud.
SdtType { get; } Obtient le type de ceci Balise de document structurée .
Style { get; set; } Obtient ou définit le style de la balise de document structuré.
StyleName { get; set; } Obtient ou définit le nom du style appliqué à la balise de document structuré.
Tag { get; set; } Spécifie une balise associée au nœud SDT actuel. Ne peut pas être nul.
Title { get; set; } Spécifie le nom convivial associé à ce TDS . Ne peut pas être nul.
WordOpenXML { get; } Obtient une chaîne qui représente le XML contenu dans le nœud duFlatOpc format.
XmlMapping { get; } Obtient un objet qui représente le mappage de cette balise de document structuré aux données XML dans une partie XML personnalisée du document actuel.

Méthodes

Nom La description
override Accept(DocumentVisitor) Accepte un visiteur.
AppendChild(Node) Ajoute le nœud spécifié à la fin de la liste des nœuds enfants pour ce nœud.
Clear() Efface le contenu de cette balise de document structuré et affiche un espace réservé s’il est défini.
Clone(bool) Crée un doublon du nœud.
CreateNavigator() Réservé à l’utilisation du système. IXPathNavigable.
GetAncestor(NodeType) Obtient le premier ancêtre du spécifiéNodeType .
GetAncestor(Type) Obtient le premier ancêtre du type d’objet spécifié.
GetChild(NodeType, int, bool) Renvoie un Nième nœud enfant qui correspond au type spécifié.
GetChildNodes(NodeType, bool) Renvoie une collection dynamique de nœuds enfants correspondant au type spécifié.
GetEnumerator() Fournit la prise en charge de chaque itération de style sur les nœuds enfants de ce nœud.
override GetText() Obtient le texte de ce nœud et de tous ses enfants.
IndexOf(Node) Renvoie l’index du nœud enfant spécifié dans le tableau de nœuds enfants.
InsertAfter(Node, Node) Insère le nœud spécifié immédiatement après le nœud de référence spécifié.
InsertBefore(Node, Node) Insère le nœud spécifié juste avant le nœud de référence spécifié.
NextPreOrder(Node) Obtient le nœud suivant selon l’algorithme de traversée de l’arbre de pré-ordre.
PrependChild(Node) Ajoute le nœud spécifié au début de la liste des nœuds enfants pour ce nœud.
PreviousPreOrder(Node) Obtient le nœud précédent selon l’algorithme de parcours de l’arbre de pré-ordre.
Remove() Se supprime du parent.
RemoveAllChildren() Supprime tous les nœuds enfants du nœud actuel.
RemoveChild(Node) Supprime le nœud enfant spécifié.
RemoveSelfOnly() Supprime uniquement ce nœud SDT lui-même, mais en conserve le contenu dans l’arborescence du document.
RemoveSmartTags() Supprime toutSmartTag nœuds descendants du nœud actuel.
SelectNodes(string) Sélectionne une liste de nœuds correspondant à l’expression XPath.
SelectSingleNode(string) Sélectionne le premier nœud qui correspond à l’expression XPath.
SetCheckedSymbol(int, string) Définit le symbole utilisé pour représenter l’état coché d’un contrôle de contenu de case à cocher.
SetUncheckedSymbol(int, string) Définit le symbole utilisé pour représenter l’état non coché d’un contrôle de contenu de case à cocher.
ToString(SaveFormat) Exporte le contenu du nœud dans une chaîne au format spécifié.
ToString(SaveOptions) Exporte le contenu du nœud dans une chaîne à l’aide des options d’enregistrement spécifiées.

Remarques

Les balises de document structuré (SDT) permettent d’intégrer la sémantique définie par le client ainsi que son comportement et son apparence dans un document.

Dans cette version, Aspose.Words fournit un certain nombre de méthodes et de propriétés publiques pour manipuler le comportement et le contenu deStructuredDocumentTag . Le mappage des nœuds SDT vers des packages XML personnalisés dans un document peut être effectué en utilisant leXmlMapping propriété.

StructuredDocumentTag peut apparaître dans un document aux endroits suivants :

  • Niveau bloc - Parmi les paragraphes et les tableaux, en tant qu’enfant d’unBody ,HeaderFooter , Comment ,Footnote ou unShape nœud.
  • Niveau ligne - Parmi les lignes d’une table, en tant qu’enfant d’unTable nœud.
  • Au niveau de la cellule - Parmi les cellules d’une ligne de tableau, en tant qu’enfant d’unRow nœud.
  • Inline-level - Parmi le contenu en ligne à l’intérieur, en tant qu’enfant d’unParagraph.
  • Niché dans un autreStructuredDocumentTag.

Exemples

Montre comment utiliser les styles pour les éléments de contrôle de contenu.

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

// Vous trouverez ci-dessous deux manières d'appliquer un style du document à une balise de document structuré.
// 1 - Appliquez un objet de style à partir de la collection de styles du document :
Style quoteStyle = doc.Styles[StyleIdentifier.Quote];
StructuredDocumentTag sdtPlainText =
    new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline) { Style = quoteStyle };

// 2 - Référencez un style dans le document par son nom :
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);
}

Voir également