Worksheet.CreateThreadedCommentAuthor(String, String, String) Method

Creates a new object that contains information about the comment author.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

ThreadedCommentAuthor CreateThreadedCommentAuthor(
    string name,
    string userId,
    string providerId
)

VB.NET

Function CreateThreadedCommentAuthor(
    name As String,
    userId As String,
    providerId As String
) As ThreadedCommentAuthor

Parameters

Name	Type	Description
name	String	The name of the author.
userId	String	The author’s user identifier.
providerId	String	The author’s provider identifier.

Returns

Type	Description
ThreadedCommentAuthor	An object that contains the author information.

Remarks

Use this method if you need to specify additional information about the author. Pass the created object as the ThreadedCommentCollection.Add or ThreadedComment.Reply method parameter to create a comment or reply from the specified author.

Example

The code sample below creates a new object, specifies the provider and user identifiers, and uses this object to create a comment:

C#

var workbook = new Workbook();
workbook.LoadDocument(@"C:\Docs\Comments.xlsx");
Worksheet worksheet = workbook.Worksheets[0];
var comments = worksheet.ThreadedComments;

var author =
  worksheet.CreateThreadedCommentAuthor("Ryan Anita W", "S::[e-mail]::ccdb79f7-8acb-46ab-a6d9-4f4340797155", "AD");

comments.Add(worksheet["D5"], author, "Thank you");
workbook.SaveDocument(@"C:\Docs\Comments_upd.xlsx");

VB.NET

Option Infer On

Dim workbook As New Workbook()
workbook.LoadDocument("C:\Docs\Comments.xlsx")
Dim worksheet As Worksheet = workbook.Worksheets(0)
Dim comments = worksheet.ThreadedComments

Dim author = worksheet.CreateThreadedCommentAuthor("Ryan Anita W", "S::[e-mail]::ccdb79f7-8acb-46ab-a6d9-4f4340797155", "AD")

comments.Add(worksheet("D5"), author, "Thank you")
workbook.SaveDocument("C:\Docs\Comments_upd.xlsx")