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

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

## application.workbooks.workbook.documents.document
类 WpComments

    java.lang.Object
      application.workbooks.workbook.documents.document.WpComments

    public class WpComments

extends java.lang.Object

批注管理器，用于管理批注的插入、删除等。

方法摘要
`void` | `deleteComment(long offset, long length)` 删除指定区域内的所有批注。
`void` | `editComment(long offset)` 批注进入编辑状态。
`Comment[]` | `getAllComments()` 获得所有的批注对象。
`Comment` | `getComment(long offset)` 返回指定偏移量的批注
`int` | `getCount()` 获取批注对象在系统表中的个数。
`Comment` | `insertComment(long offset, long length)` 插入批注。
`Comment` | `next(long offset)` 光标移动到下一个批注。
`Comment` | `previous(long offset)` 光标移动到上一个批注。

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

方法详细信息

### deleteComment

    public void deleteComment(long offset,
                              long length)

  删除指定区域内的所有批注。如果某个批注的起始位置或终止位置包含在指定区域内，那么这个批注不会被删除。 只有批注的起始位置和终止位置都包含在指定的区域内，批注才会被删除。

  参数：
    `offset` - 批注的起始位置
    `length` - 指定长度

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment1 = comments.insert(0,3);
         comment1.setText("批注信息1");
         Comment comment2 = comments.insert(4,3);
         comment2.setText("批注信息2");
         comments.deleteComment(0,8);

  抛出：
    `application.exceptions.MacroRunException` - 指定的offset小于0或大于文档长度
    `application.exceptions.MacroRunException` - 当length小于0或offset + length 大于文档长度
  另请参见：
    `insertComment(long, long)`

### editComment

    public void editComment(long offset)

  批注进入编辑状态。

  参数：
    `offset` - 批注的起始位置

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment = comments.insert(0,3);
         comment.setText("新的批注信息");
         comments.editComment(2);

  抛出：
    `application.exceptions.MacroRunException` - 指定的offset小于0或大于文档长度

### getAllComments

    public Comment[] getAllComments()

  获得所有的批注对象。

  返回：
    返回所有的批注对象

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment1 = comments.insert(0,3);
         comment1.setText("批注信息1");
         Comment comment2 = comments.insert(4,3);
         comment2.setText("批注信息2");
         Comment[] allcoments = comments.getAllComments();
         for (int i = 0; i < allcoments.length; i++)
         {
             System.out.println("第"+i+"个批注的信息是："+allcoments[i].getText());
         }

### getComment

    public Comment getComment(long offset)

  返回指定偏移量的批注

  参数：
    `offset` - 指定偏移量
  返回：
    返回指定偏移量的批注

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment1 = comments.insert(0,3);
         comment1.setText("批注信息1");
         Comment comment2 = comments.insert(4,3);
         comment2.setText("批注信息2");
         Comment curcomment = comments.getComment(2);
         System.out.println("得到指定的批注信息是："+curcomment.getText());

  抛出：
    `application.exceptions.MacroRunException` - 指定的offset小于0或大于文档长度

### getCount

    public int getCount()

  获取批注对象在系统表中的个数。

  返回：
    返回批注对象在系统表中的个数

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment1 = comments.insert(0,3);
         comment1.setText("批注信息1");
         Comment comment2 = comments.insert(4,3);
         comment2.setText("批注信息2");
         System.out.println("当前文档的批注数为："+comments.getCount());

### insertComment

    public Comment insertComment(long offset,
                                 long length)

  插入批注。

  参数：
    `offset` - 批注的起始位置
    `length` - 插入批注的长度

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment = comments.insert(0,3);
         comment.setText("新的批注信息");

  抛出：
    `application.exceptions.MacroRunException` - 指定的offset小于0或大于文档长度
    `application.exceptions.MacroRunException` - 当length小于0或offset + length 大于文档长度
  另请参见：
    `deleteComment(long, long)`

### next

    public Comment next(long offset)

  光标移动到下一个批注。

  参数：
    `offset` - 设置光标的起始位置

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment1 = comments.insert(5,3);
         comment1.setText("批注信息1");
         Comment comment2 = comments.insert(9,3);
         comment2.setText("批注信息2");
         Comment nextcomment = comments.next(2);
         System.out.println("后一个批注的信息是："+nextcomment.getText());

  抛出：
    `application.exceptions.MacroRunException` - 指定的offset小于0或大于文档长度

### previous

    public Comment previous(long offset)

  光标移动到上一个批注。

  参数：
    `offset` - 设置光标的起始位置

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         BaseText text = doc.getSection(0).getBaseText();
         text.insertText(0,"this is a test!");
         WpComments comments = doc.getComments();
         Comment comment1 = comments.insert(0,3);
         comment1.setText("批注信息1");
         Comment comment2 = comments.insert(4,3);
         comment2.setText("批注信息2");
         Comment precomment = comments.previous(8);
         System.out.println("前一个批注的信息是："+precomment.getText());

  抛出：
    `application.exceptions.MacroRunException` - 指定的offset小于0或大于文档长度

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

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