概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

## application.workbooks.workbook.worksheets
类 SsComments

    java.lang.Object
      application.workbooks.workbook.worksheets.SsComments

    public class SsComments

extends java.lang.Object

工作表的批注管理器。

自从：
  1.31

方法摘要
`Comment[]` | `getAllComments()` 获得所有批注。
`Comment` | `getComment(int row, int column)` 获取单元格内的批注。
`int` | `getCount()` 获得批注的个数。
`boolean` | `hasComment(int row, int column)` 是否有批注。
`Comment` | `insertComment(int row, int column)` 在指定的单元格中插入批注。
`void` | `removeAllComments()` 删除所有批注。
`void` | `removeComment(int row, int column)` 在指定的单元格中移除批注。
`void` | `setCommentVisible(int row, int column, boolean visible)` 设置某个批注是否显示。
`void` | `showAllComments(boolean show)` 显示所有批注。

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

方法详细信息

### getAllComments

    public Comment[] getAllComments()

  获得所有批注。

  返回：
    所有批注

    例子：

         //得到当前工作表中所有批注
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         Comment[] coms = sheet.getComments().getAllComments();

### getComment

    public Comment getComment(int row,
                              int column)

  获取单元格内的批注。

  参数：
    `row` - 单元格行号
    `column` - 单元格列号
  返回：
    批注

    例子：

         //得到第三行第二列的单元格的批注
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         Comment comment = sheet.getComments().getComment(3, 2);

  抛出：
    `MacroRunException` - 当给定的单元格地址错误或越界

### getCount

    public int getCount()

  获得批注的个数。

  返回：
    批注的个数

    例子：

         //得到批注的个数
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         int size = sheet.getComments().getCount();
         System.out.println(size);

### hasComment

    public boolean hasComment(int row,
                              int column)

  是否有批注。

  参数：
    `row` - 单元格行号
    `column` - 单元格列号
  返回：
    TRUE表示有批注，FALSE表示无批注

    例子：

         //判断第三行第三列单元格中是否有批注
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         boolean hasComment = sheet.getComments().hasComment(3,3);
         System.out.println(hasComment);

  抛出：
    `MacroRunException` - 当给定的单元格地址错误或越界

### insertComment

    public Comment insertComment(int row,
                                 int column)

  在指定的单元格中插入批注。

  参数：
    `row` - 单元格行号
    `column` - 单元格列号
  返回：
    批注

    例子：

         //在单元格第三行第三列单元格中插入批注,批注内容为"aaaaa"
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         SsComments comments = sheet.getComments();
         Comment comment = comments.insertComment(3,3);
         comment.setText("aaaaa");

  抛出：
    `MacroRunException` - 当给定的单元格地址错误或越界

### removeAllComments

    public void removeAllComments()

  删除所有批注。

  例子：

       //删除当前工作表中所有的批注
       Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                       .getWorksheets().getActiveWorksheet();
       sheet.getComments().removeAllComments();

### removeComment

    public void removeComment(int row,
                              int column)

  在指定的单元格中移除批注。

  参数：
    `row` - 单元格行号
    `column` - 单元格列号

    例子：

         //移除第三行第三列单元格中的批注
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         sheet.getComments().removeComment(3,3);

  抛出：
    `MacroRunException` - 当给定的单元格地址错误或越界

### setCommentVisible

    public void setCommentVisible(int row,
                                  int column,
                                  boolean visible)

  设置某个批注是否显示。

  参数：
    `row` - 行号
    `column` - 列号
    `visible` - 可见性

    例子：

         //将第三行第三列单元格中的批注设置为显示
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         sheet.getComments().setCommentVisible(3,3,true);

  抛出：
    `MacroRunException` - 当给定的单元格地址错误或越界

### showAllComments

    public void showAllComments(boolean show)

  显示所有批注。

  参数：
    `show` - 布尔型值，如为true，显示批注；否则，不显示批注

    例子：

         //将当前工作表中的所有的批注都显示出来
         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
                                         .getWorksheets().getActiveWorksheet();
         sheet.getComments().showAllComments(true);

概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

版权所有 2001-2008 无锡永中科技有限公司