com.aspose.words

Class ImageFieldMergingArgs

java.lang.Object

com.aspose.words.FieldMergingArgsBase

com.aspose.words.ImageFieldMergingArgs

public class ImageFieldMergingArgs
extends FieldMergingArgsBase

Provides data for the IFieldMergingCallback.imageFieldMerging(com.aspose.words.ImageFieldMergingArgs) event.

To learn more, visit the Mail Merge and Reporting documentation article.

This event occurs during mail merge when an image mail merge field is encountered in the document. You can respond to this event to return a file name, stream, or an BufferedImage object to the mail merge engine so it is inserted into the document.

There are three properties available getImageFileName() / setImageFileName(java.lang.String), P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream and getImage() / setImage(java.awt.image.BufferedImage) to specify where the image must be taken from. Set only one of these properties.

To insert an image mail merge field into a document in Word, select Insert/Field command, then select MergeField and type Image:MyFieldName.

See Also:

IFieldMergingCallback

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getImage() Specifies the image that the mail merge engine must insert into the document.
java.lang.String	getImageFileName() Sets the file name of the image that the mail merge engine must insert into the document.
MergeFieldImageDimension	getImageHeight() Specifies the image height for the image to insert into the document.
java.io.InputStream	getImageStream()
MergeFieldImageDimension	getImageWidth() Specifies the image width for the image to insert into the document.
Shape	getShape() Specifies the shape that the mail merge engine must insert into the document.
void	setImage(java.awt.image.BufferedImage value) Specifies the image that the mail merge engine must insert into the document.
void	setImageFileName(java.lang.String value) Sets the file name of the image that the mail merge engine must insert into the document.
void	setImageHeight(MergeFieldImageDimension value) Specifies the image height for the image to insert into the document.
void	setImageStream(java.io.InputStream value)
void	setImageWidth(MergeFieldImageDimension value) Specifies the image width for the image to insert into the document.
void	setShape(Shape value) Specifies the shape that the mail merge engine must insert into the document.

Methods inherited from class com.aspose.words.FieldMergingArgsBase

getDocument, getDocumentFieldName, getField, getFieldName, getFieldValue, getRecordIndex, getTableName, setFieldValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getImageFileName

public java.lang.String getImageFileName()

Sets the file name of the image that the mail merge engine must insert into the document.

Returns:

The file name of the image that the mail merge engine must insert into the document.

setImageFileName

public void setImageFileName(java.lang.String value)

Sets the file name of the image that the mail merge engine must insert into the document.

Parameters:

value - The file name of the image that the mail merge engine must insert into the document.

getImageStream

public java.io.InputStream getImageStream()

setImageStream

public void setImageStream(java.io.InputStream value)

getImage

public java.awt.image.BufferedImage getImage()

Specifies the image that the mail merge engine must insert into the document.

Returns:

The corresponding BufferedImage value.

setImage

public void setImage(java.awt.image.BufferedImage value)

Specifies the image that the mail merge engine must insert into the document.

Parameters:

value - The corresponding BufferedImage value.

getShape

public Shape getShape()

Specifies the shape that the mail merge engine must insert into the document.

When this property is specified, the mail merge engine ignores all other properties like getImageFileName() / setImageFileName(java.lang.String) or P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream and simply inserts the shape into the document.

Use this property to fully control the process of merging an image merge field. For example, you can specify ShapeBase.getWrapType() / ShapeBase.setWrapType(int) or any other shape property to fine tune the resulting node. However, please note that you are responsible for providing the content of the shape.

Returns:

The corresponding Shape value.

setShape

public void setShape(Shape value)

Specifies the shape that the mail merge engine must insert into the document.

When this property is specified, the mail merge engine ignores all other properties like getImageFileName() / setImageFileName(java.lang.String) or P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream and simply inserts the shape into the document.

Use this property to fully control the process of merging an image merge field. For example, you can specify ShapeBase.getWrapType() / ShapeBase.setWrapType(int) or any other shape property to fine tune the resulting node. However, please note that you are responsible for providing the content of the shape.

Parameters:

value - The corresponding Shape value.

getImageWidth

public MergeFieldImageDimension getImageWidth()

Specifies the image width for the image to insert into the document.

The value of this property initially comes from the corresponding MERGEFIELD's code, contained in the template document. To override the initial value, you should assign an instance of MergeFieldImageDimension class to this property or set the properties for the instance of MergeFieldImageDimension class, returned by this property.

To indicate that the original value of the image width should be applied, you should assign the null value to this property or set the MergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) property for the instance of MergeFieldImageDimension class, returned by this property, to a negative value.

Returns:

The corresponding MergeFieldImageDimension value.

See Also:

MergeFieldImageDimension, MergeFieldImageDimensionUnit

setImageWidth

public void setImageWidth(MergeFieldImageDimension value)

Specifies the image width for the image to insert into the document.

The value of this property initially comes from the corresponding MERGEFIELD's code, contained in the template document. To override the initial value, you should assign an instance of MergeFieldImageDimension class to this property or set the properties for the instance of MergeFieldImageDimension class, returned by this property.

To indicate that the original value of the image width should be applied, you should assign the null value to this property or set the MergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) property for the instance of MergeFieldImageDimension class, returned by this property, to a negative value.

Parameters:

value - The corresponding MergeFieldImageDimension value.

See Also:

MergeFieldImageDimension, MergeFieldImageDimensionUnit

getImageHeight

public MergeFieldImageDimension getImageHeight()

Specifies the image height for the image to insert into the document.

The value of this property initially comes from the corresponding MERGEFIELD's code, contained in the template document. To override the initial value, you should assign an instance of MergeFieldImageDimension class to this property or set the properties for the instance of MergeFieldImageDimension class, returned by this property.

To indicate that the original value of the image height should be applied, you should assign the null value to this property or set the MergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) property for the instance of MergeFieldImageDimension class, returned by this property, to a negative value.

Returns:

The corresponding MergeFieldImageDimension value.

See Also:

MergeFieldImageDimension, MergeFieldImageDimensionUnit

setImageHeight

public void setImageHeight(MergeFieldImageDimension value)

Specifies the image height for the image to insert into the document.

The value of this property initially comes from the corresponding MERGEFIELD's code, contained in the template document. To override the initial value, you should assign an instance of MergeFieldImageDimension class to this property or set the properties for the instance of MergeFieldImageDimension class, returned by this property.

To indicate that the original value of the image height should be applied, you should assign the null value to this property or set the MergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) property for the instance of MergeFieldImageDimension class, returned by this property, to a negative value.

Parameters:

value - The corresponding MergeFieldImageDimension value.

See Also:

MergeFieldImageDimension, MergeFieldImageDimensionUnit