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

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

## application
类 Workbooks

    java.lang.Object
      application.Workbooks

    public class Workbooks

extends java.lang.Object

该类定义了对集成文件集合对象进行操作的一些方法，如新建集成文件，获取当前集成文件等。

该类对象可以通过Application中getWorkbooks()方法得到。

构造函数摘要
`Workbooks()`

方法摘要
`Workbook` | `addWorkbook(int type)` 新建一个集成文件。
`Workbook` | `addWorkbook(java.lang.String bookName, int type)` 新建一个自定义名字的集成文件。
`Workbook` | `addWorkbookByTemplate(java.lang.String templateName)` 新建一个带模板样式的集成文件。
`void` | `clearClipboard()` 清除剪贴板的内容。
`void` | `clearDifference()` 清除文档比对高亮显示。
`void` | `closeAll()` 关闭永中集成Office中的所有集成文件。
`Workbook` | `createWorkbookFromByteArray(byte[] data, java.lang.String bookName)` 从一个byte数组创建一个永中Office文件。
`Workbook` | `getActiveWorkbook()` 获取当前活动集成文件。
`Workbook[]` | `getAllWorkbooks()` 获得当前的所有集成文件对象的数组。
`Workbook` | `getWorkbook(java.lang.String bookName)` 根据集成文件名称获取集成文件对象。
`byte[]` | `getWorkbookAsByteArray(Workbook book)` 读取一个永中Office文件,在内存中复制,将复制的永中Office文件以byte数组返回。
`byte[]` | `getWorkbookAsByteArray(Workbook book, int type)` 读取一个永中Office文件,在内存中复制,将复制的永中Office文件以byte数组返回。
`static boolean` | `isPGPreview(java.io.File file)` 根据文件判断是否是PG的模板文件。
`boolean` | `openFromStream(byte[] docstream, int formatType)` 内存流打开。
`Workbook` | `openWorkbook(java.lang.String fileName)` 打开一个集成文件。
`Workbook` | `openWorkbook(java.lang.String fileName, int option)` 打开一个集成文件。
`void` | `saveAll()` 保存永中集成Office中的所有集成文件。
`void` | `setContentManagerKeyFlag(boolean isActive)` 设置是否激活词库。
`int` | `size()` 返回集成文件的数目。
`byte[]` | `transformFormat(byte[] srcBytes, int formatType)` 格式转换。

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

构造函数详细信息

### Workbooks

    public Workbooks()

方法详细信息

### addWorkbook

    public Workbook addWorkbook(int type)

  新建一个集成文件。

  参数：
    `type` - 应用类型，只能取以下四值之一：

                  GlobalConstants.NO_PRODUCT    =空的集成文件;
                  GlobalConstants.SPREADSHEET   =电子表格集成文件；
                  GlobalConstants.WORDPROCESSOR =文字处理集成文件；
                  GlobalConstants.PRESENTATION  =简报制作集成文件；

  返回：
    创建的Workbook,当新建不成功时返回null。

    例子：

         //新建一简报制作集成文件。
         Workbooks workbooks = Application.getWorkbooks();
         workbooks.addWorkbook(GlobalConstants.PRESENTATION);

  抛出：
    `MacroRunException` - 应用类型不在上述四个中。
  另请参见：
    `addWorkbook(String, int)`

### addWorkbook

    public Workbook addWorkbook(java.lang.String bookName,
                                int type)

  新建一个自定义名字的集成文件。

  因为在当前Workbooks下面集成文件的名称具有唯一性，所以添加的文件名称必须与已有的不重复。

  参数：
    `bookName` - 是一个文件名，默认将其新建在缺省保存路径里。
    `type` - 应用类型，只能取以下四值之一：

                  GlobalConstants.NO_PRODUCT    =空的集成文件;
                  GlobalConstants.SPREADSHEET   =电子表格集成文件；
                  GlobalConstants.WORDPROCESSOR =文字处理集成文件；
                  GlobalConstants.PRESENTATION  =简报制作集成文件；

  返回：
    新建的Workbook，当新建不成功时返回null。

    例子：

         //新建一名字为test.eio的文字处理集成文件。
         Application.getWorkbooks().addWorkbook("test.eio",GlobalConstants.WORDPROCESSOR);

  抛出：
    `MacroRunException` - 文件名称不合法。
  另请参见：
    `addWorkbook(int)`

### addWorkbookByTemplate

    public Workbook addWorkbookByTemplate(java.lang.String templateName)

  新建一个带模板样式的集成文件。

  新建的集成文件名称为默认名称如"集成文件3.eio"而不是模版样式的名称。

  参数：
    `templateName` - 模板文件名（绝对路径）
  返回：
    新建的集成文件，当新建不成功时返回null。

    例子：

         //新建一模版样式为调查问卷的集成文件。
         Application.getWorkbooks().addWorkbookByTemplate("C:/Program Files/Evermore/EIOffice/Templates/Wordprocessor/通用文书/调查问卷.eit");

  抛出：
    `MacroRunException` - 模板文件名名称不合法。
  另请参见：
    `addWorkbook(int)`, `addWorkbook(String, int)`

### clearClipboard

    public void clearClipboard()

  清除剪贴板的内容。

  例子：

       //清除剪贴板内容
       Workbooks workbooks = Application.getWorkbooks();
       workbooks.clearClipboard() ;

### clearDifference

    public void clearDifference()

  清除文档比对高亮显示。

  例子:

       //清除文档比对高亮显示。
       Application.getWorkbooks().clearDifference();

### closeAll

    public void closeAll()

  关闭永中集成Office中的所有集成文件。

  例子：

       //关闭所有集成文件。
       Application.getWorkbooks().closeAll();

### createWorkbookFromByteArray

    public Workbook createWorkbookFromByteArray(byte[] data,
                                                java.lang.String bookName)
                                         throws java.io.IOException

  从一个byte数组创建一个永中Office文件。

  当data数组为null，或者不是通过getWorkbookAsByteArray方法得到的数组 或者bookName为null或为空，或者创建不成功,则返回null。

  参数：
    `data` - 以byte数组表示的数据源，此数组是通过getWorkbookAsByteArray()方法创建的。
    `bookName` - 要创建的集成文件名称。
  返回：
    返回新建的Workbook。

    例子：

         //把当前集成文件复制成byte数组，再关闭当前集成文件，然后利用这byte数组新建一名为test12.eio的集成文件。
         try
         {
            Workbook book1 = Application.getWorkbooks().getActiveWorkbook();
            byte[] bytes = Application.getWorkbooks().getWorkbookAsByteArray(book);
            book1.close();
            Workbook book2 = Application.getWorkbooks().createWorkbookFromByteArray(bytes,"test12.eio");
         }
         catch(IOException e)
         {
         }

  抛出：
    `java.io.IOException` - 从byte数组创建Workbook失败时抛出异常。
  另请参见：
    `getWorkbookAsByteArray(Workbook)`, `getWorkbookAsByteArray(Workbook, int)`

### getActiveWorkbook

    public Workbook getActiveWorkbook()

  获取当前活动集成文件。

  返回：
    当前活动集成文件

    例子：

         //获取当前活动集成文件并保存它。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook();
         workbook.save();

### getAllWorkbooks

    public Workbook[] getAllWorkbooks()

  获得当前的所有集成文件对象的数组。

  返回：
    集成文件对象数组。

    例子：

         //获得当前的所有集成文件对象，并在其数组第0个添加一同心圆。
         Workbook[] books = Application.getWorkbooks().getAllWorkbooks();
         books[0].getActiveShapes().addShape(18,80,100,290,280);

### getWorkbook

    public Workbook getWorkbook(java.lang.String bookName)

  根据集成文件名称获取集成文件对象。

  参数：
    `bookName` - 集成文件名
  返回：
    集成文件对象

    例子：

         //获取名为"集成文件1.eio"的集成文件并保存它。
         Workbook workbook = Application.getWorkbooks().getWorkbook("集成文件1.eio");
         workbook.save() ;

### getWorkbookAsByteArray

    public byte[] getWorkbookAsByteArray(Workbook book)
                                  throws java.io.IOException

  读取一个永中Office文件,在内存中复制,将复制的永中Office文件以byte数组返回。

  当此永中Office文件为空则返回null。或者在数组生成过程中产生错误也会返回null，此时请保留EIOfficelog.txt文件 和此永中office文件，并与客服联系，我们将尽快查找原因。

  参数：
    `book` - Workbook的对象。
  返回：
    将复制的永中Office文件以byte数组返回。

    例子：

         //新建一byte数组，并把当前Workbook复制成byte数组的形式赋值于此byte数组。
          byte[] bytes = null;
          Workbook book = Application.getWorkbooks().getActiveWorkbook();
          try
          {
              bytes = Application.getWorkbooks().getWorkbookAsByteArray(book);
          }
         catch(IOException e)
         {
         }

  抛出：
    `java.io.IOException` - 从Workbook创建byte数组失败时抛出异常。
  另请参见：
    `getWorkbookAsByteArray(Workbook, int)`, `createWorkbookFromByteArray(byte[], String)`

### getWorkbookAsByteArray

    public byte[] getWorkbookAsByteArray(Workbook book,
                                         int type)
                                  throws java.io.IOException

  读取一个永中Office文件,在内存中复制,将复制的永中Office文件以byte数组返回。

  当Workbook对象为空或者保存类型不在上述之列则返回null。或者在数组生成过程中产生错误也会返回null， 此时请保留EIOfficelog.txt文件和此永中office文件，并与客服联系，我们将尽快查找原因。

  参数：
    `book` - Workbook的对象
    `type` - 保存类型

                FileConstants.TYPE_EIO      保存EIO
                FileConstants.TYPE_MS       保存MS三种格式(视当前应用而定，可能是xls,doc或ppt)
                FileConstants.TYPE_PDF      保存pdf
                FileConstants.TYPE_UOF      保存uof
                FileConstants.TYPE_RTF      保存rtf
                FileConstants.TYPE_TXT      保存纯文本

  返回：
    对应的byte数组。

    例子：

         //把当前Workbook复制成pdf类型的byte数组，然后利用其创建一pdf文件。
          byte[] bytes = null;
          Workbook book = Application.getWorkbooks().getActiveWorkbook();
          try
          {
              bytes = Application.getWorkbooks().getWorkbookAsByteArray(book,FileConstants.TYPE_PDF);
              File file = new File("C:/Test.pdf");
              FileOutputStream fos = new FileOutputStream(file);
              fos.write(bytes);
              fos.flush();
              fos.close();
          }
         catch(IOException e)
         {
         }

  抛出：
    `java.io.IOException` - 从Workbook创建byte数组失败时抛出异常。
  另请参见：
    `getWorkbookAsByteArray(Workbook)`, `createWorkbookFromByteArray(byte[], String)`

### isPGPreview

    public static boolean isPGPreview(java.io.File file)

  根据文件判断是否是PG的模板文件。

  参数：
    `file` - 文件对象
  返回：
    boolean 是否PG的模板文件

    例子:

         //在控制台上输出d:/aaa.eit是否为PG的模板文件。
         File file = new File("d:/aaa.eit");
         boolean isPg = Application.getWorkbooks().isPGPreview(file);
         System.out.println(isPg);

### openFromStream

    public boolean openFromStream(byte[] docstream,
                                  int formatType)

  内存流打开。

  参数：
    `docstream` - 数据类型为字节流，为文件内容
    `formatType` - 文件格式类型，其中值可以为：

         FileConstants.TYPE_EIO   (EIO文件格式)
         FileConstants.TYPE_MS    (MS文件格式)
         FileConstants.TYPE_PDF   (PDF文件格式)
         FileConstants.TYPE_UOF   (UOF文件格式)
         FileConstants.TYPE_RTF   (RTF文件格式)
         FileConstants.TYPE_TXT   (TXT文件格式)

  返回：
    如果成功为TRUE；如果失败为FALSE

    例子：

          Workbook workbook = Application.getWorkbooks().getActiveWorkbook();
          try
         {
           byte[] stream = Application.getWorkbooks().getWorkbookAsByteArray(workbook);
           workbook.close();
           boolean ret = Application.getWorkbooks().openFromStream(stream, FileConstants.TYPE_MS);
           System.out.println("ret : " + ret);
         }
         catch(Exception ex)
         {
         }

  另请参见：
    `FileConstants`

### openWorkbook

    public Workbook openWorkbook(java.lang.String fileName)

  打开一个集成文件。

  因为在当前Workbooks下面集成文件的名称具有唯一性，所以打开的文件名称必须与已有的不重复。

  打开方式为正常打开。

  参数：
    `fileName` - 永中集成Office支持打开的文件格式类型名称

    例子：

         //打开C:/EIO_Binders/testmacro.eio的集成文件。
         Application.getWorkbooks().openWorkbook("C:/EIO_Binders/testmacro.eio");

### openWorkbook

    public Workbook openWorkbook(java.lang.String fileName,
                                 int option)

  打开一个集成文件。

  因为在当前Workbooks下面集成文件的名称具有唯一性，所以打开的文件名称必须与已有的不重复。

  参数：
    `fileName` - 永中集成Office支持打开的文件格式类型名称
    `option` - 打开方式

                              option = 1 正常打开
                              option = 2 以只读方式打开
                              option = 3 以副本方式打开

    例子：

         //以正常方式打开C:/EIO_Binders/testmacro.eio的文件。
         Application.getWorkbooks().openWorkbook("C:/EIO_Binders/testmacro.eio",1);

### saveAll

    public void saveAll()

  保存永中集成Office中的所有集成文件。

  例子：

       //保存所有集成文件。
       Application.getWorkbooks().saveAll();

### setContentManagerKeyFlag

    public void setContentManagerKeyFlag(boolean isActive)

  设置是否激活词库。

  激活后文档中关键词将加上波浪线，在关键词上点右键将弹出同组关键词右键菜单,选择菜单中关键词将替换文档中关键词。

  参数：
    `isActive` - 是否打开词库

    例子:

         //设置激活词库。
         Application.getWorkbooks().setContentManagerKeyFlag(true);

### size

    public int size()

  返回集成文件的数目。

  返回：
    集成文件的数目

    例子：

         //在控制台上输出集成文件的数目。
         System.out.println(Application.getWorkbooks().size());

### transformFormat

    public byte[] transformFormat(byte[] srcBytes,
                                  int formatType)

  格式转换。

  参数：
    `srcBytes` - 数据类型为字节流，用来存放需要转换的文档内容
    `formatType` - 文件格式类型，其中值可以为：

         FileConstants.TYPE_EIO   (EIO文件格式)
         FileConstants.TYPE_MS    (MS文件格式)
         FileConstants.TYPE_PDF   (PDF文件格式)
         FileConstants.TYPE_UOF   (UOF文件格式)
         FileConstants.TYPE_RTF   (RTF文件格式)
         FileConstants.TYPE_TXT   (TXT文件格式)

  返回：
    转换结果内容的字节流

    例子：

         Workbooks workbooks = Application.getWorkbooks();
         byte[] stream = workbooks.getActiveWorkbook().saveAsStream(FileConstants.TYPE_MS);
         System.out.println("stream : " +stream);
         byte[] stream2 = workbooks.transformFormat(stream, FileConstants.TYPE_RTF);
         try
         {
           Workbook workbook = workbooks.createWorkbookFromByteArray(stream2, "my.eio");
          System.out.println("workbook : " + workbook);
         }
         catch(Exception ex)
         {
         }

  另请参见：
    `FileConstants`

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

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

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