Comment
Comment class
Representerar en behållare för texten 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 klass. |
Comment(DocumentBase, string, string, DateTime) | Initierar en ny instans avComment klass. |
Egenskaper
namn | Beskrivning |
---|---|
Ancestor { get; } | Returnerar föräldernComment objekt. Returnerarnull för kommentarer på toppnivå. |
Author { get; set; } | Returnerar eller anger författarnamnet 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. |
DateTimeUtc { get; } | Hämtar UTC-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; } | Hämtar nodens första barn. |
FirstParagraph { get; } | Hämtar det första stycket i berättelsen. |
Font { get; } | Ger åtkomst till teckensnittsformateringen för ankartecknet i detta objekt. |
HasChildNodes { get; } | Returersann om den här noden har några undernoder. |
Id { get; set; } | Hämtar eller ställer in kommentaridentifieraren. |
Initial { get; set; } | Returnerar eller anger initialerna för den användare som är associerad med en specifik kommentar. |
override IsComposite { get; } | Returersann eftersom denna nod kan ha underordnade noder. |
IsDeleteRevision { get; } | Returnerar sant om det här objektet togs bort 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; } | Returersann om det här objektet flyttades (raderades) i Microsoft Word medan ändringsspårning var aktiverad. |
IsMoveToRevision { get; } | Returersann om det här objektet flyttades (infogades) i Microsoft Word medan ändringsspårning var aktiverad. |
LastChild { get; } | Hämtar nodens sista barn. |
LastParagraph { get; } | Hämtar det sista stycket i berättelsen. |
NextSibling { get; } | Hämtar noden som följer direkt efter denna nod. |
override NodeType { get; } | ReturerComment . |
Paragraphs { get; } | Hämtar en samling stycken som är direkta underordnade stycken till berättelsen. |
ParentId { get; set; } | Hämtar eller ställer in det överordnade kommentars-ID:t. Värdet är-1 betyder att kommentaren inte har någon förälder. |
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 som omedelbart föregår 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 till den angivna kommentaren. |
override StoryType { get; } | ReturerComments . |
Tables { get; } | Hämtar en samling tabeller som är direkta underordnade tabeller till berättelsen. |
Metoder
namn | Beskrivning |
---|---|
override Accept(DocumentVisitor) | Tar emot en besökare. |
override AcceptEnd(DocumentVisitor) | Accepterar en besökare för att besöka slutet av kommentaren. |
override AcceptStart(DocumentVisitor) | Accepterar en besökare för att besöka början av kommentaren. |
AddReply(string, string, DateTime, string) | Lägger till ett svar på den här kommentaren. |
AppendChild<T>(T) | Lägger till den angivna noden i slutet av listan över underordnade noder för denna nod. |
Clone(bool) | Skapar en duplikat av noden. |
CreateNavigator() | Skapar en navigator som kan användas för att korsa och läsa noder. |
EnsureMinimum() | Om det sista underordnade stycket inte är ett stycke skapas och läggs 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 live-samling av underordnade noder som matchar den angivna typen. |
GetEnumerator() | Ger stöd för iterationen för varje stil över de underordnade noderna till denna nod. |
override GetText() | Hämtar texten för denna nod och alla dess underordnade noder. |
IndexOf(Node) | Returnerar indexet för den angivna undernoden i undernodsmatrisen. |
InsertAfter<T>(T, Node) | Infogar den angivna noden omedelbart efter den angivna referensnoden. |
InsertBefore<T>(T, 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ädtraversering. |
PrependChild<T>(T) | 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 trädtraversering i förbeställning. |
Remove() | Tar bort sig själv från föräldern. |
RemoveAllChildren() | Tar bort alla undernoder till den aktuella noden. |
RemoveAllReplies() | Tar bort alla svar på den här kommentaren. |
RemoveChild<T>(T) | Tar bort den angivna undernoden. |
RemoveReply(Comment) | Tar bort det angivna svaret på den här kommentaren. |
RemoveSmartTags() | Tar bort allaSmartTag underordnade 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äm metod som gör det enkelt att ange kommentarens text. |
ToString(SaveFormat) | Exporterar nodens innehåll till en sträng i det angivna formatet. |
ToString(SaveOptions) | Exporterar nodens innehåll till en sträng med de angivna sparalternativen. |
Anmärkningar
En kommentar är en anteckning som är förankrad i ett textområde eller en position i texten. En kommentar kan innehålla en godtycklig mängd innehåll på blocknivå.
Om enComment
objektet förekommer på egen hand, kommentaren är förankrad till positionen förComment
objekt.
För att förankra en kommentar till ett textområde krävs tre objekt:Comment
, CommentRangeStart
ochCommentRangeEnd
Alla tre objekten måste dela samma Id
värde.
Comment
är en inline-nivånod och kan bara vara underordnadParagraph
.
Comment
kan innehållaParagraph
ochTable
underordnade noder.
Exempel
Visar hur man lägger till en kommentar i 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 i ett dokument och sedan svarar på den.
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 visas där stycket är placerat,
// utanför sidans högra marginal och med en prickad linje som förbinder den med sitt stycke.
builder.CurrentParagraph.AppendChild(comment);
// Lägg till ett svar, som visas 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 överordnade kommentarer.
Assert.Null(comment.Ancestor);
// Svar har en överordnad kommentar på toppnivå.
Assert.AreEqual(comment, comment.Replies[0].Ancestor);
doc.Save(ArtifactsDir + "Comment.AddCommentWithReply.docx");
Se även
- class InlineStory
- namnutrymme Aspose.Words
- hopsättning Aspose.Words