Skip to main content

Module threaded_comment

Module threaded_comment 

Source
Expand description

Threaded comments management.

Provides functions for adding, querying, resolving, and removing threaded comments (Excel 2019+ feature). Threaded comments support replies and resolved state, unlike legacy comments.

Structs§

PersonData
Output data for a person.
PersonInput
Input configuration for adding a person.
ThreadedCommentData
Output data for a threaded comment.
ThreadedCommentInput
Input configuration for adding a threaded comment.

Constants§

LEGACY_PLACEHOLDER_PREFIX
Text prefix Excel writes into the legacy comment that mirrors a threaded comment.

Functions§

add_person
Add a person to the person list. Returns the person ID.
add_threaded_comment
Add a threaded comment to a sheet’s threaded comments collection.
delete_threaded_comment
Delete a threaded comment by its ID.
find_or_create_person
Find or create a person in the person list, returning their ID.
get_persons
Get all persons from the person list.
get_threaded_comments
Get all threaded comments for a sheet.
get_threaded_comments_by_cell
Get threaded comments for a specific cell.
is_legacy_placeholder
Returns true when text is a legacy comment that mirrors a threaded comment.
is_legacy_twin
Whether a legacy comment is the placeholder twin Excel writes for a thread: the author carries the thread id (tc=<guid>) and the text starts with Excel’s placeholder. Ordinary notes never match.
legacy_comment_for_cell
Build the legacy comment Excel requires for the thread on cell.
resolve_threaded_comment
Set the resolved (done) state of a threaded comment.