Usando campos en Aspose.Words para Java
Contenido
[
Ocultar
]En este tutorial paso a paso, lo guiaremos sobre cómo usar campos en Aspose.Words para Java para manipular documentos con facilidad. Aspose.Words para Java es una potente API que le permite trabajar con documentos de Word mediante programación, brindándole control total sobre su contenido y formato.
1. Introducción
Aspose.Words para Java es una herramienta esencial para cualquiera que trabaje con documentos de Word en aplicaciones Java. Los campos son marcadores de posición que pueden almacenar datos dinámicos en su documento. Este tutorial le mostrará cómo trabajar con campos de forma eficaz.
2. Configurando tu entorno
Antes de comenzar, asegúrese de tener instalado Aspose.Words para Java. Puedes descargarlo desdeaquí. Además, asegúrese de tener Java y un entorno de desarrollo integrado (IDE) como Eclipse o IntelliJ IDEA instalado en su sistema.
3. Cargar un documento de Word
En su aplicación Java, debe cargar el documento de Word con el que desea trabajar. Aquí hay un fragmento de código para comenzar:
string dataDir = "Your Document Directory";
string outPath = "Your Output Directory";
Document doc = new Document(dataDir + "Mail merge destinations - Fax.docx");
Reemplazar"Your Document Directory"y"Your Output Directory" con los caminos adecuados.
4. Personalización de la combinación de correspondencia
Aspose.Words para Java proporciona un excelente soporte para operaciones de combinación de correspondencia. Puede personalizar el proceso de combinación de correspondencia configurando un controlador de eventos de combinación de correspondencia. He aquí cómo hacerlo:
// Configure el controlador de eventos de combinación de correspondencia para realizar el trabajo personalizado.
doc.getMailMerge().setFieldMergingCallback(new HandleMergeField());
// Recorte los valores de combinación de correspondencia de los espacios en blanco iniciales y finales.
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);
5. Guardar el documento
Después de personalizar su documento, puede guardarlo usando el siguiente código:
doc.save(outPath + "WorkingWithFields.MailMergeFormFields.docx");
Reemplazar"Your Output Directory" con la ruta de salida deseada.
Código fuente completo
string dataDir = "Your Document Directory";
string outPath = "Your Output Directory";
Document doc = new Document(dataDir + "Mail merge destinations - Fax.docx");
// Configure el controlador de eventos de combinación de correspondencia para realizar el trabajo personalizado.
doc.getMailMerge().setFieldMergingCallback(new HandleMergeField());
// Recorte los valores de combinación de correspondencia de los espacios en blanco iniciales y finales.
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(outPath + "WorkingWithFields.MailMergeFormFields.docx");
Código fuente de la clase HandleMergeField
private static class HandleMergeField implements IFieldMergingCallback
{
/// <resumen>
/// Este controlador se llama para cada campo de combinación de correspondencia que se encuentra en el documento,
/// para cada registro encontrado en la fuente de datos.
/// </summary>
public void /*IFieldMergingCallback.*/fieldMerging(FieldMergingArgs e) throws Exception
{
if (mBuilder == null)
mBuilder = new DocumentBuilder(e.getDocument());
// Decidimos que queremos que todos los valores booleanos se generen como campos de formulario de casilla de verificación.
if (e.getFieldValue() instanceof /*boolean*/Boolean)
{
// Mueva el "cursor" al campo de combinación actual.
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;
}
@Test
public void mailMergeImageField() throws Exception
{
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("Your Directory Path" + "WorkingWithFields.MailMergeImageField.docx");
}
private static class ImageFieldMergingHandler implements IFieldMergingCallback
{
public void fieldMerging(FieldMergingArgs args)
{
// No se requiere implementación.
}
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("Your Directory Path" + "Mail merge image.png");
args.setShape(shape);
}
}
public static class DataSourceRoot implements IMailMergeDataSourceRoot
{
public IMailMergeDataSource getDataSource(String s)
{
return new DataSource();
}
private static class DataSource implements IMailMergeDataSource
{
private boolean next = true;
private String tableName()
{
return "example";
}
@Override
public String getTableName() {
return tableName();
}
public boolean moveNext()
{
boolean result = next;
next = false;
return result;
}
public IMailMergeDataSource getChildDataSource(String s)
{
return null;
}
public boolean getValue(String fieldName, Ref<Object> fieldValue)
{
fieldValue.set(null);
return false;
}
}
}
@Test
public void mailMergeAndConditionalField() throws Exception
{
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Inserte un MERGEFIELD anidado dentro de un campo IF.
// Dado que la declaración del campo IF es falsa, el resultado del MERGEFIELD interno no se mostrará.
// MERGEFIELD no recibirá ningún dato durante una combinación de correspondencia.
FieldIf fieldIf = (FieldIf)builder.insertField(" IF 1 = 2 ");
builder.moveTo(fieldIf.getSeparator());
builder.insertField(" MERGEFIELD FullName ");
// Todavía podemos contar MERGEFIELD dentro de campos IF de declaración falsa si configuramos este indicador en verdadero.
doc.getMailMerge().setUnconditionalMergeFieldsAndRegions(true);
DataTable dataTable = new DataTable();
dataTable.getColumns().add("FullName");
dataTable.getRows().add("James Bond");
doc.getMailMerge().execute(dataTable);
// El resultado no será visible en el documento porque el campo SI es falso,
// pero el MERGEFIELD interno sí recibió datos.
doc.save("Your Directory Path" + "WorkingWithFields.MailMergeAndConditionalField.docx");
}
@Test
public void mailMergeImageFromBlob() throws Exception
{
Document doc = new Document("Your Directory Path" + "Mail merge destination - Northwind employees.docx");
doc.getMailMerge().setFieldMergingCallback(new HandleMergeImageFieldFromBlob());
Class.forName("net.ucanaccess.jdbc.UcanaccessDriver");
String connString = "jdbc:ucanaccess://" + getDatabaseDir() + "Neptuno.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("Your Directory Path" + "WorkingWithFields.MailMergeImageFromBlob.docx");
}
public static class HandleMergeImageFieldFromBlob implements IFieldMergingCallback
{
public void /*IFieldMergingCallback.*/fieldMerging(FieldMergingArgs args)
{
// No hagas nada.
}
/// <resumen>
/// Esto se llama cuando el motor de combinación de correspondencia encuentra el campo de combinación Imagen:XXX en el documento.
/// Tiene la posibilidad de devolver un objeto Imagen, un nombre de archivo o una secuencia que contenga la imagen.
/// </summary>
public void /*IFieldMergingCallback.*/imageFieldMerging(ImageFieldMergingArgs e) throws Exception
{
// El valor del campo es una matriz de bytes, simplemente conviértalo y cree una secuencia en él.
ByteArrayInputStream imageStream = new ByteArrayInputStream((byte[]) e.getFieldValue());
// Ahora el motor de combinación de correspondencia recuperará la imagen de la secuencia.
e.setImageStream(imageStream);
}
}
@Test
public void handleMailMergeSwitches() throws Exception
{
Document doc = new Document("Your Directory Path" + "Field sample - MERGEFIELD.docx");
doc.getMailMerge().setFieldMergingCallback(new MailMergeSwitches());
final String HTML = "<html>\r\n <h1>Hello world!</h1>\r\n </html>";
doc.getMailMerge().execute(new String[] { "htmlField1" }, new Object[] { HTML });
doc.save("Your Directory Path" + "WorkingWithFields.HandleMailMergeSwitches.docx");
}
public static class MailMergeSwitches implements IFieldMergingCallback
{
public void /*IFieldMergingCallback.*/fieldMerging(FieldMergingArgs e) throws Exception
{
if (e.getFieldName().startsWith("HTML"))
{
if (e.getField().getFieldCode().contains("\\b"))
{
FieldMergeField field = e.getField();
DocumentBuilder builder = new DocumentBuilder(e.getDocument());
builder.moveToMergeField(e.getDocumentFieldName(), true, false);
builder.write(field.getTextBefore());
builder.insertHtml(e.getFieldValue().toString());
e.setText("");
}
}
}
public void /*IFieldMergingCallback.*/imageFieldMerging(ImageFieldMergingArgs args)
{
}
}
@Test
public void alternatingRows() throws Exception
{
Document doc = new Document("Your Directory Path" + "Mail merge destination - Northwind suppliers.docx");
doc.getMailMerge().setFieldMergingCallback(new HandleMergeFieldAlternatingRows());
DataTable dataTable = getSuppliersDataTable();
doc.getMailMerge().executeWithRegions(dataTable);
doc.save("Your Directory Path" + "WorkingWithFields.AlternatingRows.doc");
}
private static class HandleMergeFieldAlternatingRows implements IFieldMergingCallback
{
/// <resumen>
/// Llamado para cada campo de combinación encontrado en el documento.
/// Podemos devolver algunos datos al motor de combinación de correspondencia o hacer algo más con el documento.
/// En este caso modificamos el formato de la celda.
/// </summary>
public void /*IFieldMergingCallback.*/fieldMerging(FieldMergingArgs e)
{
if (mBuilder == null)
mBuilder = new DocumentBuilder(e.getDocument());
if ("CompanyName".equals(e.getFieldName()))
{
// Seleccione el color dependiendo de si el número de fila es par o impar.
Color rowColor = isOdd(mRowIdx)
? new Color((213), (227), (235))
: new Color((242), (242), (242));
//No hay forma de establecer propiedades de celda para toda la fila en este momento, por lo que tenemos que iterar sobre todas las celdas de la fila.
for (int colIdx = 0; colIdx < 4; colIdx++)
{
mBuilder.moveToCell(0, mRowIdx, colIdx, 0);
mBuilder.getCellFormat().getShading().setBackgroundPatternColor(rowColor);
}
mRowIdx++;
}
}
public void /*IFieldMergingCallback.*/imageFieldMerging(ImageFieldMergingArgs args)
{
// No hagas nada.
}
private DocumentBuilder mBuilder;
private int mRowIdx;
}
/// <resumen>
/// Devuelve verdadero si el valor es impar; falso si el valor es par.
/// </summary>
private static boolean isOdd(int value)
{
return (value / 2 * 2) == value;
}
/// <resumen>
///Crear DataTable y llenarlo con datos.
/// En la vida real este DataTable debería llenarse desde una base de datos.
/// </summary>
private DataTable getSuppliersDataTable()
{
DataTable dataTable = new DataTable("Suppliers");
dataTable.getColumns().add("CompanyName");
dataTable.getColumns().add("ContactName");
for (int i = 0; i < 10; i++)
{
DataRow datarow = dataTable.newRow();
dataTable.getRows().add(datarow);
datarow.set(0, "Company " + i);
datarow.set(1, "Contact " + i);
}
return dataTable;
}
}
6. Conclusión
¡Felicidades! Ha aprendido a utilizar campos en Aspose.Words para Java para manipular documentos de Word de forma dinámica. Esta poderosa API le brinda control total sobre sus documentos, lo que la convierte en un activo valioso para los desarrolladores de Java.
7. Preguntas frecuentes
P1: ¿Dónde puedo descargar Aspose.Words para Java?
Puede descargar Aspose.Words para Java desdeaquí.
P2: ¿Cómo puedo obtener una licencia temporal de Aspose.Words para Java?
Puede obtener una licencia temporal deaquí.
P3: ¿Dónde puedo obtener soporte para Aspose.Words para Java?
Para obtener ayuda, puede visitar el foro de Aspose.Words.aquí.
P4: ¿Aspose.Words para Java es adecuado para manejar contenido HTML en documentos de Word?
Sí, Aspose.Words para Java proporciona un excelente soporte para manejar contenido HTML en documentos de Word.
P5: ¿Puedo utilizar Aspose.Words para Java de forma gratuita?
Aspose.Words para Java es un producto comercial, pero puedes explorar sus funciones con una prueba gratuita disponibleaquí.
¡Comienza hoy con Aspose.Words para Java y toma el control de tus documentos de Word como nunca antes!
