odsorecipientdata-ag凯发旗舰厅

com.spire.doc
class odsorecipientdata

java.lang.object
  com.spire.doc.odsorecipientdata

public class odsorecipientdata
extends java.lang.object

represents information about a single record within an external data source that is to be excluded from the mail merge. if a record shall be merged into a merged document, then no information is needed about that record. however, if a given record shall not be merged into a merged document, then the value of the unique key for that record shall be stored in the uniquetag property of this object to indicate this exclusion.

odsorecipientdata

public odsorecipientdata()

initializes a new instance of this class.

deepclone

public odsorecipientdata deepclone()

returns a deep clone of this object.

returns:

a deep clone of this object.

getactive

public boolean getactive()

specifies whether the record from the data source shall be imported into a document when the mail merge is performed.

returns:

the default value is true.

setactive

public void setactive(boolean value)

specifies whether the record from the data source shall be imported into a document when the mail merge is performed.

parameters:

value - the default value is true.

getcolumn

public int getcolumn()

specifies the column within the data source that contains unique data for the current record.

returns:

the default value is 0.

setcolumn

public void setcolumn(int value)

specifies the column within the data source that contains unique data for the current record.

parameters:

value - the default value is 0.

getuniquetag

public byte[] getuniquetag()

specifies the contents of a given record in the column containing unique data.

returns:

the default value is null.

setuniquetag

public void setuniquetag(byte[] value)

specifies the contents of a given record in the column containing unique data.

parameters:

value - the default value is null.

gethash

public int gethash()

represents the hash code for this record. sometimes microsoft word uses hash of a whole record instead of a uniquetag value. the default value is 0.

returns:

the hash value

sethash

public void sethash(int value)

sets the hash code for this record.

parameters:

value - the hash value