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

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

## application.workbooks.workbook.documents.document.fields
类 Field

    java.lang.Object
      application.workbooks.workbook.documents.document.fields.Field

    public class Field

extends java.lang.Object

此类提供获取域代码、域结果、锁定域、更新域等操作。

方法摘要
`java.lang.String` | `getCode()` 返回域代码。
`long` | `getEndOffset()` 返回域的结束位置。
`int` | `getFieldID()` 返回域编号。
`java.lang.String` | `getResult()` 返回域结果。
`long` | `getStartOffset()` 返回域的起始位置。
`boolean` | `isLocked()` 返回域中代码是否被锁定。
`Field` | `next()` 返回下一个域。
`Field` | `previous()` 返回前一个域。
`void` | `select()` 选中域。
`void` | `setLocked(boolean locked)` 锁定域。
`void` | `setResult(java.lang.String result)` 设置域结果。
`void` | `update()` 更新域中的数据。

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

方法详细信息

### getCode

    public java.lang.String getCode()

  返回域代码。

  返回：
    域代码

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.getCode());

### getEndOffset

    public long getEndOffset()

  返回域的结束位置。

  返回：
    结束位置

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.getEndOffset());

### getFieldID

    public int getFieldID()

  返回域编号。

  返回：
    域编号

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.getFieldID());

  另请参见：
    `FieldConstants`

### getResult

    public java.lang.String getResult()

  返回域结果。

  返回：
    域结果

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.getResult());

### getStartOffset

    public long getStartOffset()

  返回域的起始位置。

  返回：
    起始位置

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.getStartOffset());

### isLocked

    public boolean isLocked()

  返回域中代码是否被锁定。

  返回：
    域是否被锁定

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         field.setLocked(true);
         System.out.println(field.isLocked());

### next

    public Field next()

  返回下一个域。如果没有，则返回null。

  返回：
    下一个域

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.next());

### previous

    public Field previous()

  返回前一个域。如果没有，则返回null。

  返回：
    前一个域

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.previous());

### select

    public void select()

  选中域。

  例子：

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
              .getActiveDocument();
       BaseText baseText = doc.getSection(0).getBaseText();
       Fields fields = doc.getFields();
       Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
       field.select();

  抛出：
    `MacroRunException` - 当前文档被保护才会抛出异常

### setLocked

    public void setLocked(boolean locked)

  锁定域。锁定后，无法使用update方法更新域结果。

  参数：
    `locked` - 锁定域状态.为true时,表示锁定

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         field.setLocked(true);
         System.out.println(field.isLocked());

  抛出：
    `MacroRunException` - 当前文档被保护才会抛出异常

### setResult

    public void setResult(java.lang.String result)

  设置域结果。

  参数：
    `result` - 域结果

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
         System.out.println(field.getResult());
         field.setResult("result changed!");
         System.out.println(field.getResult());

  抛出：
    `MacroRunException` - 当参数result为null时

### update

    public void update()

  更新域中的数据。

  例子：

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
              .getActiveDocument();
       BaseText baseText = doc.getSection(0).getBaseText();
       Fields fields = doc.getFields();
       Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_DATE,"DATE \\@ \"M/d/yyyy h:mm:ss AM/PM\"  \\* MERGEFORMAT ");
       System.out.println(field.getResult());
       field.update();
       System.out.println(field.getResult());

  抛出：
    `MacroRunException` - 当前域处于保护状态

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

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

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