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

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

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

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

    public class Fields

extends java.lang.Object

此类为域的管理器，用于提供插入、删除、获取等操作。

方法摘要
`void` | `delete(Field field)` 删除指定的域
`void` | `delete(long offset, AbstractText absText)` 删除指定的域
`Field` | `get(long offset, AbstractText absText)` 返回指定位置的域，如在页眉页脚、脚注尾注。
`Field[]` | `getAllFields(AbstractText absText)` 返回指定区域内所有的域。
`Field` | `insert(long offset, AbstractText absText, int fieldID, java.lang.String codeStr)` 在指定的位置插入域，如在正文、页眉页脚、脚注尾注。
`void` | `update(AbstractText absText)` 更新指定区域中所有的域。

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

方法详细信息

### delete

    public void delete(Field field)

  删除指定的域

  参数：
    `field` - 需删除的域

    例子：

         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_EDIT_TIME,"EDITTIME  \\# \"0\" \\* Arabic" );
         System.out.println(field.getResult());
         fields.delete(field);

  抛出：
    `MacroRunException` - 指定位置处于不可编辑状态
  另请参见：
    `Field`, `delete(long, AbstractText)`

### delete

    public void delete(long offset,
                       AbstractText absText)

  删除指定的域

  参数：
    `offset` - 偏移
    `absText` - 域所在位置，可以是正文、页眉页脚、脚注尾注

    例子：

         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_EDIT_TIME,"EDITTIME  \\# \"0\" \\* Arabic" );
         System.out.println(field.getResult());
         fields.delete(0,baseText);

  抛出：
    `MacroRunException` - 指定位置处于不可编辑状态
  另请参见：
    `delete(Field)`

### get

    public Field get(long offset,
                     AbstractText absText)

  返回指定位置的域，如在页眉页脚、脚注尾注。如果指定位置不存在域，则返回null。

  参数：
    `offset` - 偏移
    `absText` - 域所在位置，可以是正文、页眉页脚、脚注尾注
  返回：

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         BaseText baseText = doc.getSection(0).getBaseText();
         Fields fields = doc.getFields();
         fields.insert(0,baseText,FieldConstants.FIELDTYPE_EDIT_TIME,"EDITTIME  \\# \"0\" \\* Arabic" );
         Field field = fields.get(0,baseText);
         System.out.println(field.getResult());

### getAllFields

    public Field[] getAllFields(AbstractText absText)

  返回指定区域内所有的域。

  参数：
    `absText` - 域所在位置，可以是正文、页眉页脚、脚注尾注
  返回：
    所有的域

    例子：

         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_EDIT_TIME,"EDITTIME  \\# \"0\" \\* Arabic" );
         Field[] allFields = fields.getAllFields(baseText);
         for (int i =0 ; i < allFields.length;i++)
         {
           System.out.println(allFields[i].getResult());
         }

  另请参见：
    `Field`

### insert

    public Field insert(long offset,
                        AbstractText absText,
                        int fieldID,
                        java.lang.String codeStr)

  在指定的位置插入域，如在正文、页眉页脚、脚注尾注。

  参数：
    `offset` - 偏移
    `absText` - 域所在位置，可以是正文、页眉页脚、脚注尾注
    `fieldID` - 域编号 , 参照 FieldConstants
    `codeStr` - 域代码
  返回：
    插入的域。如果指定的位置无法插入域，则返回null。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments()
                .getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Header header     = section.getHeader();
         Fields fields = doc.getFields();
         Field field = fields.insert(0,baseText,FieldConstants.FIELDTYPE_EDIT_TIME,"EDITTIME  \\# \"0\" \\* Arabic" );
         System.out.println(field.getResult());
         Field field2 = fields.insert(0,header,FieldConstants.FIELDTYPE_EDIT_TIME,"EDITTIME  \\# \"0\" \\* Arabic" );
         System.out.println(field2.getResult());

  抛出：
    `MacroRunException` - 指定的域编号与域代码不一致
    `MacroRunException` - 指定位置处于不可编辑状态
  另请参见：
    `FieldConstants`

### update

    public void update(AbstractText absText)

  更新指定区域中所有的域。

  参数：
    `absText` - 域所在位置，可以是正文、页眉页脚、脚注尾注

    例子：

         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("insert time is "+field.getResult());
         javax.swing.Timer timer = new javax.swing.Timer(2000,new java.awt.event.ActionListener()
         {
             void actionPerformed(java.awt.event.ActionEvent e)
             {
                 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
                 BaseText baseText = doc.getSection(0).getBaseText();
                 Fields fields = doc.getFields();
                 fields.update(baseText);
                 System.out.println("update time is "+field.getResult());
             }
         });

         timer.setRepeats(true);
         timer.start();

  另请参见：
    `Field`

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

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

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