SetAuthorName
Sets the comment author's name.
Syntax
expression.SetAuthorName(sAuthorName);
expression
- A variable that represents a ApiComment class.
Parameters
Name | Required/Optional | Data type | Default | Description |
---|---|---|---|---|
sAuthorName | Required | string | The comment author's name. |
Returns
Example
This example sets the comment author's name.
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("This is just a sample text");
Api.AddComment(paragraph, "comment", "John Smith");
let comments = doc.GetAllComments();
comments[0].SetAuthorName("Mark Potato");
paragraph = Api.CreateParagraph();
paragraph.AddText("The comment author's name was changed");
doc.Push(paragraph);