Inserir Checkboxes, entrada de texto ou imagens

O mecanismo de mesclagem pega um documento como entrada, procura campos MERGEFIELD nele e os substitui pelos dados obtidos da fonte de dados. Normalmente, texto simples e HTML são inseridos, mas Aspose.Words os usuários também podem gerar um documento que lida com cenários mais incomuns para os campos Mail Merge.

A poderosa funcionalidade Aspose.Words permite estender o processo Mail Merge:

• inserir checkboxes e campos de formulário de entrada de texto no documento durante um mail merge
• inserir imagens de qualquer armazenamento Personalizado (ficheiros, campos BLOB, etc.)

Inserir Checkboxes e entrada de texto durante Mail Merge

Às vezes, é necessário executar uma operação Mail Merge para que não seja substituído texto no campo de mesclagem, mas um checkbox ou campo de entrada de texto. Embora este não seja o cenário mais comum, é muito útil para algumas tarefas.

A captura de tela a seguir de um documento do Word mostra um modelo com campos de mesclagem:

Esta captura de tela do documento do Word abaixo mostra o documento já gerado:

Observe que alguns campos foram substituídos por texto simples, alguns campos foram substituídos por campos de formulário checkbox e o campo Subject foi substituído por um campo de entrada de texto.

O exemplo de código a seguir mostra como inserir checkboxes e inserir campos de texto em um documento durante um 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;
}

Inserir imagens durante Mail Merge

Ao executar uma operação Mail Merge, você pode inserir imagens do banco de dados no documento usando campos especiais de imagem Mail Merge. O campo image Mail Merge é um campo de mesclagem denominado Image: MyFieldName.

Inserir imagens de uma base de dados

Durante um mail merge, quando um campo image Mail Merge é encontrado em um documento, o evento FieldMergingCallback é disparado. Você pode responder a esse evento para retornar um nome de arquivo, fluxo ou objeto de imagem ao mecanismo Mail Merge para que ele possa ser inserido no documento.

O exemplo de código a seguir mostra como inserir imagens armazenadas em um campo de banco de dados BLOB em um relatório:

// 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);
    }
}

Definir Propriedades da imagem durante Mail Merge

Ao mesclar um campo de mesclagem de imagem, às vezes é necessário controlar várias propriedades de imagem, como WrapType.

Atualmente, usando ImageFieldMergingArgs você só pode definir as propriedades de largura ou altura da imagem, respectivamente. Para superar esse problema, Aspose.Words fornece a propriedade Shape, o que facilita o controle total sobre a imagem inserida ou qualquer outra forma.

O exemplo de código a seguir mostra como definir várias propriedades de imagem:

// 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);
    }
}