Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook.documents.document
Class MailMerge

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

public class MailMerge
extends java.lang.Object

此类管理邮件合并，可以插入邮件合并，显示邮件合并信息等。

Method Summary
`void` | `firstRecord()` 显示合并数据的第一条记录。
`void` | `insertMailMergeField(int index)` 在当前光标位置插入邮件合并。
`void` | `insertMailMergeField(long offset, int index)` 在光标指定位置处插入邮件合并索引号指定的邮件合并信息。
`void` | `lastRecord()` 显示合并数据的最后一条记录。
`void` | `mergeMail()` 合并邮件到当前文档。
`void` | `mergeToPrinter()` 合并邮件到打印机。
`void` | `nextRecord()` 显示合并数据的下一条记录(以插入邮件合并索引号所在记录为当前记录)。
`void` | `previousRecord()` 显示合并数据的前一条记录(以插入邮件合并索引号所在记录为当前记录)。
`void` | `setMergeMailData(int prmStartSheetID, int prmEndSheetID, int prmStartColumn, int prmEndColumn, int prmStartRow, int prmEndRow, java.lang.String prmBookName, int prmApplyType)` 用于设置邮件合并的信息（这些信息在电子表格中）。
`void` | `setMergeSettings(boolean isRepalceSpace, java.lang.String repalceString, boolean reserveBackGround, boolean reserveMargine, boolean checkValidity)` 邮件合并的合并设置。
`void` | `showToRecord(boolean show)` 使邮件合并数据显示的是字段名下的实际数据，而不是字段名。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### firstRecord

    public void firstRecord()

  显示合并数据的第一条记录。 注：只有调用了showToRecord(true)方法后，此方法才能使用。

  例子:

       //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       MailMerge mailMerge = baseText.getMailMerge();
       mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
       mailMerge.insertMailMergeField(1);
       mailMerge.showToRecord(true);
       mailMerge.firstRecord();

  See Also:
    `previousRecord()`, `nextRecord()`, `lastRecord()`, `showToRecord(boolean)`, `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `BaseText`

### insertMailMergeField

    public void insertMailMergeField(int index)

  在当前光标位置插入邮件合并。 注：该方法调用前,必须设置邮件合并信息，即初始化MailMager的数据

  Parameters:
    `index` - 邮件合并的索引号

    例子:

         //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         MailMerge mailMerge = baseText.getMailMerge();
         mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
         mailMerge.insertMailMergeField(1);
         mailMerge.showToRecord(true);

  See Also:
    `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `showToRecord(boolean)`, `BaseText`

### insertMailMergeField

    public void insertMailMergeField(long offset,
                                     int index)

  在光标指定位置处插入邮件合并索引号指定的邮件合并信息。 注：该方法调用前,必须设置邮件合并信息，即初始化MailMager的数据

  Parameters:
    `offset` - 插入邮件合并的光标指定位置
    `index` - 邮件合并的索引号

    例子:

         //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         MailMerge mailMerge = baseText.getMailMerge();
         mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
         mailMerge.insertMailMergeField(3,2);
         mailMerge.showToRecord(true);

  See Also:
    `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(int)`, `showToRecord(boolean)`, `BaseText`

### lastRecord

    public void lastRecord()

  显示合并数据的最后一条记录。 注：只有调用了showToRecord(true)方法后，此方法才能使用。

  例子:

       //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       MailMerge mailMerge = baseText.getMailMerge();
       mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
       mailMerge.insertMailMergeField(1);
       mailMerge.showToRecord(true);
       mailMerge.lastRecord();

  See Also:
    `previousRecord()`, `nextRecord()`, `firstRecord()`, `showToRecord(boolean)`, `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `BaseText`

### mergeMail

    public void mergeMail()

  合并邮件到当前文档。 注：一页存放一条记录

  例子:

       //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       MailMerge mailMerge = baseText.getMailMerge();
       mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
       mailMerge.insertMailMergeField(1);
       mailMerge.showToRecord(true);
       mailMerge.setMergeSettings(true,"",true,true,true);
       mailMerge.mergeMail();

  See Also:
    `mergeToPrinter()`, `setMergeSettings(boolean,String,boolean,boolean,boolean)`, `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `BaseText`

### mergeToPrinter

    public void mergeToPrinter()

  合并邮件到打印机。

  例子:

       //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       MailMerge mailMerge = baseText.getMailMerge();
       mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
       mailMerge.insertMailMergeField(1);
       mailMerge.showToRecord(true);
       mailMerge.setMergeSettings(true,"",true,true,true);
       mailMerge.mergeToPrinter();

  See Also:
    `mergeMail()`, `setMergeSettings(boolean,String,boolean,boolean,boolean)`, `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `BaseText`

### nextRecord

    public void nextRecord()

  显示合并数据的下一条记录(以插入邮件合并索引号所在记录为当前记录)。 注：只有调用了showToRecord(true)方法后，此方法才能使用。

  例子:

       //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       MailMerge mailMerge = baseText.getMailMerge();
       mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
       mailMerge.insertMailMergeField(1);
       mailMerge.showToRecord(true);
       mailMerge.nextRecord();

  See Also:
    `firstRecord()`, `previousRecord()`, `lastRecord()`, `showToRecord(boolean)`, `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `BaseText`

### previousRecord

    public void previousRecord()

  显示合并数据的前一条记录(以插入邮件合并索引号所在记录为当前记录)。 注：只有调用了showToRecord(true)方法后，此方法才能使用。

  例子:

       //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       MailMerge mailMerge = baseText.getMailMerge();
       mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
       mailMerge.insertMailMergeField(2);
       mailMerge.showToRecord(true);
       mailMerge.previousRecord();

  See Also:
    `firstRecord()`, `nextRecord()`, `lastRecord()`, `showToRecord(boolean)`, `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `BaseText`

### setMergeMailData

    public void setMergeMailData(int prmStartSheetID,
                                 int prmEndSheetID,
                                 int prmStartColumn,
                                 int prmEndColumn,
                                 int prmStartRow,
                                 int prmEndRow,
                                 java.lang.String prmBookName,
                                 int prmApplyType)

  用于设置邮件合并的信息（这些信息在电子表格中）。 注：该方法的调用发生在邮件合并之前,初始化MailMager的数据。

  Parameters:
    `prmStartSheetID` - 设定选中区域由哪一个工作表开始
    `prmEndSheetID` - 设定选中区域由哪一个工作表结束
    `prmStartColumn` - 设定选中区域由哪一列开始
    `prmEndColumn` - 设定选中区域由哪一列结束
    `prmStartRow` - 设定选中区域由哪一行开始
    `prmEndRow` - 设定选中区域由哪一行结束.
    `prmBookName` - 为选中区域的工作簿名称
    `prmApplyType` - 表明应用类型是邮件合并还是信封或是标签，只能取以下值之一:

               0    表明应用类型是邮件合并
               1    表明应用类型是信封
               2    表明应用类型是标签

    例子:

         //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         MailMerge mailMerge = baseText.getMailMerge();
         mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
         mailMerge.insertMailMergeField(3,2);

  See Also:
    `insertMailMergeField(long,int)`, `insertMailMergeField(int)`, `showToRecord(boolean)`, `BaseText`

### setMergeSettings

    public void setMergeSettings(boolean isRepalceSpace,
                                 java.lang.String repalceString,
                                 boolean reserveBackGround,
                                 boolean reserveMargine,
                                 boolean checkValidity)

  邮件合并的合并设置。 注：该方法只有调用了 mergeMail()或者 mergeToPrinter()设置才有效。

  Parameters:
    `isRepalceSpace` - 布尔型值，合并非法数据时是否用空格表示。如果为true，合并时非法数据用空格表示；否则，合并时非法数据不一定用空格表示
    `repalceString` - 表示合并时非法数据用给定字符串代替 注：只有当 isRepalceSpace 为false 时,此字符串才有意义
    `reserveBackGround` - 布尔型值，合并后是否保留文档。如果为true，合并后保留文档的背景；否则，合并后不保留文档的背景
    `reserveMargine` - 布尔型值，合并后是否保留文档的页面设置。如果为true，合并后保留文档的页面设置；否则，合并后不保留文档的页面设置
    `checkValidity` - 布尔型值，合并前是否再次检查数据源的有效性。如果为true，合并前再次检查数据源的有效性；否则，合并前不检查数据源的有效性

    例子:

         //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         MailMerge mailMerge = baseText.getMailMerge();
         mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
         mailMerge.insertMailMergeField(1);
         mailMerge.showToRecord(true);
         mailMerge.setMergeSettings(true,"",true,true,true);
         mailMerge.mergeMail();

  See Also:
    `mergeMail()`, `mergeToPrinter()`, `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `BaseText`

### showToRecord

    public void showToRecord(boolean show)

  使邮件合并数据显示的是字段名下的实际数据，而不是字段名。

  Parameters:
    `show` - 布尔型值，是否显示字段名。如果为true，表示显示的是字段名下的实际数据，而不是字段名；否则，表示显示的是字段名而不是实际数据

    例子:

         //请在电子表格中sheet1下第一行第一列起始位置输入三行三列的字符或数据,首行为字段名.
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         MailMerge mailMerge = baseText.getMailMerge();
         mailMerge.setMergeMailData(1,1,0,2,0,2,"",0);
         mailMerge.insertMailMergeField(1);
         mailMerge.showToRecord(true);

  See Also:
    `setMergeMailData(int,int,int,int,int,int,String,int)`, `insertMailMergeField(long,int)`, `insertMailMergeField(int)`, `BaseText`

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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