Insertar Checkbox es, Entrada de texto o Imágenes

El motor de combinación toma un documento como entrada, busca los campos MERGEFIELD en él y los reemplaza con los datos obtenidos del origen de datos. Normalmente, se insertan texto sin formato y HTML, pero Aspose.Words los usuarios también pueden generar un documento que maneje escenarios más inusuales para Mail Merge campos.

La potente funcionalidad Aspose.Words le permite extender el proceso Mail Merge:

• inserte checkbox es y campos de formulario de entrada de texto en el documento durante un mail merge
• inserte imágenes desde cualquier almacenamiento personalizado (archivos, campos BLOB, etc.)

Inserte Checkbox es y entrada de texto durante Mail Merge

A veces es necesario realizar una operación Mail Merge para que no se sustituya texto en el campo de combinación, sino un checkbox o un campo de entrada de texto. Aunque este no es el escenario más común, es muy útil para algunas tareas.

La siguiente captura de pantalla de un documento de Word muestra una plantilla con campos de combinación:

Esta captura de pantalla del documento de Word a continuación muestra el documento ya generado:

Tenga en cuenta que algunos campos se reemplazaron con texto sin formato, algunos campos se reemplazaron con campos de formulario checkbox y el campo Subject se reemplazó con un campo de entrada de texto.

El siguiente ejemplo de código muestra cómo insertar checkbox es e ingresar campos de texto en un documento durante un mail merge:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(getMyDir() + "Mail merge destinations - Fax.docx");

// Setup mail merge event handler to do the custom work.
doc.getMailMerge().setFieldMergingCallback(new HandleMergeField());
// Trim trailing and leading whitespaces mail merge values.
doc.getMailMerge().setTrimWhitespaces(false);

String[] fieldNames = {
    "RecipientName", "SenderName", "FaxNumber", "PhoneNumber",
    "Subject", "Body", "Urgent", "ForReview", "PleaseComment"
};

Object[] fieldValues = {
    "Josh", "Jenny", "123456789", "", "Hello",
    "<b>HTML Body Test message 1</b>", true, false, true
};

doc.getMailMerge().execute(fieldNames, fieldValues);

doc.save(getArtifactsDir() + "WorkingWithFields.MailMergeFormFields.docx");

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
private static class HandleMergeField implements IFieldMergingCallback
{
    /// <summary>
    /// This handler is called for every mail merge field found in the document,
    /// for every record found in the data source.
    /// </summary>
    public void /*IFieldMergingCallback.*/fieldMerging(FieldMergingArgs e) throws Exception
    {
        if (mBuilder == null)
            mBuilder = new DocumentBuilder(e.getDocument());

        // We decided that we want all boolean values to be output as check box form fields.
        if (e.getFieldValue() instanceof /*boolean*/Boolean)
        {
            // Move the "cursor" to the current merge field.
            mBuilder.moveToMergeField(e.getFieldName());

            String checkBoxName = MessageFormat.format("{0}{1}", e.getFieldName(), e.getRecordIndex());

            mBuilder.insertCheckBox(checkBoxName, (Boolean) e.getFieldValue(), 0);

            return;
        }

        switch (e.getFieldName())
        {
            case "Body":
                mBuilder.moveToMergeField(e.getFieldName());
                mBuilder.insertHtml((String) e.getFieldValue());
                break;
            case "Subject":
            {
                mBuilder.moveToMergeField(e.getFieldName());
                String textInputName = MessageFormat.format("{0}{1}", e.getFieldName(), e.getRecordIndex());
                mBuilder.insertTextInput(textInputName, TextFormFieldType.REGULAR, "", (String) e.getFieldValue(), 0);
                break;
            }
        }
    }

    public void imageFieldMerging(ImageFieldMergingArgs args)
    {
        args.setImageFileName("Image.png");
        args.getImageWidth().setValue(200.0);
        args.setImageHeight(new MergeFieldImageDimension(200.0, MergeFieldImageDimensionUnit.PERCENT));
    }

    private DocumentBuilder mBuilder;
}

Insertar imágenes durante Mail Merge

Al realizar una operación Mail Merge, puede insertar imágenes de la base de datos en el documento utilizando campos especiales de image Mail Merge. El campo image Mail Merge es un campo de combinación denominado Image:MyFieldName.

Insertar imágenes desde una base de datos

Durante un mail merge, cuando se encuentra un campo image Mail Merge en un documento, se activa el evento FieldMergingCallback. Puede responder a este evento para devolver un nombre de archivo, secuencia u objeto de imagen al motor Mail Merge para que pueda insertarse en el documento.

El siguiente ejemplo de código muestra cómo insertar imágenes almacenadas en un campo BLOB de la base de datos en un informe:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
public void mailMergeImageFromBlob() throws Exception
{
    Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx");

    doc.getMailMerge().setFieldMergingCallback(new HandleMergeImageFieldFromBlob());

    Class.forName("net.ucanaccess.jdbc.UcanaccessDriver");
    String connString = "jdbc:ucanaccess://" + getDatabaseDir() + "Northwind.mdb";

    Connection connection = DriverManager.getConnection(connString, "Admin", "");

    Statement statement = connection.createStatement();
    ResultSet resultSet = statement.executeQuery("SELECT * FROM Employees");

    DataTable dataTable = new DataTable(resultSet, "Employees");
    IDataReader dataReader = new DataTableReader(dataTable);

    doc.getMailMerge().executeWithRegions(dataReader, "Employees");

    connection.close();
    
    doc.save(getArtifactsDir() + "WorkingWithFields.MailMergeImageFromBlob.docx");
}

public static class HandleMergeImageFieldFromBlob implements IFieldMergingCallback
{
    public void fieldMerging(FieldMergingArgs args)
    {
        // Do nothing.
    }

    /// <summary>
    /// This is called when mail merge engine encounters Image:XXX merge field in the document.
    /// You have a chance to return an Image object, file name, or a stream that contains the image.
    /// </summary>
    public void imageFieldMerging(ImageFieldMergingArgs e) throws Exception
    {
        // The field value is a byte array, just cast it and create a stream on it.
        ByteArrayInputStream imageStream = new ByteArrayInputStream((byte[]) e.getFieldValue());
        // Now the mail merge engine will retrieve the image from the stream.
        e.setImageStream(imageStream);
    }
}

Establecer Propiedades de imagen durante Mail Merge

Al combinar un campo de combinación de imágenes, a veces es posible que deba controlar varias propiedades de la imagen, como WrapType.

Actualmente, al usar ImageFieldMergingArgs solo puede establecer las propiedades de ancho o alto de la imagen, respectivamente. Para superar este problema, Aspose.Words proporciona la propiedad Shape, que facilita obtener un control total sobre la imagen insertada o cualquier otra forma.

El siguiente ejemplo de código muestra cómo establecer varias propiedades de imagen:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.writeln("{{#foreach example}}");
builder.writeln("{{Image(126pt;126pt):stempel}}");
builder.writeln("{{/foreach example}}");

doc.getMailMerge().setUseNonMergeFields(true);
doc.getMailMerge().setTrimWhitespaces(true);
doc.getMailMerge().setUseWholeParagraphAsRegion(false);
doc.getMailMerge().setCleanupOptions(MailMergeCleanupOptions.REMOVE_EMPTY_TABLE_ROWS
        | MailMergeCleanupOptions.REMOVE_CONTAINING_FIELDS
        | MailMergeCleanupOptions.REMOVE_UNUSED_REGIONS
        | MailMergeCleanupOptions.REMOVE_UNUSED_FIELDS);

doc.getMailMerge().setFieldMergingCallback(new ImageFieldMergingHandler());
doc.getMailMerge().executeWithRegions(new DataSourceRoot());

doc.save(getArtifactsDir() + "WorkingWithFields.MailMergeImageField.docx");

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
private static class ImageFieldMergingHandler implements IFieldMergingCallback
{
    public void fieldMerging(FieldMergingArgs args)
    {
        //  Implementation is not required.
    }

    public void imageFieldMerging(ImageFieldMergingArgs args) throws Exception
    {
        Shape shape = new Shape(args.getDocument(), ShapeType.IMAGE);
        {
            shape.setWidth(126.0); shape.setHeight(126.0); shape.setWrapType(WrapType.SQUARE);
        }

        shape.getImageData().setImage(getMyDir() + "Mail merge image.png");

        args.setShape(shape);
    }
}