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

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

## application.workbooks.workbook
类 Documents

    java.lang.Object
      application.workbooks.workbook.Documents

    public class Documents

extends java.lang.Object

该类是一个容器，用于管理文字处理。

方法摘要
`Document` | `addDocument()` 添加一个默认格式的文字处理文档。
`Document` | `addDocument(java.lang.String name)` 添加一个文字处理文档。
`void` | `clearDifference()` 此方法用于清除对比文档中不同之处的高亮显示，对于普通设置的高亮显示无效。
`void` | `closeDocument(java.lang.String name)` 关闭指定的文字处理文档。
`void` | `compareDocument(Document doc1, Document doc2, java.awt.Color color)` 对比两个文档，以指定的高亮颜色标示出内容不同的位置。
`Document` | `getActiveDocument()` 获取当前活动文字处理文档对象。
`Document[]` | `getAllDocuments()` 返回当前集成文件中所有的文字处理文档。
`Document` | `getDocument(java.lang.String name)` 返回一个文字处理文档。
`Document` | `openDocument(java.lang.String name)` 打开一个已经被关闭的文字处理文档。
`void` | `removeDocument(java.lang.String name)` 删除一个文字处理文档。
`Document` | `rename(java.lang.String oldName, java.lang.String newName)` 重命名一个文字处理文档。

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

方法详细信息

### addDocument

    public Document addDocument()

  添加一个默认格式的文字处理文档。

  返回：
    新建的文字处理文档。

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().addDocument();
         System.out.println("新增文档的名字是：" + doc.getName());

  另请参见：
    `getDocument(String)`, `removeDocument(String)`, `rename(String,String)`

### addDocument

    public Document addDocument(java.lang.String name)

  添加一个文字处理文档。

  参数：
    `name` - 需要添加的文字处理文档的名字。
  返回：
    新建的文字处理文档

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().addDocument("我的文档");
         BaseText baseText = doc.getSection(0).getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
         System.out.println("新增文档的内容是："+baseText.getText(0,baseText.getTextLength()));

  抛出：
    `application.exceptions.MacroRunException` - 当名称中含有非法字符或空字符
    `application.exceptions.MacroRunException` - 当文档中已经存在相同名字的文字处理文档
  另请参见：
    `getDocument(String)`, `removeDocument(String)`, `rename(String,String)`, `Document`

### clearDifference

    public void clearDifference()

  此方法用于清除对比文档中不同之处的高亮显示，对于普通设置的高亮显示无效。

  例子:

       Documents docs = Application.getWorkbooks().getActiveWorkbook().getDocuments();
       docs.addDocument("文档1");
       docs.addDocument("文档2");
       Document doc1 = docs.getDocument("文档1");
       Document doc2 = docs.getDocument("文档2");
       doc1.getSection(0).getBaseText().insertText(0,"this is a test!!");
       doc2.getSection(0).getBaseText().insertText(0,"this is a text");
       docs.compareDocument(doc1,doc2,Color.YELLOW);
       docs.clearDifference();

### closeDocument

    public void closeDocument(java.lang.String name)

  关闭指定的文字处理文档。

  参数：
    `name` - 文字处理文档名。

    例子:

         Documents docs = Application.getWorkbooks().getActiveWorkbook().getDocuments();
         docs.closeDocument("文档1");

### compareDocument

    public void compareDocument(Document doc1,
                                Document doc2,
                                java.awt.Color color)

  对比两个文档，以指定的高亮颜色标示出内容不同的位置。

  参数：
    `doc1` - 要比较的文档,如果为null，则不做比较
    `doc2` - 要比较的文档,如果为null，则不做比较
    `color` - 在不同处显示的高亮颜色,如果为null，则不做高亮显示。

    例子:

         Documents docs = Application.getWorkbooks().getActiveWorkbook().getDocuments();
         docs.addDocument("文档1");
         docs.addDocument("文档2");
         Document doc1 = docs.getDocument("文档1");
         Document doc2 = docs.getDocument("文档2");
         doc1.getSection(0).getBaseText().insertText(0,"this is a test!!");
         doc2.getSection(0).getBaseText().insertText(0,"this is a text");
         docs.compareDocument(doc1,doc2,Color.YELLOW);

### getActiveDocument

    public Document getActiveDocument()

  获取当前活动文字处理文档对象。

  返回：
    Document 当前活动文字处理文档对象，如当前活动窗口对象不是文字处理文档，则返回Null

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         System.out.println("当前文档的名字是："+doc.getName());

  另请参见：
    `Document`

### getAllDocuments

    public Document[] getAllDocuments()

  返回当前集成文件中所有的文字处理文档。如果如果当前没有文字处理文档 ，则返回的数组长度为0。

  返回：
    Document[] 返回当前集成文件中所有的文字处理文档组成的一个数组

    例子:

         Documents docs = Application.getWorkbooks().getActiveWorkbook().getDocuments();
         docs.addDocument();
         Document[] documents = docs.getAllDocuments();
         System.out.println("当前集成文件所有文档的个数为：" + documents.length);

  另请参见：
    `Document`

### getDocument

    public Document getDocument(java.lang.String name)

  返回一个文字处理文档。

  参数：
    `name` - 需要返回的文字处理文档的名字
  返回：
    Document 如果对应的文字处理文档不存在，返回null

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getDocument("文档1");
         if (doc != null)
         {
             BaseText baseText = doc.getSection(0).getBaseText();
             baseText.insertText(0,"this is a test!\nthis is a test!\nthis is a test!");
             System.out.println("当前文档的内容是："+baseText.getText(0,baseText.getTextLength()));
         }

  另请参见：
    `Document`, `removeDocument(String)`, `rename(String,String)`, `addDocument(String)`

### openDocument

    public Document openDocument(java.lang.String name)

  打开一个已经被关闭的文字处理文档。

  参数：
    `name` - 需要打开一个文字处理文档的名字
  返回：
    指定名称的文字处理文档，如果文字处理文档不存在，返回null。

    例子:

         Documents docs = Application.getWorkbooks().getActiveWorkbook().getDocuments();
         docs.addDocument();
         docs.closeDocument("文档1");
         Document doc = docs.openDocument("文档1");
         if (doc != null)
         {
             System.out.println("当前打开的文档名是：" + doc.getName());
         }
         else
         {
             System.out.println("文档1打开失败！");
         }

  另请参见：
    `getDocument(String)`, `removeDocument(String)`, `rename(String,String)`

### removeDocument

    public void removeDocument(java.lang.String name)

  删除一个文字处理文档。

  参数：
    `name` - 需要删除的文字处理文档的名字

    例子:

         Application.getWorkbooks().getActiveWorkbook().getDocuments().removeDocument("文档1");

  另请参见：
    `getDocument(String)`, `rename(String,String)`, `addDocument(String)`

### rename

    public Document rename(java.lang.String oldName,
                           java.lang.String newName)

  重命名一个文字处理文档。

  参数：
    `oldName` - 需要重命名的文字处理文档的旧名字
    `newName` - 更名后的文字处理文档的新名字
  返回：
    重命后的文字处理文档，如果需要重命名的文字处理文档不存在，则返回null。

    例子:

         Documents docs = Application.getWorkbooks().getActiveWorkbook().getDocuments();
         Document newDoc = docs.rename("文档1", "文档11");
         newDoc = docs.open("文档11");
         if (newDoc != null)
         {
            System.out.println("重命名后的文档的名字是：" + newDoc.getName());
         }
         else
         {
            System.out.println("文档11 不存在或没有打开！");
         }

  抛出：
    `application.exceptions.MacroRunException` - 当新名称中含有非法字符或空字符
    `application.exceptions.MacroRunException` - 当文档中已经存在新名字的文字处理文档。
  另请参见：
    `getDocument(String)`, `removeDocument(String)`, `addDocument(String)`

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

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