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

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

## application.workbooks.workbook
类 Tables

    java.lang.Object
      application.workbooks.workbook.Tables

    public class Tables

extends java.lang.Object

封装了某个区域所有自由表格的一个集合，是一个表格管理器，提供了插入，删除表格，得到表格等功能。

方法摘要
`Table` | `getActiveTable()` 得到当前表格。
`Table[]` | `getAllTables()` 获取一篇文档中的所有表格,(表格已经根据endOffset进行排序)
`Table` | `getTable(AbstractText abstractText, long offset)` 得到当前区域内offset指定的表格。
`Table` | `getTable(java.lang.String tableName)` 得到当前区域内指定名字的表格。
`java.lang.String[]` | `getTableNames()` 返回当前区域有名字表格的名字集合。
`void` | `hideTables()` 设置自由表格隐藏边框。
`Table` | `insertTable(AbstractText abstractText, long offset, int row, int column)` 在指定区域位置插入一张指定行列的自由表格。
`Table` | `insertTable(long offset, int rows, int cols)` 在指定区域位置插入一张指定行列的自由表格。
`void` | `removeAllTables()` 在当前区域内删除所有表格。
`void` | `removeTable(AbstractText abstractText, long offset)` 根据表格范围的起始位置删除表格。
`void` | `removeTable(java.lang.String tableName)` 在当前区域内删除指定名字的表格。
`void` | `setDeletable(boolean deletable)` 设置文档中所有的表格是否可以删除.
`void` | `tableToText(AbstractText abstractText, long offset, boolean isNesting)` 将指定表格转换为是否包含嵌套表格文本。
`void` | `tableToText(AbstractText abstractText, long offset, char text)` 将指定表格转换为文本。
`Table` | `textToTable(AbstractText abstractText, long start, long length, char text, int colCount)` 将指定的一段文本转换为一个表格。

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

方法详细信息

### getActiveTable

    public Table getActiveTable()

  得到当前表格。

  返回：
    Table 所得到的当前表格

    例子:

          //请先插入自由表格,且光标必须在自由表格内,否则返回空.
         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Tables tables = document.getTables();
         Table table = tables.getActiveTable();
         System.out.println("table:"+table.getName());

### getAllTables

    public Table[] getAllTables()

  获取一篇文档中的所有表格,(表格已经根据endOffset进行排序)

  返回：
    Table 所得到的表格数组

    例子：

         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = document.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!");
         Tables tables = document.getTables();
         Table[] table = tables.getAllTables();
         System.out.println("size:"+table.length);

### getTable

    public Table getTable(AbstractText abstractText,
                          long offset)

  得到当前区域内offset指定的表格。

  参数：
    `offset` - 此位置值指定要得到的表格
  返回：
    Table 所得到的指定表格

    例子：

         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = document.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = document.getTables();
         tables.insertTable(baseText,0,5,5);
         Table table = tables.getTable(baseText,0);
         System.out.println("table:"+table.getName());

### getTable

    public Table getTable(java.lang.String tableName)

  得到当前区域内指定名字的表格。

  参数：
    `tableName` - 表格名字
  返回：
    Table 所得到的指定表格，如果没有就返回null

    例子：

         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = document.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!");
         Tables tables = document.getTables();
         tables.insertTable(baseText,0,5,5,-30.0f,"table1");
         Table table = tables.getTable("table1");
         System.out.println("table:"+table.getName());

### getTableNames

    public java.lang.String[] getTableNames()

  返回当前区域有名字表格的名字集合。

  返回：
    Srting[] 如果没有有名字的表格，就返回null

    例子:

         //请先插入几个表格.
         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Tables tables = document.getTables();
         String[] count = tables.getTableNames();
         for(int i = 0 ; i < count.length ; i++)
         {
             System.out.println("当前区域内表格的名字："+ count[i].toString());
         }

### hideTables

    public void hideTables()

  设置自由表格隐藏边框。把文档中所有的表格边框隐藏。

  例子:

       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       Tables tables = baseText.getTables();
       tables.hideTables();

### insertTable

    public Table insertTable(AbstractText abstractText,
                             long offset,
                             int row,
                             int column)

  在指定区域位置插入一张指定行列的自由表格。

  参数：
    `abstractText` - AbstractText对象,比如正文对象BaseText,页眉,页脚,脚注,尾注
    `offset` - 插入表格的指定位置
    `row` - 插入表格的行数
    `column` - 插入表格的列数

    例子:

         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = document.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = document.getTables();
         tables.insertTable(baseText,0,5,5);

  抛出：
    `application.exceptions.MacroRunException` - 当行数小于0或行数大于32767
    `application.exceptions.MacroRunException` - 当列数小于0或列数大于63

### insertTable

    public Table insertTable(long offset,
                             int rows,
                             int cols)

  在指定区域位置插入一张指定行列的自由表格。

  参数：
    `offset` - 插入表格的指定位置
    `rows` - 插入表格的行数
    `cols` - 插入表格的列数

    例子:

         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();s
         Tables tables = document.getTables();
         tables.insertTable(0,5,5);

  抛出：
    `application.exceptions.MacroRunException` - 当行数小于0或行数大于32767
    `application.exceptions.MacroRunException` - 当列数小于0或列数大于63

### removeAllTables

    public void removeAllTables()

  在当前区域内删除所有表格。

  例子:

       //请先插入几个表格.
       Document document = Application.getWorkbooks().getActiveWorkbook().
       getDocuments().getActiveDocument();
       Tables tables = document.getTables();
       tables.removeAllTables();

### removeTable

    public void removeTable(AbstractText abstractText,
                            long offset)

  根据表格范围的起始位置删除表格。

  参数：
    `offset` - 要删除表格范围的起始位置

    例子:

         //请在正文区域起始0位置插入表格.
         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = document.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = document.getTables();
         tables.removeTable(baseText,0);

### removeTable

    public void removeTable(java.lang.String tableName)

  在当前区域内删除指定名字的表格。

  参数：
    `tableName` - 要删除表格的名字

    例子:

         //请先插入几个表格.
         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Tables tables = document.getTables();
         tables.removeTable("表格1");

### setDeletable

    public void setDeletable(boolean deletable)

  设置文档中所有的表格是否可以删除.

  参数：
    `deletable` - 表格是否可以删除

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.setDeletable(false);

### tableToText

    public void tableToText(AbstractText abstractText,
                            long offset,
                            boolean isNesting)

  将指定表格转换为是否包含嵌套表格文本。

  参数：
    `abstractText` - AbstractText对象,比如默认尾注对象
    `offset` - 表格范围的起始位置
    `isNesting` - 是否包含嵌套表格

    例子:

         //请先在脚注插入表格.并且在表格中输入一些文字.
         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = document.getSection(0);
         Tables tables = document.getTables();
         tables.tableToText(section.getFootNote(0),3,true);

### tableToText

    public void tableToText(AbstractText abstractText,
                            long offset,
                            char text)

  将指定表格转换为文本。

  参数：
    `abstractText` - AbstractText对象,比如默认尾注对象
    `offset` - 表格范围的起始位置
    `text` - 文字分隔符 默认有三种 段落标记 '\n' 制表位 '\t' (默认) 逗号 ',' 其他字符 '*'....

    例子:

         //请先在脚注插入表格.并且在表格中输入一些文字.
         Document document = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = document.getSection(0);
         Tables tables = document.getTables();
         tables.tableToText(section.getFootNote(0),3,'*');

### textToTable

    public Table textToTable(AbstractText abstractText,
                             long start,
                             long length,
                             char text,
                             int colCount)

  将指定的一段文本转换为一个表格。

  参数：
    `abstractText` - AbstractText对象,比如默认正文对象
    `start` - 转换文本的起始位置
    `length` - 转换文本的长度
    `text` - 文字分隔符位置 段落标记 '\n' (默认) 制表位 '\t' 逗号 ',' 空格 ' ' 其他字符 '*'....
    `colCount` - 列数

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().
         getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         String text = "this is a test!";
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,text);
         Tables tables = doc.getTables();
         int len = text.length();
         tables.textToTable(baseText,0, len , '*', 5);

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

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