C#代码实现在Excel中编辑或删除批注_Asp.net

excel 批注是添加到指定单元格中的附加说明或备注，用于补充信息、提供解释或向其他用户分享提示。添加批注后，用户可以根据需要对其进行格式设置、编辑、删除以及显示或隐藏操作。

本文将介绍如何通过编程方式编辑或删除 excel 工作表中的已有批注，并以 .net 环境下的实现方式为例进行演示。

安装所需组件

首先，需要将相关 dll 文件添加到 .net 项目中作为引用。可以通过下载对应的 dll 文件，或者使用 nuget 包管理器直接安装所需组件。完成安装后，即可在项目中调用相关功能来处理 excel 文件。

pm> install-package spire.xls

编辑 excel 中的批注

在 excel 工作簿中添加批注后，有时可能需要对已有批注进行修改，例如更新内容、调整大小或更改显示方式。下面列出了一些常用的类和属性，用于获取已有批注，并设置新的文本内容以及格式。

名称	描述
cellrange.comment 属性	获取与单元格关联的批注对象。
comment 对象	表示一个 excel 批注。
comment.text 属性	获取或设置批注中的文本内容。
comment.height 属性	获取或设置批注框的高度。
comment.width 属性	获取或设置批注框的宽度。
comment.autosize 属性	指示批注框大小是否会根据文本内容自动调整。

本文后续示例将展示如何通过代码获取 excel 中已有的批注，并对其文本内容和格式进行修改。

以下是通过代码编辑 excel 批注的基本步骤：

创建一个工作簿对象（workbook）。
加载 excel 文件。
获取工作簿中的目标工作表。
获取指定单元格中的已有批注。
修改批注内容，并根据需要调整批注框的高度、宽度或启用自动调整大小。
将修改后的文件保存为新的 excel 文件。

通过以上步骤，可以在程序中读取 excel 文件，并对已有批注进行编辑和格式调整。

完整示例代码如下：

using spire.xls;

namespace editexcelcomment
{
    class program
    {
        static void main(string[] args)
        {
            // 创建一个 workbook 实例
            workbook workbook = new workbook();

            // 加载 excel 文件
            workbook.loadfromfile("comments.xlsx");

            // 获取第一个工作表
            worksheet sheet = workbook.worksheets[0];

            // 获取指定单元格中的批注并修改批注内容
            sheet.range["a8"].comment.text = "frank has left the company.";
            sheet.range["f6"].comment.text = "best sales.";

            // 设置批注框的高度和宽度
            sheet.range["a8"].comment.height = 50;
            sheet.range["a8"].comment.width = 100;
            sheet.range["f6"].comment.autosize = true;

            // 保存文件
            workbook.savetofile("modifycomment.xlsx", excelversion.version2013);
        }
    }
}

删除 excel 中的批注

通过代码删除 excel 中指定批注的步骤如下：

创建一个工作簿对象（workbook）。
加载 excel 文件。
获取工作簿中的目标工作表。
获取指定单元格中的批注对象，并调用删除方法移除该批注。
将修改后的文档保存为新的 excel 文件。

通过以上步骤，可以在程序中读取 excel 文件，并删除工作表中不需要的批注。

完整示例代码如下：

using spire.xls;

namespace editexcelcomment
{
    class program
    {
        static void main(string[] args)
        {
            // 创建一个 workbook 实例
            workbook workbook = new workbook();

            // 加载 excel 文件
            workbook.loadfromfile("comments.xlsx");

            // 获取第一个工作表
            worksheet sheet = workbook.worksheets[0];

            // 获取指定单元格中的批注并删除
            sheet.range["f6"].comment.remove();

            // 保存文件
            workbook.savetofile("deletecomment.xlsx", excelversion.version2013);
        }
    }
}

知识扩展

在 c# 中操作 excel 批注，主要有两种技术路线：使用第三方库（推荐）或使用 com 互操作。第三方库性能更好、无需安装 excel，是开发中的首选。

下面为你详细介绍几种主流方法。

准备工作：理解“批注”与“注释”

在开始前需要留意，从 excel 365 开始，微软对功能进行了更名：

批注 (comments)：现在指代可以进行对话式回复的新式批注。
注释 (notes)：指传统的、仅用于备注的旧式批注。

大多数 .net 库（如 epplus）目前主要支持操作传统的“注释 (notes)”。这意味着，如果你的 excel 文件里是那种带回复功能的新式批注，这些库可能无法直接读取或修改。

方法一：使用 epplus（开源、免费、推荐）

epplus 是操作 .xlsx 文件的强大开源库，需要通过 nuget 安装，并且需要设置许可证上下文。

1. 编辑批注（注释）

using officeopenxml;
using system.io;
// 设置许可证上下文（非商业用途）
excelpackage.license.setnoncommercialpersonal("你的名字");
using (var package = new excelpackage(new fileinfo("你的文件.xlsx")))
{
    var worksheet = package.workbook.worksheets[0]; // 获取第一个工作表
    // 获取 a1 单元格的批注
    var comment = worksheet.cells["a1"].comment;
    if (comment != null)
    {
        // 修改批注的纯文本内容
        comment.text = "这是修改后的批注内容。";
        // 或者修改富文本内容（例如更改颜色）
        // comment.richtext[0].color = system.drawing.color.red;
    }
    package.save(); // 保存更改
}

核心：通过 worksheet.cells["a1"].comment 获取批注对象，然后修改其 text 或 richtext 属性。
富文本：epplus 支持富文本，可以单独设置文本中不同部分的字体、颜色、大小等。

2. 删除批注（注释）

using officeopenxml;
using system.io;
using (var package = new excelpackage(new fileinfo("你的文件.xlsx")))
{
    var worksheet = package.workbook.worksheets[0];
    // 删除 a1 单元格的批注
    var commenttodelete = worksheet.cells["a1"].comment;
    if (commenttodelete != null)
    {
        worksheet.comments.remove(commenttodelete);
    }
    // 或者直接通过单元格地址删除
    // worksheet.comments.remove(worksheet.comments["a1"]);
    package.save();
}

核心：通过 worksheet.comments.remove() 方法传入要删除的批注对象。

小提示：使用 worksheet.comments 集合可以遍历工作表中的所有批注。

方法二：使用 spire.xls（功能丰富，商业库）

spire.xls 是一款功能全面的商业库，对新式“批注”的支持可能更好。

1. 编辑批注

using spire.xls;
workbook workbook = new workbook();
workbook.loadfromfile("你的文件.xlsx");
worksheet sheet = workbook.worksheets[0];
// 修改 a8 单元格的批注文本
sheet.range["a8"].comment.text = "这是修改后的文本。";
// 调整批注框的大小
sheet.range["a8"].comment.height = 50;
sheet.range["a8"].comment.width = 100;
workbook.savetofile("修改后的文件.xlsx", excelversion.version2013);

核心：直接通过 range.comment 属性访问并修改。

2. 删除批注

using spire.xls;
workbook workbook = new workbook();
workbook.loadfromfile("你的文件.xlsx");
worksheet sheet = workbook.worksheets[0];
// 删除 a1 单元格的批注
sheet.range["a1"].comment.delete();
workbook.savetofile("删除批注后的文件.xlsx", excelversion.version2013);

核心：调用 comment.delete() 方法。

方法三：使用 com 互操作（不推荐，仅作为备选）

此方法直接操作 excel 应用程序，速度慢、不稳定，且要求运行环境必须安装 excel。

1. 编辑批注

using microsoft.office.interop.excel;
application excelapp = new application();
workbook workbook = excelapp.workbooks.open("你的文件.xlsx");
worksheet worksheet = workbook.worksheets[1]; // com 中索引从1开始
range rng = worksheet.range["a1"];
if (rng.comment != null)
{
    // 修改批注文本
    rng.comment.text("这是修改后的文本。");
}
workbook.save();
workbook.close();
excelapp.quit();

核心：通过 range.comment 对象操作，修改文本使用 text() 方法。

2. 删除批注

using microsoft.office.interop.excel;
application excelapp = new application();
workbook workbook = excelapp.workbooks.open("你的文件.xlsx");
worksheet worksheet = workbook.worksheets[1];
range rng = worksheet.range["a1"];
if (rng.comment != null)
{
    rng.comment.delete(); // 删除批注
}
workbook.save();
workbook.close();
excelapp.quit();