com.spire.doc.reporting
Class MergeFieldEventArgs

java.lang.Object
  com.spire.ms.System.EventArgs
      com.spire.doc.reporting.MergeFieldEventArgs

Direct Known Subclasses:

MergeImageFieldEventArgs

public class MergeFieldEventArgs
extends com.spire.ms.System.EventArgs

Represents data during MergeField event.

Constructor Summary

MergeFieldEventArgs(IDocument doc, java.lang.String tableName, int rowIndex, IMergeField field, java.lang.Object value)
Provides data during the MergeField event.

Method Summary

CharacterFormat	getCharacterFormat() Gets the Character Format of the field.
IMergeField	getCurrentMergeField() Gets the current Merge field.
IDocument	getDocument() Gets the document.
java.lang.String	getFieldName() Gets the Merge field Name.
java.lang.Object	getFieldValue() Gets the Merge Field Value
int	getRowIndex() Gets the Row Index.
java.lang.String	getTableName() Gets the Table Name
java.lang.String	getText() Gets the Text value
boolean	isKeepTextFormat() Gets is keep text formatting.
void	isKeepTextFormat(boolean value) Sets is keep text formatting.
void	setText(java.lang.String value) Sets the Text value

Constructor Detail

MergeFieldEventArgs

public MergeFieldEventArgs(IDocument doc,
                           java.lang.String tableName,
                           int rowIndex,
                           IMergeField field,
                           java.lang.Object value)

Provides data during the MergeField event.

Parameters:

doc - doc

tableName - tableName

rowIndex - rowIndex

field - field

value - object

Method Detail

getDocument

public IDocument getDocument()

Gets the document.

Returns:

The document

getFieldName

public java.lang.String getFieldName()

Gets the Merge field Name.

Returns:

The field name

getFieldValue

public java.lang.Object getFieldValue()

Gets the Merge Field Value

Returns:

The field value

getTableName

public java.lang.String getTableName()

Gets the Table Name

Returns:

The table name

getRowIndex

public int getRowIndex()

Gets the Row Index.

Returns:

The row index

getCharacterFormat

public CharacterFormat getCharacterFormat()

Gets the Character Format of the field.

Returns:

The character format

getText

public java.lang.String getText()

Gets the Text value

Returns:

The text

setText

public void setText(java.lang.String value)

Sets the Text value

Parameters:

value - The text

getCurrentMergeField

public IMergeField getCurrentMergeField()

Gets the current Merge field.

Returns:

The current merge field

isKeepTextFormat

public boolean isKeepTextFormat()

Gets is keep text formatting.

Returns:

Keep the text format or NOT

isKeepTextFormat

public void isKeepTextFormat(boolean value)

Sets is keep text formatting.

Parameters:

value - Keep the text format or NOT