Excel.Comment class

Ссылка

Пакет:: excel

Представляет комментарий в книге.

Extends: OfficeExtension.ClientObject

Свойства

authorEmail	Получает электронную почту автора примечания.
authorName	Получает имя автора примечания.
content	Содержимое комментария. Строка представляет собой обычный текст.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
creationDate	Получает время создания примечания. Возвращает значение `null` , если комментарий был преобразован из заметки, так как у комментария нет даты создания.
id	Указывает идентификатор комментария.
mentions	Возвращает сущности (например, люди), упомянутые в комментариях.
replies	Представляет коллекцию объектов ответов, связанных с примечанием.
resolved	Состояние потока комментариев. Значение `true` означает, что поток комментариев разрешен.
richContent	Возвращает содержимое полнофункционированного комментария (например, упоминания в комментариях). Эта строка не предназначена для отображения для конечных пользователей. Надстройка должна использовать его только для анализа содержимого расширенных комментариев.

Методы

delete()	Удаляет комментарий и все подключенные ответы.
getLocation()	Возвращает ячейку, в которой находится это примечание.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.Comment` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.CommentData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
updateMentions(contentWithMentions)	Обновления содержимое комментария со специально отформатированной строкой и списком упоминаний.

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

authorEmail

Получает электронную почту автора примечания.

readonly authorEmail: string;

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

string

authorName

Получает имя автора примечания.

readonly authorName: string;

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

string

content

Содержимое комментария. Строка представляет собой обычный текст.

content: string;

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

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Excel.RequestContext

creationDate

Получает время создания примечания. Возвращает значение null , если комментарий был преобразован из заметки, так как у комментария нет даты создания.

readonly creationDate: Date;

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

Date

id

Указывает идентификатор комментария.

readonly id: string;

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

string

mentions

Возвращает сущности (например, люди), упомянутые в комментариях.

readonly mentions: Excel.CommentMention[];

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

Excel.CommentMention[]

replies

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

readonly replies: Excel.CommentReplyCollection;

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

Excel.CommentReplyCollection

resolved

Состояние потока комментариев. Значение true означает, что поток комментариев разрешен.

resolved: boolean;

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

boolean

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    sheet.comments.getItemAt(0).resolved = true;
    await context.sync();
});

richContent

Возвращает содержимое полнофункционированного комментария (например, упоминания в комментариях). Эта строка не предназначена для отображения для конечных пользователей. Надстройка должна использовать его только для анализа содержимого расширенных комментариев.

readonly richContent: string;

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

string

Сведения о методе

delete()

Удаляет комментарий и все подключенные ответы.

delete(): void;

Возвращаемое значение

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

getLocation()

Возвращает ячейку, в которой находится это примечание.

getLocation(): Excel.Range;

Возвращаемое значение

Excel.Range

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;

Параметры

options: Excel.Interfaces.CommentLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.Comment

load(propertyNames)

load(propertyNames?: string | string[]): Excel.Comment;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.Comment

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemByCell("Comments!A2");
    comment.load(["authorEmail", "authorName", "creationDate"]);
    await context.sync();

    console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
    await context.sync();
});

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Comment;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.Comment

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.CommentUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Comment): void;

Параметры

properties: Excel.Comment

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Comment объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CommentData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.CommentData;

Возвращаемое значение

Excel.Interfaces.CommentData

updateMentions(contentWithMentions)

Обновления содержимое комментария со специально отформатированной строкой и списком упоминаний.

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

Параметры

contentWithMentions: Excel.CommentRichContent

Содержимое комментария. Он содержит специально отформатированную строку и список упоминаний, которые будут проанализированы в строку при отображении в Excel.

Возвращаемое значение

void

Поделиться через

Excel.Comment class

Комментарии

Свойства

Методы

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

authorEmail

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

Комментарии

authorName

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

Комментарии

content

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

Комментарии

Примеры

context

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

creationDate

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

Комментарии

id

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

Комментарии

mentions

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

Комментарии

replies

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

Комментарии

resolved

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

Комментарии

Примеры

richContent

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

Комментарии

Сведения о методе

delete()

Возвращаемое значение

Комментарии

Примеры

getLocation()

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

Примеры

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)

Параметры

Возвращаемое значение

set(properties)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

updateMentions(contentWithMentions)

Параметры

Возвращаемое значение

Комментарии

Дополнительные ресурсы