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

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

## application.workbooks.workbook
类 Worksheets

    java.lang.Object
      application.workbooks.workbook.Worksheets

    public class Worksheets

extends java.lang.Object

该类定义了工作表管理器对象的一些方法，如获取工作表，添加工作表，移动工作表，隐藏工作表，删除工作表等方法。

方法摘要
`void` | `acceptAllRevision(boolean accepted)` 全部接受或全部拒绝修订。
`void` | `activate(java.lang.String worksheetName)` 激活某一工作表。
`Worksheet` | `addWorksheet()` 添加一个新的工作表,位置位于最后。
`Worksheet` | `addWorksheet(java.lang.String name)` 添加一个新的工作表。
`void` | `close()` 关闭。
`void` | `copyWorksheets(java.lang.String[] worksheetNames, java.lang.String workbookName, java.lang.String worksheetName)` 将集成文件中指定的工作表拷贝到一个指定的目标集成文件中。
`void` | `copyWorksheetsToNew(java.lang.String[] worksheetNames)` 将集成文件中指定的工作表拷贝到一个新的集成文件中。
`Worksheet` | `getActiveWorksheet()` 获得当前活动工作表。
`Worksheet[]` | `getAllWorksheets()` 获得集成文件中所有工作表。
`int` | `getCount()` 获得工作表的数目。
`Names` | `getNames()` 获得名称管理器。
`Workbook` | `getParent()` 获得集成文件对象。
`int` | `getSelectedCount()` 获得选中工作表个数。
`Worksheet[]` | `getSelectedWorksheets()` 获得所有选中的工作表。
`Worksheet` | `getWorksheet(int index)` 通过工作表的索引号取得相应的工作表(索引号从1开始)。
`Worksheet` | `getWorksheet(java.lang.String name)` 通过工作表名称取得相应的工作表。
`Worksheet` | `insertWorksheet(int index)` 在指定的工作表前插入新工作表(索引号从1开始)。
`Worksheet` | `insertWorksheet(int index, java.lang.String name)` 在指定的工作表前插入新工作表(索引号从1开始)。
`boolean` | `isScreenUpdating()` 返回是否要屏幕刷新。
`boolean` | `isStructureProtected()` 判断对工作薄有否设置结构的保护。
`boolean` | `isWindowsProtected()` 判断对工作薄有否设置窗口的保护。
`void` | `moveWorksheets(java.lang.String[] worksheetNames, java.lang.String worksheetName)` 将指定的工作表移动到本集成文件的其他工作表之前。
`void` | `moveWorksheets(java.lang.String[] worksheetNames, java.lang.String bookName, java.lang.String worksheetName)` 将集成文件中指定的工作表移动到一个指定的目标集成文件中。
`void` | `open()` 打开。
`boolean` | `protect(java.lang.String password, boolean structure, boolean windows)` 对工作薄设置结构和窗口的保护。
`void` | `removeWorksheet(java.lang.String sheetName)` 删除工作表。
`void` | `removeWorksheets(java.lang.String[] sheetsName)` 删除工作表。
`boolean` | `renameWorksheet(java.lang.String oldSheetName, java.lang.String newSheetName)` 工作表改名。
`void` | `selectWorksheet(java.lang.String worksheetName)` 选中某工作表。
`void` | `setScreenUpdating(boolean flag)` 设置是否要屏幕刷新。
`void` | `setTrackRevision(boolean isTrack)` 设置高亮显示修订选项。
`void` | `setTrackRevision(boolean isTrack, int timeIndex, int authorIndex, java.lang.String where, boolean list, boolean display)` 设置高亮显示修订选项。
`void` | `setWorksheetVisible(java.lang.String sheetName, boolean visible)` 工作表隐藏或解除隐藏。
`boolean` | `unprotect(java.lang.String password)` 取消工作簿保护。

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

方法详细信息

### acceptAllRevision

    public void acceptAllRevision(boolean accepted)

  全部接受或全部拒绝修订。

  参数：
    `accepted` - true表示全部接受，false表示全部拒绝

    例子：

          //全部接受修订
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.setTrackRevision(true,RevisionConstants.TIME_ALL,RevisionConstants.AUTHOR_NONE,"",false,true);
         Worksheet worksheet = worksheets.getActiveWorksheet();
         worksheet.setCellValue(2,3,"Apple");
         worksheets.acceptAllRevision(true);

### activate

    public void activate(java.lang.String worksheetName)

  激活某一工作表。

  参数：
    `worksheetName` - 要激活的工作表的名字

    例子：

          //在当前集成文件中激活名为"工作表2"的工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.activate("工作表2");

### addWorksheet

    public Worksheet addWorksheet()

  添加一个新的工作表,位置位于最后。

  返回：
    工作表

    例子：

          //在当前集成文件中添加一个新的工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet worksheet = worksheets.addWorksheet();

### addWorksheet

    public Worksheet addWorksheet(java.lang.String name)

  添加一个新的工作表。

  参数：
    `name` - 工作表名(,注意：名称长度范围在 1 至 31 之间)
  返回：
    工作表

    例子：

          //在当前集成文件中添加一个名为"aa"的新工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet worksheet = worksheets.addWorksheet("aa");

  抛出：
    `MacroRunException` - 当给定的工作表名已存在或无效

### close

    public void close()

  关闭。

### copyWorksheets

    public void copyWorksheets(java.lang.String[] worksheetNames,
                               java.lang.String workbookName,
                               java.lang.String worksheetName)

  将集成文件中指定的工作表拷贝到一个指定的目标集成文件中。

  参数：
    `worksheetNames` - 待拷贝的工作表名
    `workbookName` - 目标集成文件名
    `worksheetName` - 目标集成文件中的一个工作表名，被拷贝的工作表就放置在此工作表之前 (注:当workbookName为NULL时表示在同一个工作表，当worksheetName为NULL时表示新工作表放置在末尾, 而且目标集成文件必须已打开)

    例子：

          //在当前集成文件中将名为"工作表2"的工作表拷贝到集成文件"test"的名为"工作表1"的工作表之前
         Workbook workbook =  Application.getWorkbooks().getActiveWorkbook();
         Application.getWorkbooks().openWorkbook("d:/temp/test.eio");
         Worksheets worksheets = workbook.getWorksheets();
         worksheets.copyWorksheets(new String[]{"工作表2"},"test.eio","工作表1");

  抛出：
    `MacroRunException` - 当给定的工作表不存在
    `MacroRunException` - 当给定的集成文件没有打开

### copyWorksheetsToNew

    public void copyWorksheetsToNew(java.lang.String[] worksheetNames)

  将集成文件中指定的工作表拷贝到一个新的集成文件中。

  参数：
    `worksheetNames` - 工作表

    例子：

          //在当前集成文件中将名为"工作表2" 和 "工作表3" 的工作表拷贝到一个新建的集成文件中
         Worksheets worksheets = Application.getWorkbooks()
                                           .getActiveWorkbook()
                                           .getWorksheets();
         worksheets.copyWorksheetsToNew(new String[]{"工作表2","工作表3"});

  抛出：
    `MacroRunException` - 当给定的工作表不存在

### getActiveWorksheet

    public Worksheet getActiveWorksheet()

  获得当前活动工作表。如果当前没有活动工作表，则返回null。

  返回：
    工作表

    例子：

          //获得当前活动工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet worksheet = worksheets.getActiveWorksheet();

### getAllWorksheets

    public Worksheet[] getAllWorksheets()

  获得集成文件中所有工作表。

  返回：
    工作表实例的数组

    例子：

          //获得集成文件中所有工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet[] wss = worksheets.getAllWorksheets();

### getCount

    public int getCount()

  获得工作表的数目。

  返回：
    工作表的数目

    例子：

          //获得当前集成文件中工作表的数目
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         int size = worksheets.getCount();

### getNames

    public Names getNames()

  获得名称管理器。

  返回：
    名称管理器

    例子：

          //获得名称管理器
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Names names = worksheets.getNames();

### getParent

    public Workbook getParent()

  获得集成文件对象。

  返回：
    集成文件对象

    例子：

          //获得集成文件对象
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Workbook workbook = worksheets.getParent();

### getSelectedCount

    public int getSelectedCount()

  获得选中工作表个数。

  返回：
    所有选中工作表个数

    例子：

          //在当前工作簿选中"工作表1","工作表2","工作表3",打印选中工作表的个数。
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.selectWorksheets(new String[]{"工作表1","工作表2","工作表3"});
         System.out.print(worksheets.getSelectedCount());

### getSelectedWorksheets

    public Worksheet[] getSelectedWorksheets()

  获得所有选中的工作表。

  返回：
    所有选中的工作表

    例子：

          //在当前工作簿选中"工作表1","工作表2","工作表3",打印选中工作表的名称。
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.selectWorksheets(new String[]{"工作表1","工作表2","工作表3"});
         Worksheet[] selectedWorksheets = worksheets.getSelectedWorksheets();
         for (int i = 0;i < selectedWorksheets.length;i++)
         {
             System.out.println(selectedWorksheets[i].getName());
         }

### getWorksheet

    public Worksheet getWorksheet(int index)

  通过工作表的索引号取得相应的工作表(索引号从1开始)。

  参数：
    `index` - 索引号
  返回：
    工作表

    例子：

          //取得当前集成文件中索引号为2的工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet worksheet = worksheets.getWorksheet(2);

### getWorksheet

    public Worksheet getWorksheet(java.lang.String name)

  通过工作表名称取得相应的工作表。

  参数：
    `name` - 工作表名
  返回：
    工作表

    例子：

          //取得当前集成文件中的工作表3
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet worksheet = worksheets.getWorksheet("工作表3");

### insertWorksheet

    public Worksheet insertWorksheet(int index)

  在指定的工作表前插入新工作表(索引号从1开始)。

  参数：
    `index` - 工作表索引
  返回：
    工作表

    例子：

          //在当前集成文件的第二个工作表前插入新工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet worksheet = worksheets.insertWorksheet(2);

  抛出：
    `MacroRunException` - 当给定的工作表索引错误或越界

### insertWorksheet

    public Worksheet insertWorksheet(int index,
                                     java.lang.String name)

  在指定的工作表前插入新工作表(索引号从1开始)。

  参数：
    `index` - 工作表索引
    `name` - 工作表名称(,注意：名称长度范围在 1 至 31 之间)
  返回：
    工作表

    例子：

          //在当前集成文件的第二个工作表前插入名为"qq"的新工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         Worksheet worksheet = worksheets.insertWorksheet(2,"qq");

  抛出：
    `MacroRunException` - 当给定的工作表名已存在或无效
    `MacroRunException` - 当给定的工作表索引错误或越界

### isScreenUpdating

    public boolean isScreenUpdating()

  返回是否要屏幕刷新。

  返回：
    TRUE 表示开启屏幕刷新，FALSE 表示关闭屏幕刷新

    例子：

          //关闭工作表屏幕刷新
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.setScreenUpdating(false);
         boolean flag = worksheets.isScreenUpdating();

### isStructureProtected

    public boolean isStructureProtected()

  判断对工作薄有否设置结构的保护。

  返回：
    TRUE 表示有对工作簿结构保护，FALSE 表示没有对工作簿结构保护

    例子：

          //判断对工作薄设置结构的保护
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         System.out.println("structure : " + worksheets.isStructureProtected());

### isWindowsProtected

    public boolean isWindowsProtected()

  判断对工作薄有否设置窗口的保护。

  返回：
    TRUE 表示有对工作簿窗口保护，FALSE 表示没有对工作簿窗口保护

    例子：

          //判断对工作薄设置窗口的保护
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         System.out.println("windows :"+ worksheets.isWindowsProtected());

### moveWorksheets

    public void moveWorksheets(java.lang.String[] worksheetNames,
                               java.lang.String worksheetName)

  将指定的工作表移动到本集成文件的其他工作表之前。

  参数：
    `worksheetNames` - 指定的工作表
    `worksheetName` - 集成文件中的一个工作表名，被移动的工作表就放置在此工作表之前

    (注：若worksheetName为NULL,表示工作表移动到末尾)

    例子：

          //在当前集成文件中将名为"工作表2"的工作表移动到名为"工作表1"的工作表之前
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.moveWorksheets(new String[]{"工作表2"},"工作表1");

  抛出：
    `MacroRunException` - 当给定的工作表不存在

### moveWorksheets

    public void moveWorksheets(java.lang.String[] worksheetNames,
                               java.lang.String bookName,
                               java.lang.String worksheetName)

  将集成文件中指定的工作表移动到一个指定的目标集成文件中。

  参数：
    `worksheetNames` - 指定的工作表
    `bookName` - 目标集成文件的名称
    `worksheetName` - 目标集成文件中的一个工作表名，被移动的工作表就放置在此工作表之前 (注：若bookName为NULL时表示在本集成文件中移动,若worksheetName为NULL,表示工作表移动到末尾, 而且目标集成文件必须已打开)

    例子：

          //在当前集成文件中将名为"工作表2"的工作表移动到集成文件"my"的名为"工作表1"的工作表之前
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.moveWorksheets(new String[]{"工作表2"},"my","工作表1");

  抛出：
    `MacroRunException` - 当给定的工作表不存在
    `MacroRunException` - 当给定的集成文件没有打开

### open

    public void open()

  打开。

### protect

    public boolean protect(java.lang.String password,
                           boolean structure,
                           boolean windows)

  对工作薄设置结构和窗口的保护。

  参数：
    `structure` - 对工作薄结构是否保护
    `windows` - 对工作薄窗口是否保护
    `password` - 保护工作簿时设置的密码
  返回：
    TRUE 表示对工作簿保护成功，FALSE 表示对工作簿保护失败

    例子：

          //对工作薄设置结构和窗口的保护
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         boolean success = worksheets.protect("123",true, false);
         System.out.println("success :" + success);
         System.out.println("structure : " + worksheets.isStructureProtected());
         System.out.println("windows :"+ worksheets.isWindowsProtected());

### removeWorksheet

    public void removeWorksheet(java.lang.String sheetName)

  删除工作表。

  参数：
    `sheetName` - 工作表名称

    例子：

          //在当前集成文件中删除名为"工作表1"的工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.removeWorksheet("工作表1");

  抛出：
    `MacroRunException` - 当给定的工作表不存在

### removeWorksheets

    public void removeWorksheets(java.lang.String[] sheetsName)

  删除工作表。

  参数：
    `sheetsName` - 工作表名称

    例子：

          //在当前集成文件中删除名为"工作表1"的工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.removeWorksheets(new String[]{"工作表1"});

  抛出：
    `MacroRunException` - 当给定的工作表不存在
    `MacroRunException` - 集成文件中必须至少包含一个可见的工作表

### renameWorksheet

    public boolean renameWorksheet(java.lang.String oldSheetName,
                                   java.lang.String newSheetName)

  工作表改名。

  参数：
    `oldSheetName` - 原工作表名称
    `newSheetName` - 新工作表名称(,注意：名称长度范围在 1 至 31 之间)

    例子：

          //在当前集成文件中把名为"工作表2"的工作表改名为"工作表123"
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.renameWorksheet("工作表2","工作表123");

  抛出：
    `MacroRunException` - 当给定的原工作表不存在
    `MacroRunException` - 当给定的新工作表已存在
    `MacroRunException` - 当给定的工作表名无效

### selectWorksheet

    public void selectWorksheet(java.lang.String worksheetName)

  选中某工作表。

  参数：
    `worksheetName` - 工作表名

    例子：

          //在当前集成文件中选中工作表2
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.selectWorksheet("工作表2");

  抛出：
    `MacroRunException` - 当给定的工作表不存在

### setScreenUpdating

    public void setScreenUpdating(boolean flag)

  设置是否要屏幕刷新。 (注：缺省情况下是屏幕刷新的)

  参数：
    `flag` - TRUE 表示开启屏幕刷新，FALSE 表示关闭屏幕刷新

    例子：

          //关闭工作表屏幕刷新
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.setScreenUpdating(false);

### setTrackRevision

    public void setTrackRevision(boolean isTrack)

  设置高亮显示修订选项。

  参数：
    `isTrack` - true，跟踪修订信息；false，不跟踪

    例子：

          //设置修订选项
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.setTrackRevision(true);
         Worksheet worksheet = worksheets.getActiveWorksheet();
         worksheet.setCellValue(2,3,"Apple");

### setTrackRevision

    public void setTrackRevision(boolean isTrack,
                                 int timeIndex,
                                 int authorIndex,
                                 java.lang.String where,
                                 boolean list,
                                 boolean display)

  设置高亮显示修订选项。

  参数：
    `isTrack` - true，跟踪修订信息；false，不跟踪
    `timeIndex` - 时间选项索引,其取值取如下常量：

         TIME_NONE     － 不选
         TIME_UNTRACKED   － 修订未经审阅
         TIME_ALL － 全部

    `authorIndex` - 作者选项索引,其取值取有如下常量之一：

         AUTHOR_NONE － 不选

    `where` - 本表中跟踪修订的位置
    `list` - true，在新表中列举修订信息；false，不在新表中列举修订信息
    `display` - true，高亮显示修订信息；false，不高亮显示

    例子：

          //设置修订选项
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.setTrackRevision(true,RevisionConstants.TIME_ALL,RevisionConstants.AUTHOR_NONE,"",false,true);
         Worksheet worksheet = worksheets.getActiveWorksheet();
         worksheet.setCellValue(2,3,"Apple");

  抛出：
    `MacroRunException` - 当给定参数的数值错误或越界

### setWorksheetVisible

    public void setWorksheetVisible(java.lang.String sheetName,
                                    boolean visible)

  工作表隐藏或解除隐藏。

  参数：
    `sheetName` - 工作表名
    `visible` - TRUE表示解除隐藏，FALSE表示隐藏

    例子：

          //在当前集成文件中隐藏名为"工作表1"的工作表
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         worksheets.setWorksheetVisible("工作表1",false);

  抛出：
    `MacroRunException` - 当给定的工作表不存在

### unprotect

    public boolean unprotect(java.lang.String password)

  取消工作簿保护。

  参数：
    `password` - 密码 1.如提供的密码不正确，返回false。 2.如工作簿没有用密码保护，则参数password输入null。
  返回：
    返回值为true表示解除保护成功,false表示解除保护不成功

    例子：

          //取消对工作薄设置结构和窗口的保护
         Worksheets worksheets = Application.getWorkbooks()
                                  .getActiveWorkbook().getWorksheets();
         boolean success = worksheets.unprotect("123");
         System.out.println("success :" + success);
         System.out.println("structure : " + worksheets.isStructureProtected());

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

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

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