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

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

## application.workbooks.workbook.documents.document
类 Column

    java.lang.Object
      application.workbooks.workbook.documents.document.Column

    public class Column

extends java.lang.Object

此类封装了WP的分栏功能。

方法摘要
`int` | `getCount()` 获取当前章节的分栏的列数。
`float` | `getSpacing(int index)` 获取当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。
`float` | `getSpacingOfChar(int index)` 获取当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以字符为单位）。
`float` | `getWidth(int index)` 获取当前章节分栏的指定索引号的栏的宽度（以磅为单位）。
`float` | `getWidthOfChar(int index)` 得到当前章节分栏的指定索引号的栏的宽度（以字符为单位）。
`boolean` | `isEqualsWidth()` 判断章节是否设置分栏的栏宽都相等。
`boolean` | `isLineBetween()` 判断当前章节分栏的栏间是否有分隔线。
`boolean` | `isNewColumn()` 返回是否开始新栏。
`void` | `setCount(int count)` 设置当前章节的分栏的列数。
`void` | `setEqualsWidth(boolean equal)` 设置章节分栏栏位宽度是否都相等。
`void` | `setLineBetween(boolean separatort)` 设置当前章节分栏的栏间是否有分隔线。
`void` | `setNewColumn(boolean isNew)` 设置是否开始新栏。
`void` | `setSpacing(int index, float spacing)` 设置当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。
`void` | `setSpacingOfChar(int index, float spacing)` 设置当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以字符为单位）。
`void` | `setWidth(int index, float width)` 设置当前章节分栏的指定索引号的栏的宽度（以磅为单位）。
`void` | `setWidthOfChar(int index, float width)` 设置当前章节分栏的指定索引号的栏的宽度（以字符为单位）。

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

方法详细信息

### getCount

    public int getCount()

  获取当前章节的分栏的列数。

  返回：
    当前章节的分栏的列数

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         System.out.println("当前章节的分栏数为："+column.getCount());

### getSpacing

    public float getSpacing(int index)

  获取当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
  返回：
    当前分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位） 说明：get方法默认返回为磅值，当索引号超出范围，返回-1； 如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），可以用 application.util.Utilities.pointToOther(double, int)方法将返回的磅值转换为其他度量单位。

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         System.out.println("当前章节的分栏1、2之间的间距为："+column.getSpacing(0));

### getSpacingOfChar

    public float getSpacingOfChar(int index)

  获取当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以字符为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
  返回：
    当前分栏的指定索引号的栏与相邻右栏的栏间距离（以字符为单位,当索引号超出范围，返回-1；

    例子:

         //请输入一些文字，并设置分栏。
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         System.out.println("当前章节的分栏1、2之间的间距(以字符为单位)为："+column.getSpacingOfChar(0));

### getWidth

    public float getWidth(int index)

  获取当前章节分栏的指定索引号的栏的宽度（以磅为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
  返回：
    当前分栏的指定索引号分栏的宽度（以磅为单位） 说明：get方法默认返回为磅值，当索引号超出范围，返回-1； 如果要用其他的度量单位（英寸、厘米、毫米、十二点活字），可以用 application.util.Utilities.pointToOther(double, int)方法将返回的磅值转换为其他度量单位。

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         System.out.println("当前章节的分栏1的宽度为："+column.getWidth(0));

### getWidthOfChar

    public float getWidthOfChar(int index)

  得到当前章节分栏的指定索引号的栏的宽度（以字符为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
  返回：
    当前分栏的指定索引号分栏的宽度（以字符为单位)， 当索引号超出范围，返回-1；

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         System.out.println("当前章节的分栏1的宽度(以字符为单位)为："+column.getWidthOfChar(0));

### isEqualsWidth

    public boolean isEqualsWidth()

  判断章节是否设置分栏的栏宽都相等。

  返回：
    布尔型值，如果章节设置分栏栏宽都相等，返回true；否则，返回false

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         System.out.println("当前章节是否分栏宽度相等："+column.isEqualsWidth());

  另请参见：
    `setEqualsWidth(boolean)`

### isLineBetween

    public boolean isLineBetween()

  判断当前章节分栏的栏间是否有分隔线。

  返回：
    布尔型值，如果当前章节分栏各栏之间有分隔线，返回true；否则，返回false

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         section.setColumn(column);
         column = section.getColumn();
         System.out.println("当前章节是否有分栏间隔线："+column.isLineBetween());

  另请参见：
    `setLineBetween(boolean)`

### isNewColumn

    public boolean isNewColumn()

  返回是否开始新栏。

  返回：
    是否开始新栏

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         System.out.println("返回是否开始新栏："+column.isNewColumn());

### setCount

    public void setCount(int count)

  设置当前章节的分栏的列数。

  参数：
    `count` - 分栏列数

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         section.setColumn(column);

### setEqualsWidth

    public void setEqualsWidth(boolean equal)

  设置章节分栏栏位宽度是否都相等。

  参数：
    `equal` - 布尔型值，如为true，设置章节分栏栏位都宽度相等；否则，设置章节分栏栏位宽度不相等

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         column.setEqualsWidth(true);
         section.setColumn(column);

  另请参见：
    `isEqualsWidth()`, `setLineBetween(boolean)`

### setLineBetween

    public void setLineBetween(boolean separatort)

  设置当前章节分栏的栏间是否有分隔线。

  参数：
    `separatort` - 布尔型值，如为true，设置当前章节分栏各栏之间有分隔线；否则，当前章节分栏各栏之间无分隔线

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         column.setLineBetween(true);
         section.setColumn(column);

  另请参见：
    `isLineBetween()`, `setEqualsWidth(boolean)`

### setNewColumn

    public void setNewColumn(boolean isNew)

  设置是否开始新栏。

  参数：
    `isNew` - 是否开始新栏

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         column.setNewColumn(true);
         section.setColumn(column);

### setSpacing

    public void setSpacing(int index,
                           float spacing)

  设置当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
    `spacing` - 当前分栏的指定索引号分栏的间距（以磅为单位） 说明：set方法的参数默认取磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字）， 可以用 application.util.Utilities.otherToPoint(double, int)方法将其他度量单位转换为磅值后再调用相应的设置方法。

    例子:

         //请输入一些文字，并设置分栏。
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         column.setEqualsWidth(false);
         column.setSpacing(1,50.0f);
         section.setColumn(column);

  抛出：
    `MacroRunException` - 指定的分栏索引号小于0或大于当前章节的分栏列数。
    `MacroRunException` - 当前分栏为栏宽度相等，不能设置非首列的栏间距

### setSpacingOfChar

    public void setSpacingOfChar(int index,
                                 float spacing)

  设置当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以字符为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
    `spacing` - 当前分栏的指定索引号分栏的间距（以字符为单位）

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         column.setSpacingOfChar(0,2.0f);
         section.setColumn(column);

  抛出：
    `MacroRunException` - 指定的分栏索引号小于0或大于当前章节的分栏列数。
    `MacroRunException` - 当前分栏为栏宽度相等，不能设置非首列的栏间距

### setWidth

    public void setWidth(int index,
                         float width)

  设置当前章节分栏的指定索引号的栏的宽度（以磅为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
    `width` - 当前分栏的指定索引号分栏的宽度（以磅为单位） 说明：set方法的参数默认取磅值，如果要用其他的度量单位（英寸、厘米、毫米、十二点活字）， 可以用 application.util.Utilities.otherToPoint(double, int)方法将其他度量单位转换为磅值后再调用相应的设置方法。

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         column.setWidth(0,50.0f);
         section.setColumn(column);

  抛出：
    `MacroRunException` - 参数越界
    `MacroRunException` - 当前分栏为栏宽度相等时不能设置非首列的栏宽度

### setWidthOfChar

    public void setWidthOfChar(int index,
                               float width)

  设置当前章节分栏的指定索引号的栏的宽度（以字符为单位）。

  参数：
    `index` - 分栏索引号，表示第几栏
    `width` - 当前分栏的指定索引号分栏的宽度（以字符为单位）

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setCount(2);
         column.setWidthOfChar(0,10.0f);
         section.setColumn(column);

  抛出：
    `MacroRunException` - 当指定索引号超出范围
    `MacroRunException` - 当前分栏为栏宽度相等时不能设置非首列的栏宽度

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

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

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