使用 OpenXML SDK 在 Excel 电子表格中创建单元格注释

Question

我正在尝试向 Excel 2007 电子表格中的单元格添加注释。 我正在使用 OpenXml SDK 2.0 来执行此操作。

我的用例是这样的： 我创建了一个 Excel 模板文件，我复制该文件并将其用作起点，而不是从头开始创建 OpenXML 文档。 我的模板文件在单元格 A1 中有注释，因此 Excel 已经为我创建了 WorksheetCommentPart。

现在我的问题是，当我将注释节点添加到注释部分时，电子表格不会加载，Excel 会询问我是否要恢复。

真正困扰我的是，我在 A1 中的原始评论仍然存在，但我以编程方式添加的任何评论都消失了！

这是我正在使用的代码：

using (MemoryStream spreadsheetStream = new MemoryStream())
{
    GetGradebookSpreadsheetTemplate(spreadsheetStream);

    using (SpreadsheetDocument spDoc = SpreadsheetDocument.Open(spreadsheetStream, true))
    {
        WorkbookPart wbPart = spDoc.WorkbookPart;
        WorksheetPart wsPart = wbPart.WorksheetParts.First();
        SheetData sheet = wsPart.Worksheet.GetFirstChild<SheetData>();
        Comments comments = wsPart.WorksheetCommentsPart.Comments;
        comments.Descendants<Author>().First().Text = string.Format("{0}, {1}", instructor.LastName, instructor.FirstName);
        comments.Descendants<Text>().First().Text = string.Format("{0}, {1}", instructor.LastName, instructor.FirstName);
        List<DefinedName> definedNames = new List<DefinedName>();
        definedNames.Add(CreateDefinedName("COLWeb_Gradebook", sheet.NamespaceURI, "Gradebook", "1", "A"));

        uint index = 4;
        foreach (User u in users)
            CreateUserDataRow(index++, definedNames, comments.CommentList, sheet, u, coursesForUsers[u], assignments, submissions[u]);
        Cell lastCell = sheet.Descendants<Cell>().Last();
        OpenXmlElement dimensionsElement = wsPart.Worksheet.Elements().Where(x => x.LocalName == "dimension").First();
        dimensionsElement.SetAttribute(new OpenXmlAttribute("ref", null, "A1:" + lastCell.CellReference));

        comments.Save();
        wsPart.Worksheet.Save();
        wbPart.Workbook.Save();
    }

    return spreadsheetStream.ToArray();
}

“CreateUserDataRow”创建一个新行，但相关部分是（其中“comment”是我的评论字符串，“c”是我要创建评论的单元格）：

if (!string.IsNullOrEmpty(comment))
{
    List<OpenXmlElement> runs = new List<OpenXmlElement>();

    foreach (string row in comment.Split(new string[] { "<p>", "</p>" }, StringSplitOptions.RemoveEmptyEntries))
    {
        string trimmed = row.Trim();
        if (!string.IsNullOrEmpty(trimmed))
        {
            string escaped = System.Security.SecurityElement.Escape(trimmed);
            runs.Add(new Run(new RunProperties(), new Text(escaped)));
        }
    }

    Comment commentCell = new Comment();
    commentCell.Reference = c.CellReference;
    commentCell.AuthorId = 0;
    commentCell.AppendChild(new CommentText(runs));
    comments.AppendChild(commentCell);
}

现在就我的眼睛和 KDiff3 而言，我的文件与我打开 Excel 并在 Excel 中手动将注释放入单元格时输出的文件几乎相同。

有人有一个使用 OpenXml 将注释附加到单元格的好例子吗？关于一段关系，有什么我应该知道的吗？ 这是否与使用我创建的 Excel 文件有关，然后我将其用作模板（可能未设置某些尺寸）？

Answer 1

不幸的是，事情没那么简单。

单元格注释还有一个图形对象，位于 VML 绘图部分。 VML 是一个神秘的遗留规范，并不在已批准的 ECMA 标准中。您可以在 Microsoft 的 Open XML 文档中找到有关它的文档，但它并不漂亮。希望微软能够在 Excel 14 中解决这个问题，添加完整的单元格注释支持以及对也写入 VML 的控件的支持。

话虽如此，我还没有使用过Open XML SDK，所以我不能说是否可以用它添加注释。我只是认为这可能会帮助您指明正确的方向。

Answer 2

http://openxmldeveloper.org/forums/thread/7396.aspx 似乎有一个代码示例，它展示了如何创建必需的 VML 绘图。我现在正在尝试这段代码，似乎已经取得了进展，尽管我仍然收到某种未指定的错误，其中 Excel 决定在打开之前删除注释...