Comment

Comment class

Représente un conteneur pour le texte d’un commentaire.

Pour en savoir plus, visitez leTravailler avec des commentaires article documentaire.

public sealed class Comment : InlineStory

Constructeurs

Nom	La description
Comment(DocumentBase)	Initialise une nouvelle instance duComment classe.
Comment(DocumentBase, string, string, DateTime)	Initialise une nouvelle instance duComment classe.

Propriétés

Nom	La description
Ancestor { get; }	Renvoie le parentComment objet. Retournul pour les commentaires de niveau supérieur.
Author { get; set; }	Renvoie ou définit le nom de l’auteur d’un commentaire.
Count { get; }	Obtient le nombre d’enfants immédiats de ce nœud.
CustomNodeId { get; set; }	Spécifie l’identifiant de nœud personnalisé.
DateTime { get; set; }	Obtient la date et l’heure auxquelles le commentaire a été fait.
virtual Document { get; }	Obtient le document auquel appartient ce nœud.
Done { get; set; }	Obtient ou définit l’indicateur indiquant que le commentaire a été marqué comme terminé.
FirstChild { get; }	Obtient le premier enfant du nœud.
FirstParagraph { get; }	Obtient le premier paragraphe de l’histoire.
Font { get; }	Donne accès au formatage de la police du caractère d’ancrage de cet objet.
HasChildNodes { get; }	Retoursvrai si ce nœud a des nœuds enfants.
Id { get; }	Obtient l’identifiant du commentaire.
Initial { get; set; }	Renvoie ou définit les initiales de l’utilisateur associé à un commentaire spécifique.
override IsComposite { get; }	Retoursvrai car ce nœud peut avoir des nœuds enfants.
IsDeleteRevision { get; }	Renvoie vrai si cet objet a été supprimé dans Microsoft Word alors que le suivi des modifications était activé.
IsInsertRevision { get; }	Renvoie vrai si cet objet a été inséré dans Microsoft Word alors que le suivi des modifications était activé.
IsMoveFromRevision { get; }	Retoursvrai si cet objet a été déplacé (supprimé) dans Microsoft Word alors que le suivi des modifications était activé.
IsMoveToRevision { get; }	Retoursvrai si cet objet a été déplacé (inséré) dans Microsoft Word alors que le suivi des modifications était activé.
LastChild { get; }	Obtient le dernier enfant du nœud.
LastParagraph { get; }	Obtient le dernier paragraphe de l’histoire.
NextSibling { get; }	Obtient le nœud suivant immédiatement ce nœud.
override NodeType { get; }	RetoursComment .
Paragraphs { get; }	Obtient une collection de paragraphes qui sont des enfants immédiats de l’histoire.
ParentNode { get; }	Obtient le parent immédiat de ce nœud.
ParentParagraph { get; }	Récupère le parentParagraph de ce nœud.
PreviousSibling { get; }	Obtient le nœud précédant immédiatement ce nœud.
Range { get; }	Renvoie unRange objet qui représente la partie d’un document contenue dans ce nœud.
Replies { get; }	Renvoie une collection deComment objets qui sont des enfants immédiats du commentaire spécifié.
override StoryType { get; }	RetoursComments .
Tables { get; }	Obtient une collection de tables qui sont des enfants immédiats de l’histoire.

Méthodes

Nom	La description
override Accept(DocumentVisitor)	Accepte un visiteur.
AddReply(string, string, DateTime, string)	Ajoute une réponse à ce commentaire.
AppendChild(Node)	Ajoute le nœud spécifié à la fin de la liste des nœuds enfants pour ce nœud.
Clone(bool)	Crée un duplicata du nœud.
CreateNavigator()	Crée un navigateur qui peut être utilisé pour parcourir et lire des nœuds.
EnsureMinimum()	Si le dernier enfant n’est pas un paragraphe, crée et ajoute un paragraphe vide.
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 la prise en charge de chaque itération de style sur les nœuds enfants de ce nœud.
override GetText()	Récupère 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é immédiatement 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é-commande.
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 traversée d’arbre de pré-commande.
Remove()	Se supprime du parent.
RemoveAllChildren()	Supprime tous les nœuds enfants du nœud actuel.
RemoveAllReplies()	Supprime toutes les réponses à ce commentaire.
RemoveChild(Node)	Supprime le nœud enfant spécifié.
RemoveReply(Comment)	Supprime la réponse spécifiée à ce commentaire.
RemoveSmartTags()	Supprime toutSmartTagnœ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.
SetText(string)	Il s’agit d’une méthode pratique qui permet de définir facilement le texte du commentaire.
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 de sauvegarde spécifiées.

Remarques

Un commentaire est une annotation ancrée à une région de texte ou à une position dans le texte. Un commentaire peut contenir une quantité arbitraire de contenu au niveau du bloc.

Si unComment l’objet apparaît tout seul, le commentaire est ancré à la position duComment objet.

Pour ancrer un commentaire à une zone de texte, trois objets sont nécessaires :Comment , CommentRangeStart etCommentRangeEnd . Les trois objets doivent partager le même Id valeur.

Comment est un nœud de niveau en ligne et ne peut être qu’un enfant deParagraph.

Comment peut contenirParagraph etTable nœuds enfants.

Exemples

Montre comment ajouter un commentaire à un paragraphe.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Hello world!");

Comment comment = new Comment(doc, "John Doe", "JD", DateTime.Today);
builder.CurrentParagraph.AppendChild(comment);
builder.MoveTo(comment.AppendChild(new Paragraph(doc)));
builder.Write("Comment text.");

Assert.AreEqual(DateTime.Today, comment.DateTime);

 // Dans Microsoft Word, nous pouvons cliquer avec le bouton droit sur ce commentaire dans le corps du document pour le modifier ou y répondre.
doc.Save(ArtifactsDir + "InlineStory.AddComment.docx");

Montre comment ajouter un commentaire à un document, puis y répondre.

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

Comment comment = new Comment(doc, "John Doe", "J.D.", DateTime.Now);
comment.SetText("My comment.");

// Place le commentaire à un nœud du corps du document.
// Ce commentaire apparaîtra à l'emplacement de son paragraphe,
// en dehors de la marge droite de la page, et avec une ligne pointillée la reliant à son paragraphe.
builder.CurrentParagraph.AppendChild(comment);

// Ajoute une réponse, qui apparaîtra sous son commentaire parent.
comment.AddReply("Joe Bloggs", "J.B.", DateTime.Now, "New reply");

// Les commentaires et les réponses sont tous deux des nœuds de commentaires.
Assert.AreEqual(2, doc.GetChildNodes(NodeType.Comment, true).Count);

// Les commentaires qui ne répondent pas aux autres commentaires sont du "niveau supérieur". Ils n'ont aucun commentaire d'ancêtre.
Assert.Null(comment.Ancestor);

// Les réponses ont un commentaire de niveau supérieur ancêtre.
Assert.AreEqual(comment, comment.Replies[0].Ancestor);

doc.Save(ArtifactsDir + "Comment.AddCommentWithReply.docx");

Voir également

• class InlineStory
• espace de noms Aspose.Words
• Assemblée Aspose.Words