TerApplyComment
Apply comment to the selected text.
int TerApplyComment(ShowDialog, AuthorName, AuthorInitials, CommentText, repaint)
boolean ShowDialog; | Set to TRUE to show a dialog to accept the author information and the comment text. Set to false to use the information from the remaining parameters passed to this method |
String AuthorName; | The author name for the comment |
String AuthorInitials; | Author initials |
String CommentText; | Comment text. Use the cr/lf sequence to include a paragraph break. |
boolean repaint; | refresh the screen after this operation |
Comment: Some text must be selected before calling this method. The comment is applied to the selected text. The selected text is highlighted and pointed to the comment text in the right-margin area. The comments are displayed horizontally when the right-margin is sufficiently wide. Otherwise, it is displayed vertically.
Return Value: This function returns the comment-id when successful, otherwise it returns a -1 value.