Comment
Innehåll
[
Dölj
]Comment class
Representerar en behållare för text i en kommentar.
För att lära dig mer, besökArbeta med kommentarer dokumentationsartikel.
public sealed class Comment : InlineStory
Konstruktörer
| namn | Beskrivning |
|---|---|
| Comment(DocumentBase) | Initierar en ny instans avComment class. |
| Comment(DocumentBase, string, string, DateTime) | Initierar en ny instans avComment class. |
Egenskaper
| namn | Beskrivning |
|---|---|
| Ancestor { get; } | Returnerar den överordnadeComment objekt. Returnerarnull för kommentarer på toppnivå. |
| Author { get; set; } | Returnerar eller ställer in författarens namn för en kommentar. |
| Count { get; } | Hämtar antalet omedelbara barn till denna nod. |
| CustomNodeId { get; set; } | Anger anpassad nodidentifierare. |
| DateTime { get; set; } | Hämtar datum och tid då kommentaren gjordes. |
| virtual Document { get; } | Hämtar dokumentet som denna nod tillhör. |
| Done { get; set; } | Hämtar eller sätter en flagga som indikerar att kommentaren har markerats som klar. |
| FirstChild { get; } | Får det första barnet i noden. |
| FirstParagraph { get; } | Får första stycket i berättelsen. |
| Font { get; } | Ger tillgång till teckensnittsformateringen av ankartecknet för detta objekt. |
| HasChildNodes { get; } | ReturnerarSann om denna nod har några undernoder. |
| Id { get; } | Hämtar kommentarsidentifieraren. |
| Initial { get; set; } | Returnerar eller ställer in initialerna för användaren som är kopplad till en specifik kommentar. |
| override IsComposite { get; } | ReturnerarSann eftersom denna nod kan ha underordnade noder. |
| IsDeleteRevision { get; } | Returnerar sant om detta objekt raderades i Microsoft Word medan ändringsspårning var aktiverad. |
| IsInsertRevision { get; } | Returnerar sant om det här objektet infogades i Microsoft Word medan ändringsspårning var aktiverad. |
| IsMoveFromRevision { get; } | ReturnerarSann om det här objektet flyttades (borttogs) i Microsoft Word medan ändringsspårning var aktiverad. |
| IsMoveToRevision { get; } | ReturnerarSann om detta objekt flyttades (infogades) i Microsoft Word medan ändringsspårning var aktiverad. |
| LastChild { get; } | Hämtar nodens sista underordnade. |
| LastParagraph { get; } | Hämtar det sista stycket i berättelsen. |
| NextSibling { get; } | Hämtar noden omedelbart efter denna nod. |
| override NodeType { get; } | ReturnerarComment . |
| Paragraphs { get; } | Får en samling stycken som är omedelbara barn till berättelsen. |
| ParentNode { get; } | Hämtar den omedelbara föräldern till denna nod. |
| ParentParagraph { get; } | Hämtar föräldernParagraph av denna nod. |
| PreviousSibling { get; } | Hämtar noden omedelbart före denna nod. |
| Range { get; } | Returnerar enRange objekt som representerar den del av ett dokument som finns i denna nod. |
| Replies { get; } | Returnerar en samling avComment objekt som är omedelbara underordnade av den angivna kommentaren. |
| override StoryType { get; } | ReturnerarComments . |
| Tables { get; } | Får en samling tabeller som är omedelbara barn till berättelsen. |
Metoder
| namn | Beskrivning |
|---|---|
| override Accept(DocumentVisitor) | Accepterar en besökare. |
| AddReply(string, string, DateTime, string) | Lägger till ett svar på den här kommentaren. |
| AppendChild(Node) | Lägger till den angivna noden i slutet av listan över underordnade noder för denna nod. |
| Clone(bool) | Skapar en dubblett av noden. |
| CreateNavigator() | Skapar navigator som kan användas för att korsa och läsa noder. |
| EnsureMinimum() | Om det sista underordnade inte är ett stycke, skapar och lägger till ett tomt stycke. |
| GetAncestor(NodeType) | Hämtar den första förfadern till den angivnaNodeType . |
| GetAncestor(Type) | Hämtar den första förfadern till den angivna objekttypen. |
| GetChild(NodeType, int, bool) | Returnerar en N:te underordnad nod som matchar den angivna typen. |
| GetChildNodes(NodeType, bool) | Returnerar en aktiv samling av underordnade noder som matchar den angivna typen. |
| GetEnumerator() | Tillhandahåller stöd för varje stiliteration över undernoderna för denna nod. |
| override GetText() | Hämtar texten för denna nod och alla dess underordnade. |
| IndexOf(Node) | Returnerar indexet för den angivna undernoden i den underordnade nodmatrisen. |
| InsertAfter(Node, Node) | Infogar den angivna noden omedelbart efter den angivna referensnoden. |
| InsertBefore(Node, Node) | Infogar den angivna noden omedelbart före den angivna referensnoden. |
| NextPreOrder(Node) | Hämtar nästa nod enligt algoritmen för förbeställningsträdet. |
| PrependChild(Node) | Lägger till den angivna noden i början av listan över underordnade noder för denna nod. |
| PreviousPreOrder(Node) | Hämtar föregående nod enligt algoritmen för förbeställningsträdet. |
| Remove() | Tar bort sig själv från föräldern. |
| RemoveAllChildren() | Tar bort alla undernoder för den aktuella noden. |
| RemoveAllReplies() | Tar bort alla svar på den här kommentaren. |
| RemoveChild(Node) | Tar bort den angivna underordnade noden. |
| RemoveReply(Comment) | Tar bort det angivna svaret på denna kommentar. |
| RemoveSmartTags() | Tar bort allaSmartTagunderliggande noder till den aktuella noden. |
| SelectNodes(string) | Väljer en lista med noder som matchar XPath-uttrycket. |
| SelectSingleNode(string) | Väljer den förstaNode som matchar XPath-uttrycket. |
| SetText(string) | Detta är en bekvämlighetsmetod som gör det enkelt att ställa in texten i kommentaren. |
| ToString(SaveFormat) | Exporterar innehållet i noden till en sträng i angivet format. |
| ToString(SaveOptions) | Exporterar innehållet i noden till en sträng med de angivna sparalternativen. |
Anmärkningar
En kommentar är en anteckning som är förankrad till ett textområde eller till en position i text. En kommentar kan innehålla en godtycklig mängd innehåll på blocknivå.
Om enComment objektet uppstår av sig självt, är kommentaren förankrad till positionen förComment objekt.
För att förankra en kommentar till en textregion krävs tre objekt:Comment , CommentRangeStart ochCommentRangeEnd . Alla tre objekt måste dela same Id värde.
Comment är en nod på inline-nivå och kan bara vara ett barn tillParagraph.
Comment kan innehållaParagraph ochTable barnnoder.
Exempel
Visar hur man lägger till en kommentar till ett stycke.
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);
// I Microsoft Word kan vi högerklicka på den här kommentaren i dokumentets brödtext för att redigera den eller svara på den.
doc.Save(ArtifactsDir + "InlineStory.AddComment.docx");
Visar hur man lägger till en kommentar till ett dokument och sedan svarar på det.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Comment comment = new Comment(doc, "John Doe", "J.D.", DateTime.Now);
comment.SetText("My comment.");
// Placera kommentaren vid en nod i dokumentets brödtext.
// Den här kommentaren kommer att dyka upp på platsen för dess stycke,
// utanför sidans högra marginal och med en prickad linje som förbinder den med dess stycke.
builder.CurrentParagraph.AppendChild(comment);
// Lägg till ett svar, som kommer att dyka upp under dess överordnade kommentar.
comment.AddReply("Joe Bloggs", "J.B.", DateTime.Now, "New reply");
// Kommentarer och svar är båda Kommentarsnoder.
Assert.AreEqual(2, doc.GetChildNodes(NodeType.Comment, true).Count);
// Kommentarer som inte svarar på andra kommentarer är "toppnivå". De har inga förfäders kommentarer.
Assert.Null(comment.Ancestor);
// Svaren har en kommentar på översta nivån.
Assert.AreEqual(comment, comment.Replies[0].Ancestor);
doc.Save(ArtifactsDir + "Comment.AddCommentWithReply.docx");
Se även
- class InlineStory
- namnutrymme Aspose.Words
- hopsättning Aspose.Words
