Excel.CommentReplyCollection class
Представляет коллекцию объектов ответа примечания, которые являются частью комментария.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(content, content |
Создает ответ примечания для комментария. |
| add(content, content |
Создает ответ примечания для комментария. |
| get |
Получает количество ответов на примечания в коллекции. |
| get |
Возвращает ответ на примечание, определенное по идентификатору. |
| get |
Возвращает ответ на примечание на основе его позиции в коллекции. |
| get |
Возвращает ответ на примечание, определенное по идентификатору. Если объект comment reply не существует, то этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.CommentReply[];Значение свойства
Сведения о методе
add(content, contentType)
Создает ответ примечания для комментария.
add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;Параметры
- content
-
Excel.CommentRichContent | string
Содержимое комментария. Это может быть строка или CommentRichContent объект (например, для комментариев с упоминаниями). [Набор API: ExcelApi 1.10 для строки, 1.11 для объекта CommentRichContent]
- contentType
- Excel.ContentType
Необязательный параметр. Тип содержимого, содержащегося в комментарии. Значение по умолчанию — перечисление ContentType.Plain. [Набор API: ExcelApi 1.10 для Enum ContentType.Plain, 1.11 для Enum ContentType.Mention]
Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml
await Excel.run(async (context) => {
// Adds a reply to the first comment in this worksheet.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.replies.add("Add content to this worksheet.");
await context.sync();
});
add(content, contentTypeString)
Создает ответ примечания для комментария.
add(content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.CommentReply;Параметры
- content
-
Excel.CommentRichContent | string
Содержимое комментария. Это может быть строка или CommentRichContent объект (например, для комментариев с упоминаниями). [Набор API: ExcelApi 1.10 для строки, 1.11 для объекта CommentRichContent]
- contentTypeString
-
"Plain" | "Mention"
Необязательный параметр. Тип содержимого, содержащегося в комментарии. Значение по умолчанию — перечисление ContentType.Plain. [Набор API: ExcelApi 1.10 для Enum ContentType.Plain, 1.11 для Enum ContentType.Mention]
Возвращаемое значение
Комментарии
getCount()
Получает количество ответов на примечания в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(commentReplyId)
Возвращает ответ на примечание, определенное по идентификатору.
getItem(commentReplyId: string): Excel.CommentReply;Параметры
- commentReplyId
-
string
Идентификатор ответа на комментарий.
Возвращаемое значение
Комментарии
getItemAt(index)
Возвращает ответ на примечание на основе его позиции в коллекции.
getItemAt(index: number): Excel.CommentReply;Параметры
- index
-
number
Значение индекса извлекаемого ответа на комментарий. В коллекции используется отсчитывающееся от нуля индексирование.
Возвращаемое значение
Комментарии
getItemOrNullObject(commentReplyId)
Возвращает ответ на примечание, определенное по идентификатору. Если объект comment reply не существует, то этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(commentReplyId: string): Excel.CommentReply;Параметры
- commentReplyId
-
string
Идентификатор ответа на комментарий.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.CommentReplyCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentReplyCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.CommentReplyCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CommentReplyCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.CommentReplyCollectionData;Возвращаемое значение
Office Add-ins