Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook
Class Documents

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

public class Documents
extends java.lang.Object

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

Method Summary
`Document` | `addDocument(java.lang.String documentName)` 添加一个文档。
`Document[]` | `getAllDocuments()` 返回当前集成文件中所有的文档。
`Document` | `getDocument(java.lang.String documentName)` 返回一个文档。
`Document` | `newDocument()` 添加一个默认格式的文档。
`Document` | `openDocument(java.lang.String name)` 打开一个文档。
`void` | `removeDocument(java.lang.String documentName)` 删除一个文档。
`void` | `renameDocument(java.lang.String oldName, java.lang.String newName)` 重命名一个文档。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### addDocument

    public Document addDocument(java.lang.String documentName)

  添加一个文档。

  Parameters:
    `documentName` - 需要添加的文档的名字。当documentName为null时，添加的文档名称为默认名称。
  Returns:
    新建的文档

    例子:

         Application.getWorkbooks().getActiveWorkbook().getDocuments().addDocument(
         		"我的文档");

  See Also:
    `getDocument(String)`, `removeDocument(String)`, `renameDocument(String,String)`, `Document`

### getAllDocuments

    public Document[] getAllDocuments()

  返回当前集成文件中所有的文档。

  Returns:
    Document[] 返回当前集成文件中所有的文档组成的一个数组

    例子:

         Document[] documents = Application.getWorkbooks().getActiveWorkbook()
         		.getDocuments().getAllDocuments();
         System.out.println("返回所有文档的个数为：" + documents.length);

  See Also:
    `Document`

### getDocument

    public Document getDocument(java.lang.String documentName)

  返回一个文档。

  Parameters:
    `documentName` - 需要返回的文档的名字
  Returns:
    Document

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
         		.getDocument("文档1");

  See Also:
    `Document`, `removeDocument(String)`, `renameDocument(String,String)`, `addDocument(String)`

### newDocument

    public Document newDocument()

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

  Returns:
    新建的文档。

    例子:

         Application.getWorkbooks().getActiveWorkbook().getDocuments().newDocument();

  See Also:
    `getDocument(String)`, `removeDocument(String)`, `renameDocument(String,String)`

### openDocument

    public Document openDocument(java.lang.String name)

  打开一个文档。

  Parameters:
    `name` - 需要打开一个文档的名字
  Returns:
    指定名称的文档，如没有则返回null

    例子:

         Application.getWorkbooks().getActiveWorkbook().getDocuments().openDocument(
         		"文档2");

  See Also:
    `getDocument(String)`, `removeDocument(String)`, `renameDocument(String,String)`

### removeDocument

    public void removeDocument(java.lang.String documentName)

  删除一个文档。

  Parameters:
    `documentName` - 需要删除的文档的名字

    例子:

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

  See Also:
    `getDocument(String)`, `renameDocument(String,String)`, `addDocument(String)`

### renameDocument

    public void renameDocument(java.lang.String oldName,
                               java.lang.String newName)

  重命名一个文档。

  Parameters:
    `oldName` - 需要重命名的文档的旧名字
    `newName` - 更名后的文档的新名字

    例子:

         Application.getWorkbooks().getActiveWorkbook().getDocuments().renameDocument(
         		"文档1", "文档2");

  See Also:
    `getDocument(String)`, `removeDocument(String)`, `addDocument(String)`

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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