ImageFieldMergingArgsImage Property

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

Namespace:  Aspose.Words.MailMerging
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 20.6


public Image Image { get; set; }

Property Value

Type: Image


Shows how to set which images to merge during the mail merge.
public void MergeFieldImages()
    Document doc = new Document();

    // Insert a merge field where images will be placed during the mail merge
    DocumentBuilder builder = new DocumentBuilder(doc);
    FieldMergeField field = (FieldMergeField)builder.InsertField("MERGEFIELD Image:ImageColumn");

    Assert.AreEqual("Image:ImageColumn", field.FieldName);

    // When we merge images, our data table will normally have the full e. of the images we wish to merge
    // If this is cumbersome, we can move image filename logic to another place and populate the data table with just shorthands for images
    DataTable dataTable = new DataTable("Images");
    dataTable.Columns.Add(new DataColumn("ImageColumn"));
    dataTable.Rows.Add("Dark logo");
    dataTable.Rows.Add("Transparent logo");

    // A custom merging callback will contain filenames that our shorthands will refer to
    doc.MailMerge.FieldMergingCallback = new ImageFilenameCallback();

    doc.Save(ArtifactsDir + "Field.MERGEFIELD.Images.docx");
    TestMergeFieldImages(new Document(ArtifactsDir + "Field.MERGEFIELD.Images.docx"));

/// <summary>
/// Image merging callback that pairs image shorthand names with filenames.
/// </summary>
private class ImageFilenameCallback : IFieldMergingCallback
    public ImageFilenameCallback()
        mImageFilenames = new Dictionary<string, string>();
        mImageFilenames.Add("Dark logo", ImageDir + "Logo.jpg");
        mImageFilenames.Add("Transparent logo", ImageDir + "Transparent background logo.png");

    void IFieldMergingCallback.FieldMerging(FieldMergingArgs args)
        throw new NotImplementedException();

    void IFieldMergingCallback.ImageFieldMerging(ImageFieldMergingArgs args)
        if (mImageFilenames.ContainsKey(args.FieldValue.ToString()))
            #if NET462 || JAVA
            args.Image = Image.FromFile(mImageFilenames[args.FieldValue.ToString()]);
            #elif NETCOREAPP2_1
            args.Image = SKBitmap.Decode(mImageFilenames[args.FieldValue.ToString()]);
            args.ImageFileName = mImageFilenames[args.FieldValue.ToString()];


    private readonly Dictionary<string, string> mImageFilenames;

See Also