Работа с комментариями в Excel – Руководство по API Aspose.Cells Cloud

При создании рабочей книги Excel пользователи могут добавлять комментарии по различным причинам. Одна из распространённых задач — пояснить формулу в ячейке, особенно если файл будет передан другим пользователям. Комментарии также могут служить напоминаниями, заметками для соавторов или средством перекрёстных ссылок на другие рабочие книги. После добавления комментария Excel предоставляет возможность изменять его размер, форму и форматирование, чтобы соответствовать предпочтительному стилю. Освоение управления комментариями позволяет максимально эффективно использовать эту функцию.

Предварительные требования

• Активная учётная запись Aspose.Cells Cloud.
• Действующий токен доступа, полученный через OAuth 2.0.
• Версия API v3.0 (конечные точки, используемые в этом руководстве, относятся к этой версии).
• Опционально: Aspose.Cells SDK для предпочитаемого языка программирования для упрощения формирования запросов.

Версия

Примеры ниже ориентированы на Aspose.Cells Cloud REST API v3.0. В будущих выпусках API могут быть добавлены новые параметры или изменена структура ответов; всегда сверяйтесь с последней документацией по API для получения актуальной информации.

Добавление комментария

Для добавления комментария отправьте POST-запрос на следующую конечную точку:

POST https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments
Authorization: Bearer {access_token}
Content-Type: application/json

Параметры пути

Схема тела запроса

Пример тела запроса

{
  "CellName": "B2",
  "Comment": "Требуется проверка",
  "Author": "Иван Иванов"
}

Пример успешного ответа (200 OK)

{
  "Code": 200,
  "Status": "OK",
  "Comment": {
    "CellName": "B2",
    "Author": "Иван Иванов",
    "HtmlComment": "Требуется проверка",
    "Note": "Требуется проверка"
  }
}

Типичные коды ошибок

Получение комментариев

Получить все комментарии с листа:

GET https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments
Authorization: Bearer {access_token}

Параметры пути

Пример ответа

{
  "Code": 200,
  "Status": "OK",
  "Comments": [
    {
      "CellName": "A1",
      "Author": "Алиса",
      "HtmlComment": "Начальное значение",
      "Note": "Начальное значение"
    },
    {
      "CellName": "B2",
      "Author": "Иван Иванов",
      "HtmlComment": "Требуется проверка",
      "Note": "Требуется проверка"
    }
  ]
}

Обновление комментария

Для изменения существующего комментария отправьте PUT-запрос. Комментарий идентифицируется по индексу в коллекции комментариев листа (индексация начинается с 0):

PUT https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments/{commentIndex}
Authorization: Bearer {access_token}
Content-Type: application/json

Параметры пути

Схема тела запроса

Пример тела запроса

{
  "Comment": "Обновлённый текст заметки",
  "Author": "Иван Иванов"
}

Ответ имеет такую же структуру, как в разделе Добавление комментария.

Удаление комментария

Удалить один комментарий по его индексу:

DELETE https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments/{commentIndex}
Authorization: Bearer {access_token}

Параметры пути

При успешном удалении возвращается:

{
  "Code": 200,
  "Status": "OK"
}

Удаление всех комментариев

Очистить все комментарии с листа:

DELETE https://api.aspose.cloud/v3.0/cells/{file}/worksheets/{sheet}/comments
Authorization: Bearer {access_token}

Параметры пути

Рекомендации по обработке ошибок

• 404 Not Found – Убедитесь, что идентификатор рабочей книги, имя листа и индекс комментария указаны верно.
• 400 Bad Request – Проверьте синтаксис JSON и наличие обязательных полей (CellName, Comment).
• 429 Too Many Requests – Реализуйте экспоненциальную отсрочку и соблюдайте заголовок Retry-After.

Краткое резюме

• Комментарии в Excel используются для добавления заметки или пояснения формулы в ячейке.
• Excel предоставляет гибкость редактирования, удаления и отображения или скрытия комментариев на листе.
• Пользователи также могут изменять размер и перемещать поле комментария.

Дополнительные сведения о работе с другими элементами электронных таблиц см. в руководстве по работе с ячейками.