ImageFieldMergingArgs

ImageFieldMergingArgs class

Предоставляет данные дляImageFieldMerging событие.

Чтобы узнать больше, посетитеСлияние писем и отчетность документальная статья.

public class ImageFieldMergingArgs : FieldMergingArgsBase

Характеристики

ИмяОписание
Document { get; }ВозвращаетDocumentобъект, для которого выполняется слияние почты.
DocumentFieldName { get; }Получает имя поля слияния, как указано в документе.
Field { get; }Получает объект, представляющий текущее поле слияния.
FieldName { get; }Получает имя поля слияния в источнике данных.
FieldValue { get; set; }Получает или задает значение поля из источника данных.
Image { get; set; }Указывает изображение, которое механизм слияния почты должен вставить в документ.
ImageFileName { get; set; }Задает имя файла изображения, которое механизм слияния почты должен вставить в документ.
ImageHeight { get; set; }Указывает высоту изображения для вставки в документ.
ImageStream { get; set; }Указывает поток, из которого механизм слияния почты будет считывать изображение.
ImageWidth { get; set; }Указывает ширину изображения для вставки в документ.
RecordIndex { get; }Получает индекс записи, которая объединяется, начиная с нуля.
Shape { get; set; }Указывает форму, которую механизм слияния почты должен вставить в документ.
TableName { get; }Получает имя таблицы данных для текущей операции слияния или пустую строку, если имя недоступно.

Примечания

Это событие происходит во время слияния почты, когда в документе встречается поле image mail merge . Вы можете ответить на это событие, чтобы вернуть имя файла a , поток илиImage объект для движка mail merge , чтобы он был вставлен в документ.

Доступны три объекта недвижимостиImageFileName , ImageStream иImage чтобы указать, откуда должно быть взято изображение. Задайте только одно из этих свойств.

Чтобы вставить поле слияния изображения в документ Word, выберите команду Вставить/Поле, , затем выберите MergeField и введите Image:MyFieldName.

Примеры

Показывает, как вставлять в отчет изображения, хранящиеся в BLOB-поле базы данных.

public void ImageFromBlob()
{
    Document doc = new Document(MyDir + "Mail merge destination - Northwind employees.docx");

    doc.MailMerge.FieldMergingCallback = new HandleMergeImageFieldFromBlob();

    string connString = $"Provider=Microsoft.ACE.OLEDB.12.0;Data Source={DatabaseDir + "Northwind.accdb"};";
    string query = "SELECT FirstName, LastName, Title, Address, City, Region, Country, PhotoBLOB FROM Employees";

    using (OleDbConnection conn = new OleDbConnection(connString))
    {
        conn.Open();

        // Откройте средство чтения данных, которое должно находиться в режиме, позволяющем считывать все записи одновременно.
        OleDbCommand cmd = new OleDbCommand(query, conn);
        IDataReader dataReader = cmd.ExecuteReader();

        doc.MailMerge.ExecuteWithRegions(dataReader, "Employees");
    }

    doc.Save(ArtifactsDir + "MailMergeEvent.ImageFromBlob.docx");
}

private class HandleMergeImageFieldFromBlob : IFieldMergingCallback
{
    void IFieldMergingCallback.FieldMerging(FieldMergingArgs args)
    {
        // Ничего не делать.
    }

    /// <summary>
    /// Вызывается, когда при слиянии почты в документе обнаруживается MERGEFIELD с тегом «Image:» в имени.
    /// </summary>
    void IFieldMergingCallback.ImageFieldMerging(ImageFieldMergingArgs e)
    {
        MemoryStream imageStream = new MemoryStream((byte[])e.FieldValue);
        e.ImageStream = imageStream;
    }
}

Показывает, как задать размеры изображений, поскольку MERGEFIELDS принимает их во время слияния почты.

public void MergeFieldImageDimension()
{
    Document doc = new Document();

    // Вставьте MERGEFIELD, который будет принимать изображения из источника во время слияния почты. Используйте код поля для ссылки
    // столбец в источнике данных, содержащий локальные системные имена файлов изображений, которые мы хотим использовать при слиянии.
    DocumentBuilder builder = new DocumentBuilder(doc);
    FieldMergeField field = (FieldMergeField)builder.InsertField("MERGEFIELD Image:ImageColumn");

    // Источник данных должен иметь такой столбец с именем «ImageColumn».
    Assert.AreEqual("Image:ImageColumn", field.FieldName);

    // Создайте подходящий источник данных.
    DataTable dataTable = new DataTable("Images");
    dataTable.Columns.Add(new DataColumn("ImageColumn"));
    dataTable.Rows.Add(ImageDir + "Logo.jpg");
    dataTable.Rows.Add(ImageDir + "Transparent background logo.png");
    dataTable.Rows.Add(ImageDir + "Enhanced Windows MetaFile.emf");

    // Настройте обратный вызов для изменения размеров изображений во время слияния, затем выполните слияние почты.
    doc.MailMerge.FieldMergingCallback = new MergedImageResizer(200, 200, MergeFieldImageDimensionUnit.Point);
    doc.MailMerge.Execute(dataTable);

    doc.UpdateFields();
    doc.Save(ArtifactsDir + "Field.MERGEFIELD.ImageDimension.docx");
}

/// <summary>
/// Устанавливает размер всех объединенных изображений на одну определенную ширину и высоту.
/// </summary>
private class MergedImageResizer : IFieldMergingCallback
{
    public MergedImageResizer(double imageWidth, double imageHeight, MergeFieldImageDimensionUnit unit)
    {
        mImageWidth = imageWidth;
        mImageHeight = imageHeight;
        mUnit = unit;
    }

    public void FieldMerging(FieldMergingArgs e)
    {
        throw new NotImplementedException();
    }

    public void ImageFieldMerging(ImageFieldMergingArgs args)
    {
        args.ImageFileName = args.FieldValue.ToString();
        args.ImageWidth = new MergeFieldImageDimension(mImageWidth, mUnit);
        args.ImageHeight = new MergeFieldImageDimension(mImageHeight, mUnit);

        Assert.AreEqual(mImageWidth, args.ImageWidth.Value);
        Assert.AreEqual(mUnit, args.ImageWidth.Unit);
        Assert.AreEqual(mImageHeight, args.ImageHeight.Value);
        Assert.AreEqual(mUnit, args.ImageHeight.Unit);
        Assert.Null(args.Shape);
    }

    private readonly double mImageWidth;
    private readonly double mImageHeight;
    private readonly MergeFieldImageDimensionUnit mUnit;
}

Смотрите также

IMailMergeDataSourceRoot Interface MailMerge Class