Struct CellComment 

pub struct CellComment {
    pub cell: String,
    pub author: String,
    pub text: String,
    pub rich_text: Option<Vec<RichTextRun>>,
}

A comment attached to a cell (legacy xl/comments*.xml + VML drawing, CT_Comment). Only plain-text comments with a fixed author are modeled — CT_Comment’s rich-text (CT_RElt runs) body and threaded-comment reply chains (CT_ThreadedComment, the modern Excel 365 “@mention” comment form) are out of scope.

Fields

cell: String

The cell this comment is attached to (e.g. "B2").

author: String

The comment’s author (shown in the comment box’s first bold line by Excel’s own convention, and stored as a separate <author> entry — not otherwise validated).

text: String

The comment’s body text — when rich_text is Some, this is simply the plain-text concatenation of every run’s own text (kept in sync automatically by CellComment::with_rich_text), not a separate independent value.

rich_text: Option<Vec<RichTextRun>>

The comment’s body as per-run formatted text (<text><r>..</r></text>, reusing RichTextRun — the same per-run bold/italic/color/size/ name/underline/strike model a rich-text cell’s shared-string runs already use). None writes the plain single-run <text><r><t>..</t></r></text> form instead, using text verbatim.

Implementations

impl CellComment

pub fn new( cell: impl Into<String>, author: impl Into<String>, text: impl Into<String>, ) -> CellComment

Creates a plain-text comment.

Examples found in repository

examples/xlsx_rich_data.rs (lines 82-86)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_rich_data.xlsx");

    let dates_and_booleans_sheet = Sheet::new("Dates and booleans")
        .with_row(Row::new().with_cell(Cell::date(ExcelDateTime::date(2026, 7, 21))))
        .with_row(Row::new().with_cell(Cell::date(
            ExcelDateTime::date(2026, 7, 21).with_time(14, 30, 0),
        )))
        .with_row(
            Row::new()
                .with_cell(Cell::boolean(true))
                .with_cell(Cell::boolean(false)),
        );

    // An array/shared formula's `ref` must be a range whose top-left cell
    // is the cell the `<f t="array"|"shared">` element actually sits in —
    // `with_cell` fills a row left-to-right starting at column A, so each
    // formula cell below is positioned to land exactly on its own `ref`'s
    // first cell, with plain cached-value cells (no `<f>`) filling out the
    // rest of the declared range, matching how Excel itself writes a
    // multi-cell array/shared formula. The previous version declared
    // ranges like "D1:D3"/"E1:E3" while the formula cells actually landed
    // in column A — a real cell/range mismatch Excel refuses to open
    // without repairing.
    let formulas_sheet = Sheet::new("Formulas")
        .with_row(
            Row::new()
                .with_cell(Cell::number(10.0))
                .with_cell(Cell::number(20.0))
                .with_cell(Cell::formula("A1+B1").with_cached_value(30.0)),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::array_formula("A1:A3*2", "A2:C2").with_cached_value(20.0))
                .with_cell(Cell::number(40.0))
                .with_cell(Cell::number(60.0)),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::shared_formula("A1+1", 0, "A3:C3").with_cached_value(11.0))
                .with_cell(Cell::shared_formula_follower(0).with_cached_value(21.0))
                .with_cell(Cell::shared_formula_follower(0).with_cached_value(31.0)),
        );

    let rich_text_sheet =
        Sheet::new("Rich text").with_row(Row::new().with_cell(Cell::rich_text(vec![
        RichTextRun::new("Bold red, ").with_bold(true).with_font_color("FFC00000"),
        RichTextRun::new("then italic blue.").with_italic(true).with_font_color("FF2E74B5"),
    ])));

    let hyperlinks_sheet = Sheet::new("Hyperlinks")
        .with_row(
            Row::new()
                .with_text("Visit Rust")
                .with_text("Jump to C1")
                .with_text("You've arrived"),
        )
        .with_hyperlink(
            CellHyperlink::external("A1", "https://www.rust-lang.org")
                .with_tooltip("Opens in your browser"),
        )
        .with_hyperlink(CellHyperlink::internal("B1", "'Hyperlinks'!C1"));

    let comments_sheet = Sheet::new("Comments")
        .with_row(
            Row::new()
                .with_text("Hover B1 for a comment")
                .with_text("Reviewed"),
        )
        .with_comment(CellComment::new(
            "A1",
            "Reviewer",
            "Double-check this figure before publishing.",
        ))
        .with_comment(
            CellComment::new("B1", "Reviewer", "Looks correct.")
                .with_rich_text(vec![RichTextRun::new("Looks correct.").with_bold(true)]),
        );

    let workbook = Workbook::new()
        .with_sheet(dates_and_booleans_sheet)
        .with_sheet(formulas_sheet)
        .with_sheet(rich_text_sheet)
        .with_sheet(hyperlinks_sheet)
        .with_sheet(comments_sheet);

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_rich_text(self, runs: Vec<RichTextRun>) -> CellComment

Sets this comment’s body as per-run formatted text and returns it for chaining. Also resolves text (the plain-text fallback) to the concatenation of every run’s own text, so both fields stay consistent.

Examples found in repository

examples/xlsx_rich_data.rs (line 89)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_rich_data.xlsx");

    let dates_and_booleans_sheet = Sheet::new("Dates and booleans")
        .with_row(Row::new().with_cell(Cell::date(ExcelDateTime::date(2026, 7, 21))))
        .with_row(Row::new().with_cell(Cell::date(
            ExcelDateTime::date(2026, 7, 21).with_time(14, 30, 0),
        )))
        .with_row(
            Row::new()
                .with_cell(Cell::boolean(true))
                .with_cell(Cell::boolean(false)),
        );

    // An array/shared formula's `ref` must be a range whose top-left cell
    // is the cell the `<f t="array"|"shared">` element actually sits in —
    // `with_cell` fills a row left-to-right starting at column A, so each
    // formula cell below is positioned to land exactly on its own `ref`'s
    // first cell, with plain cached-value cells (no `<f>`) filling out the
    // rest of the declared range, matching how Excel itself writes a
    // multi-cell array/shared formula. The previous version declared
    // ranges like "D1:D3"/"E1:E3" while the formula cells actually landed
    // in column A — a real cell/range mismatch Excel refuses to open
    // without repairing.
    let formulas_sheet = Sheet::new("Formulas")
        .with_row(
            Row::new()
                .with_cell(Cell::number(10.0))
                .with_cell(Cell::number(20.0))
                .with_cell(Cell::formula("A1+B1").with_cached_value(30.0)),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::array_formula("A1:A3*2", "A2:C2").with_cached_value(20.0))
                .with_cell(Cell::number(40.0))
                .with_cell(Cell::number(60.0)),
        )
        .with_row(
            Row::new()
                .with_cell(Cell::shared_formula("A1+1", 0, "A3:C3").with_cached_value(11.0))
                .with_cell(Cell::shared_formula_follower(0).with_cached_value(21.0))
                .with_cell(Cell::shared_formula_follower(0).with_cached_value(31.0)),
        );

    let rich_text_sheet =
        Sheet::new("Rich text").with_row(Row::new().with_cell(Cell::rich_text(vec![
        RichTextRun::new("Bold red, ").with_bold(true).with_font_color("FFC00000"),
        RichTextRun::new("then italic blue.").with_italic(true).with_font_color("FF2E74B5"),
    ])));

    let hyperlinks_sheet = Sheet::new("Hyperlinks")
        .with_row(
            Row::new()
                .with_text("Visit Rust")
                .with_text("Jump to C1")
                .with_text("You've arrived"),
        )
        .with_hyperlink(
            CellHyperlink::external("A1", "https://www.rust-lang.org")
                .with_tooltip("Opens in your browser"),
        )
        .with_hyperlink(CellHyperlink::internal("B1", "'Hyperlinks'!C1"));

    let comments_sheet = Sheet::new("Comments")
        .with_row(
            Row::new()
                .with_text("Hover B1 for a comment")
                .with_text("Reviewed"),
        )
        .with_comment(CellComment::new(
            "A1",
            "Reviewer",
            "Double-check this figure before publishing.",
        ))
        .with_comment(
            CellComment::new("B1", "Reviewer", "Looks correct.")
                .with_rich_text(vec![RichTextRun::new("Looks correct.").with_bold(true)]),
        );

    let workbook = Workbook::new()
        .with_sheet(dates_and_booleans_sheet)
        .with_sheet(formulas_sheet)
        .with_sheet(rich_text_sheet)
        .with_sheet(hyperlinks_sheet)
        .with_sheet(comments_sheet);

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

Trait Implementations

impl Clone for CellComment

fn clone(&self) -> CellComment

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CellComment

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for CellComment

fn eq(&self, other: &CellComment) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CellComment