Excel.CommentAddedEventArgs interface

Пакет:

excel

Предоставляет сведения о комментариях, которые вызвали событие добавления примечания.

Комментарии

Набор API: ExcelApi 1.12

Используется

• Excel.CommentCollection: onAdded

Примеры

async function registerEventHandler() {
    await Excel.run(async (context) => {
        // Register the onAdded comment event handler.
        const comments = context.workbook.worksheets.getActiveWorksheet().comments;
        comments.onAdded.add(commentAdded);
        await context.sync();
    });
}

async function commentAdded(event: Excel.CommentAddedEventArgs) {
    // Retrieve the added comment using the comment ID.
    // Note: This function assumes only a single comment is added at a time.
    await Excel.run(async (context) => {
        const addedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);

        // Load the added comment's data.
        addedComment.load(["content", "authorName", "creationDate"]);
        await context.sync();

        // Print out the added comment's data.
        console.log(`A comment was added:`);
        console.log(`    ID: ${event.commentDetails[0].commentId}`);
        console.log(`    Comment content: ${addedComment.content}`);
        console.log(`    Comment author: ${addedComment.authorName}`);
        console.log(`    Creation date: ${addedComment.creationDate}`);
    });
}

Свойства

commentDetails	CommentDetail Возвращает массив, содержащий идентификатор комментария и идентификаторы связанных ответов.
source	Указывает источник события. Дополнительные сведения см. в этой Excel.EventSource статье.
type	Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.
worksheetId	Возвращает идентификатор листа, на котором произошло событие.

Сведения о свойстве

commentDetails

CommentDetail Возвращает массив, содержащий идентификатор комментария и идентификаторы связанных ответов.

commentDetails: Excel.CommentDetail[];

Значение свойства

Excel.CommentDetail[]

Комментарии

Набор API: ExcelApi 1.12

source

Указывает источник события. Дополнительные сведения см. в этой Excel.EventSource статье.

source: Excel.EventSource | "Local" | "Remote";

Значение свойства

Excel.EventSource | "Local" | "Remote"

Комментарии

Набор API: ExcelApi 1.12

type

Получает тип события. Дополнительные сведения см. в этой Excel.EventType статье.

type: "CommentAdded";

Значение свойства

"CommentAdded"

Комментарии

Набор API: ExcelApi 1.12

worksheetId

Возвращает идентификатор листа, на котором произошло событие.

worksheetId: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.12