StructuredDocumentTag

StructuredDocumentTag class

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

Pour en savoir plus, visitez leBalises de documents structurés ou contrôle de contenu article de documentation.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Constructeurs

Nom	La description
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel)	Initialise une nouvelle instance duBalise 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 du bloc de construction pour celaSDT node. Ne peut pas êtrenul .
BuildingBlockGallery { get; set; }	Spécifie le type de bloc de construction pour celaSDT . Ne peut pas êtrenul .
CalendarType { get; set; }	Spécifie le type de calendrier pour celaSDT . La valeur par défaut estDefault
Checked { get; set; }	Obtient/Définit l’état actuel de la case à cocherSDT . La valeur par défaut de cette propriété estFAUX .
Color { get; set; }	Obtient ou définit la couleur de la balise du document structuré.
ContentsFont { get; }	Formatage de police qui sera appliqué au texte saisi dansSDT .
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.
DateDisplayLocale { get; set; }	Permet de définir/obtenir le format de langue pour la date affichée dans ceSDT .
DateStorageFormat { get; set; }	Obtient/définit le format dans lequel la date d’un SDT de date est stockée lorsque leSDT 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 appartient ce nœud.
EndCharacterFont { get; }	Formatage de police qui sera appliqué au dernier caractère du texte saisiSDT .
FirstChild { get; }	Obtient le premier enfant du nœud.
FullDate { get; set; }	Spécifie la date et l’heure complètes de la dernière saisie dans ceSDT .
HasChildNodes { get; }	Retoursvrai si ce nœud a des nœuds enfants.
Id { get; }	Spécifie un identifiant numérique persistant unique en lecture seule pour celaSDT.
override IsComposite { get; }	Retoursvrai car ce nœud peut avoir des nœuds enfants.
IsShowingPlaceholderText { get; set; }	Spécifie si le contenu de ceSDT doit être interprété comme contenant du texte d’espace réservé (par opposition au contenu de texte normal dans le SDT).
IsTemporary { get; set; }	Spécifie si celaSDT sera supprimé du document WordProcessingML lorsque son contenu sera modifié.
LastChild { get; }	Obtient le dernier enfant du nœud.
Level { get; }	Obtient le niveau auquel ceciSDT se produit dans l’arborescence du document.
ListItems { get; }	ObtientSdtListItemCollection associé à celaSDT .
LockContentControl { get; set; }	Lorsqu’il est défini survrai , cette propriété interdira à un utilisateur de supprimer ceciSDT .
LockContents { get; set; }	Lorsqu’il est défini survrai , cette propriété interdira à un utilisateur de modifier le contenu de ceSDT .
Multiline { get; set; }	Spécifie si celaSDT permet plusieurs lignes de texte.
NextSibling { get; }	Obtient le nœud suivant immédiatement ce nœud.
override NodeType { get; }	RetoursStructuredDocumentTag .
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 élément ou leIsShowingPlaceholderText l’élément estvrai .
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 unRangeobjet qui représente la partie d’un document contenue dans ce nœud.
SdtType { get; }	Obtient le type de ceciBalise 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 êtrenul .
Title { get; set; }	Spécifie le nom convivial associé à ceciSDT . Ne peut pas êtrenul .
WordOpenXML { get; }	Obtient une chaîne qui représente le XML contenu dans le nœud dans leFlatOpc format.
WordOpenXMLMinimal { get; }	Obtient une chaîne qui représente le XML contenu dans le nœud dans leFlatOpc format. Contrairement auWordOpenXML propriété, cette méthode génère un document simplifié qui exclut toutes les parties non liées au contenu.
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.
override AcceptEnd(DocumentVisitor)	Accepte un visiteur pour visiter la fin du StructuredDocumentTag.
override AcceptStart(DocumentVisitor)	Accepte un visiteur pour visiter le début du StructuredDocumentTag.
AppendChild<T>(T)	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()	Crée un navigateur qui peut être utilisé pour parcourir et lire les nœuds.
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 active de nœuds enfants qui correspondent au type spécifié.
GetEnumerator()	Fournit un support pour 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<T>(T, Node)	Insère le nœud spécifié immédiatement après le nœud de référence spécifié.
InsertBefore<T>(T, Node)	Insère le nœud spécifié immédiatement avant le nœud de référence spécifié.
NextPreOrder(Node)	Obtient le nœud suivant selon l’algorithme de parcours de l’arbre de pré-ordre.
PrependChild<T>(T)	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<T>(T)	Supprime le nœud enfant spécifié.
RemoveSelfOnly()	Supprime uniquement ce nœud SDT lui-même, mais conserve son 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 premierNode 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 en utilisant les options de sauvegarde spécifiées.

Remarques

Les balises de document structurées (SDT) permettent d’intégrer une 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é à l’aide de leXmlMapping propriété.

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

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

Exemples

Montre comment travailler avec des 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ée.
// 1 - Appliquer un objet de style 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érencer 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;

    Console.WriteLine(sdt.WordOpenXMLMinimal);

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

Voir également

• class CompositeNode
• interface IStructuredDocumentTag
• espace de noms Aspose.Words.Markup
• Assemblée Aspose.Words