mailmerge-ag凯发旗舰厅

com.spire.doc.reporting
class mailmerge

java.lang.object
  com.spire.doc.reporting.mailmerge

public class mailmerge
extends java.lang.object

mergefield

public mergefieldeventhandler mergefield

occurs during mail merge when a text merge field processing.

mergeimagefield

public mergeimagefieldeventhandler mergeimagefield

occurs during mail merge when an image merge field processing.

mergegroup

public mergegroupeventhandler mergegroup

occurs during mail merge when group/table processing.

getclearfields

public boolean getclearfields()

gets a value indicating whether [clear fields]. by default value is true.

returns:

boolean.

setclearfields

public void setclearfields(boolean value)

sets a value indicating whether [clear fields]. by default value is true.

parameters:

value - if it clears the fields, set to true.

getmailmergemaindocumenttype

public mailmergemaindocumenttype getmailmergemaindocumenttype()

setmailmergemaindocumenttype

public void setmailmergemaindocumenttype(mailmergemaindocumenttype value)

getcleargrouptag

public boolean getcleargrouptag()

gets a value indicating whether [clear group tag]. by default value is false.

returns:

boolean.

setcleargrouptag

public void setcleargrouptag(boolean value)

sets a value indicating whether [clear group tag]. by default value is false.

parameters:

value - if it clears group tag, set to true.

getdocument

protected document getdocument()

gets the document.

returns:

the document.

gethideemptyparagraphs

public boolean gethideemptyparagraphs()

gets a value indicating whether to remove paragraphs which contain empty merge fields.

returns:

boolean.

sethideemptyparagraphs

public void sethideemptyparagraphs(boolean value)

sets a value indicating whether to remove paragraphs which contain empty merge fields.

parameters:

value - the value.

gethideemptygroup

public boolean gethideemptygroup()

gets a value indicating whether to remove groups which contain empty merge fields.

returns:

boolean

sethideemptygroup

public void sethideemptygroup(boolean value)

sets a value indicating whether to remove groups which contain empty merge fields.

parameters:

value - the value.

execute

public void execute(java.lang.string[] fieldnames,
                    java.lang.string[] fieldvalues)

performs mail merge operation.

parameters:

fieldnames - the field names.

fieldvalues - the field values.

throws:

java.lang.exception - exception

execute

public void execute(java.lang.iterable datasource)

performs mail merge operation.

parameters:

datasource - the data source.

throws:

java.lang.exception

executewidthregion

public void executewidthregion(java.lang.string xmlfile)

performs mail merge within a region from a datatable.

parameters:

xmlfile - the xml file.

throws:

java.lang.exception

executewidthnestedregion

public void executewidthnestedregion(mailmergedataset datasource,
                                     java.util.list filters)

performs mail merge operation.

parameters:

datasource - the data source.

filters - the filters.

throws:

java.lang.exception

executewidthnestedregion

public void executewidthnestedregion(java.lang.string xmlfile,
                                     java.util.list commands)

executes the nested region.

parameters:

xmlfile - the xml file.

commands - the commands.

getmergefieldnames

public java.lang.string[] getmergefieldnames()

returns a collection of mergefield names found in the document.

returns:

the merge field names.

getmergefieldnames

public java.lang.string[] getmergefieldnames(java.lang.string groupname)

gets the merge field names.

parameters:

groupname - the group name.

returns:

the merge field names.

getmergegroupnames

public java.lang.string[] getmergegroupnames()

gets the merge group names.

returns:

the the merge group names.

executegroup

public void executegroup(mailmergedatatable datasource)

performs mail merge operation.

parameters:

datasource - the mailmergedatatable.

throws:

java.lang.exception