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

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

## application.workbooks
类 Workbook

    java.lang.Object
      application.workbooks.Workbook

    public class Workbook

extends java.lang.Object

该类定义了对某一集成文件对象进行操作的一些方法，如保存或关闭集成文件，获取集成文件中的电子表格，文字处理和简报制作文档管理器对象。

一个Workbook对象对应于一个集成文件。可以通过Workbooks中方法得到Workbook。

方法摘要
`void` | `addWorkbookListener(WorkbookListener l)` 向Workbook添加监听器。
`void` | `clearUndoList()` 清空集成文件的Undo列表。
`void` | `close()` 关闭某一集成文件。
`java.lang.String` | `getAbsolutePath()` 获得Workbook的名称，名称包含其绝对路径。
`Shapes` | `getActiveShapes()` 获取当前应用的自选图形管理器。
`Charts` | `getCharts()` 返回图表的管理器
`CustomFileProperties` | `getCustomFileProperties()` 获取当前集成文件自定义属性对象。
`Documents` | `getDocuments()` 返回文字处理管理器对象。
`FileProperties` | `getFileProperties()` 获取当前集成文件属性。
`java.lang.String` | `getName()` 获得Workbook的名字，不含绝对路径。
`Presentations` | `getPresentations()` 返回简报制作管理器对象。
`Print` | `getPrint()` 返回当前集成文件中的打印对象，如果没有应用，则返回null。
`Versions` | `getVersions()` 得到集成文件的版本管理对象。
`Worksheets` | `getWorksheets()` 返回电子表格管理器对象。
`void` | `importMsFile(java.lang.String msFileName)` 将微软件文档导入到集成文件中。
`void` | `importTemplate(java.lang.String path)` 导入一个模板应用。
`boolean` | `isModified()` 返回当前文档是否被修改的标志
`java.lang.String[]` | `printAllDocuments()` 打印该集成文件中所有文字处理文档。
`void` | `removeWorkbookListener(WorkbookListener l)` 移除向Workbook添加的监听器
`void` | `save()` 保存某一集成文件。
`void` | `saveAs(java.lang.String name)` 把当前集成文件另存为别的文件名称。
`void` | `saveAs(java.lang.String newName, int dataFlag)` 把当前集成文件另存为别的文件。
`boolean` | `saveAsPDF(java.lang.String fileName, PDFAttribute pdfAttr)` 根据指定的pdf属性对当前的应用文档设置保存PDF文档。
`byte[]` | `saveAsStream(int formatType)` 内存流保存。
`void` | `setAutoSave(boolean saveFlag)` 设置Workbook的即时存盘。
`void` | `setModifiedFlag(boolean flag)` 设置当前文档修改标志。
`void` | `setTrackRevision(boolean isTrack)` 修订整个集成文件。

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

方法详细信息

### addWorkbookListener

    public void addWorkbookListener(WorkbookListener l)

  向Workbook添加监听器。

  参数：
    `l` - 需要添加的监听器 注：在宏编辑器中运行如下例子需要去除"public"。

    例子:

         //向Workbook添加一监听器,当工作簿发生改变时激发。
         final Workbook book = Application.getWorkbooks().getActiveWorkbook();
         book.addWorkbookListener(new application.event.WorkbookListener()
         {
              public void bookChanged(WorkbookEvent e)
               {
               }
         });

### clearUndoList

    public void clearUndoList()

  清空集成文件的Undo列表。

  例子:

        //清空当前集成文件Undo列表。
        Application.getWorkbooks().getActiveWorkbook().clearUndoList();

  自从：
    1.33

### close

    public void close()

  关闭某一集成文件。

  直接关闭，不弹保存对话框。

  例子:

       //关闭当前集成文件。
       Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
       workbook.close() ;

### getAbsolutePath

    public java.lang.String getAbsolutePath()

  获得Workbook的名称，名称包含其绝对路径。

  返回：
    Workbook的名称。

    例子:

         //在控制台上输出Workbook的名称。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         System.out.println(workbook.getAbsolutePath()) ;

### getActiveShapes

    public Shapes getActiveShapes()

  获取当前应用的自选图形管理器。

  返回：
    当前应用的自选图形管理器

    例子：

         //在当前应用中添加一同心圆。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.getActiveShapes().addShape(18,380,180,690,380) ;

### getCharts

    public Charts getCharts()

  返回图表的管理器

  返回：
    图表管理器

    例子:

         //添加单元格图表。
         Workbook workbook = Application.getWorkbooks().addWorkbook(GlobalConstants.SPREADSHEET);
         Charts charts = workbook.getCharts();
         charts.addCellChart(ChartConstants.EMOCHART_COLUMN,ChartConstants.EMOCOLUMN_STACKED,"工作表2",15,7);

### getCustomFileProperties

    public CustomFileProperties getCustomFileProperties()

  获取当前集成文件自定义属性对象。

  返回：
    集成文件自定义属性对象

    例子:

         //通过获取的当前集成文件自定义属性对象来添加一自定义属性名。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         CustomFileProperties cus = workbook.getCustomFileProperties();
         cus.add("abc",CustomPropertyConstants.DATE,"2005-10-08") ;

### getDocuments

    public Documents getDocuments()

  返回文字处理管理器对象。

  返回：
    文字处理管理器对象。

    例子：

         //在当前集成文件中添加文字处理。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.getDocuments().addDocument();

### getFileProperties

    public FileProperties getFileProperties()

  获取当前集成文件属性。

  文件属性包含文件类型，位置，大小，标题，主题，作者等。

  返回：
    集成文件属性

    例子:

         //设置当前集成文件属性作者名为evermore。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.getFileProperties().setFileAuthor("evermore") ;

### getName

    public java.lang.String getName()

  获得Workbook的名字，不含绝对路径。

  返回：
    Workbook的名字，如"集成文件3.eio"。

    例子:

         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         System.out.println(workbook.getName()) ;

### getPresentations

    public Presentations getPresentations()

  返回简报制作管理器对象。

  返回：
    简报制作管理器对象。

    例子：

         //在当前集成文件中添加简报制作。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.getPresentations().addPresentation();

### getPrint

    public Print getPrint()

  返回当前集成文件中的打印对象，如果没有应用，则返回null。

  返回：
    当前应用的打印对象

    例子:

          //获取当前集成文件的打印对象，并打印。
         Print print = Application.getWorkbooks().getActiveWorkbook().getPrint();
         print.print();

### getVersions

    public Versions getVersions()

  得到集成文件的版本管理对象。

  返回：
    集成文件的版本管理对象

    例子：

         //获取集成文件的版本管理对象，并保存一批注为test的版本。
         Versions versions =  Application.getWorkbooks().getActiveWorkbook().getVersions();
         versions.save("test");

### getWorksheets

    public Worksheets getWorksheets()

  返回电子表格管理器对象。

  返回：
    电子表格管理器对象。

    例子:

         //在当前集成文件中添加电子表格。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.getWorksheets().addWorksheet() ;

### importMsFile

    public void importMsFile(java.lang.String msFileName)

  将微软件文档导入到集成文件中。

  参数：
    `msFileName` - 微软office文件名。

    例子:

         //将C:/test.doc导入到当前集成文件中。
          Application.getWorkbooks().getActiveWorkbook().importMsFile("C:/test.doc");

  抛出：
    `MacroRunException` - 文件不存在。

### importTemplate

    public void importTemplate(java.lang.String path)

  导入一个模板应用。

  参数：
    `path` - 模板的路径

    例子:

         //在当前集成文件中导入一推荐信的模版应用。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.importTemplate("C:\\Program Files\\Evermore\\EIOffice\\Templates\\Wordprocessor\\求职简历\\推荐信.eit") ;

  抛出：
    `MacroRunException` - 模版不存在。

### isModified

    public boolean isModified()

  返回当前文档是否被修改的标志

  返回：
    true 被修改过 false 没有被修改过

    例子:

         //在控制台上输出当前文档是否被修改。
         System.out.println(Application.getWorkbooks().getActiveWorkbook().isModified()) ;

### printAllDocuments

    public java.lang.String[] printAllDocuments()

  打印该集成文件中所有文字处理文档。

  返回：
    文档名和成功标志

    例子:

         //打印所有文字处理。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.printAllDocuments();

### removeWorkbookListener

    public void removeWorkbookListener(WorkbookListener l)

  移除向Workbook添加的监听器

  参数：
    `l` - 需要移除的监听器 注：在宏编辑器中运行如下例子需要去除"public"

    例子:

         //创建一监听器，然后先向一Workbook添加此监听器,再在此Workbook中移除它。
         final WorkbookListener l = new WorkbookListener()
          {
                public void bookChanged(WorkbookEvent e)
                {
                    if (e.getType() == WorkbookEvent.NEW_PRESENTATION)
                    {
                    }
                }
           };
         final Workbook book = Application.getWorkbooks().getActiveWorkbook();
         book.addWorkbookListener(l);
         book.removeWorkbookListener(l);

### save

    public void save()

  保存某一集成文件。

  对应于未保存新集成文件，会弹另存为对话框。

  例子:

       //保存当前集成文件。
       Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
       workbook.save() ;

### saveAs

    public void saveAs(java.lang.String name)

  把当前集成文件另存为别的文件名称。

  参数：
    `name` - 另存的新文件名，带路径，如"C:/EIO_Binders/evermore.eio"。

    当前永中Office可以另存为的格式有.eio .doc .xls .ppt .uof .pdf .rtf .html .htm .eit .dot .xlt .txt .jpg .png .bmp .tiff .csv 另存为的格式以后缀名为区别，如要另存为pdf格式，Workbook.saveAs("C:/EIO_Binders/read.pdf")

    例子:

         //把当前集成文件另存为C:/EIO_Binders/evermore.eio。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.saveAs("C:/EIO_Binders/evermore.eio") ;

  抛出：
    `MacroRunException` - 文件名称不合法。

### saveAs

    public void saveAs(java.lang.String newName,
                       int dataFlag)

  把当前集成文件另存为别的文件。

  当前永中Office可以另存为的格式有.eio .doc .xls .ppt .uof .pdf .rtf .html .htm .eit .dot .xlt .txt .jpg .png .bmp .tiff .csv 另存为的格式以后缀名为区别，如要另存为pdf格式，Workbook.saveAs("C:/EIO_Binders/read.pdf", FileConstants.LINK)

  参数：
    `newName` - 另存的新文件名，带路径，如"C:/EIO_Binders/evermore.eio"。
    `dataFlag` - 存储方式。

                  FileConstants.DATA = 1 存储数据
                  FileConstants.LINK = 2 存储URL

    例子:

         //以存储URL的方式把当前集成文件另存为C:/EIO_Binders/evermore.eio。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         workbook.saveAs("C:/EIO_Binders/evermore.eio",FileConstants.LINK) ;

  抛出：
    `MacroRunException` - 文件名称不合法，或dataFlag参数越界。

### saveAsPDF

    public boolean saveAsPDF(java.lang.String fileName,
                             PDFAttribute pdfAttr)

  根据指定的pdf属性对当前的应用文档设置保存PDF文档。

  参数：
    `fileName` - 保存路径名
    `pdfAttr` - pdf文档属性。如果为null，则作为不设置属性处理。
  返回：
    若保存成功则返回 true, 否则返回 false 例子:

         //根据指定的pdf属性对当前的应用文档设置保存PDF文档
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook() ;
         PDFAttribute attr = new PDFAttribute();
         attr.setModifyEnable(true);
         attr.setCopyEnable(true);
         boolean success = workbook.saveAsPDF("d:/temp/bb.pdf", attr);
         System.out.println("success : " + success);

### saveAsStream

    public byte[] saveAsStream(int formatType)

  内存流保存。

  参数：
    `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文件格式)

  返回：
    数据类型为字节流，用来存放返回的文件内容 对于是否文档流保存成功，可以通过对byte的长度来判断。如果byte数组对象为null或长度为0则认为保存失败。

    例子：

         byte[] stream = Application.getWorkbooks().getActiveWorkbook().saveAsStream(FileConstants.TYPE_MS);
         System.out.println("stream : " +stream);
         boolean ret = Application.getWorkbooks().openFromStream(stream, FileConstants.TYPE_UOF);
         System.out.println("ret2 : " + ret);

  另请参见：
    `FileConstants`

### setAutoSave

    public void setAutoSave(boolean saveFlag)

  设置Workbook的即时存盘。

  打开或新建一个Workbook默认为即时存盘。

  参数：
    `saveFlag` - 布尔型，若为true，打开即时存盘，若为false，关闭即时存盘。

    例子:

         Application.getWorkbooks().getActiveWorkbook().setAutoSave(false) ;

### setModifiedFlag

    public void setModifiedFlag(boolean flag)

  设置当前文档修改标志。

  参数：
    `flag` - 修改标志

    例子:

         //设置当前集成文件未被修改。
         Application.getWorkbooks().getActiveWorkbook().setModifiedFlag(false);

### setTrackRevision

    public void setTrackRevision(boolean isTrack)

  修订整个集成文件。

  参数：
    `isTrack` - 是否修订整个集成文件的标志。

    例子：

         //设置开始修订集成文件。
         Workbook workbook = Application.getWorkbooks().getActiveWorkbook();
         workbook.setTrackRevision(true);

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

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

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