InsertField

InsertField(FieldType, bool)

Inserta un campo de Word en un documento y, opcionalmente, actualiza el resultado del campo.

public Field InsertField(FieldType fieldType, bool updateField)
ParámetroEscribeDescripción
fieldTypeFieldTypeEl tipo de campo a agregar.
updateFieldBooleanEspecifica si se debe actualizar el campo inmediatamente.

Valor_devuelto

AField objeto que representa el campo insertado.

Observaciones

Este método inserta un campo en un documento. Aspose.Words puede actualizar campos de la mayoría de los tipos, pero no de todos. Para más detalles, consulteInsertField sobrecarga.

Ejemplos

Muestra cómo insertar un campo en un documento utilizando FieldType.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Inserte dos campos mientras pasa un indicador que determina si actualizarlos a medida que el generador los inserta.
// En algunos casos, actualizar los campos puede resultar computacionalmente costoso y puede ser una buena idea posponer la actualización.
doc.BuiltInDocumentProperties.Author = "John Doe";
builder.Write("This document was written by ");
builder.InsertField(FieldType.FieldAuthor, updateInsertedFieldsImmediately);

builder.InsertParagraph();
builder.Write("\nThis is page ");
builder.InsertField(FieldType.FieldPage, updateInsertedFieldsImmediately);

Assert.AreEqual(" AUTHOR ", doc.Range.Fields[0].GetFieldCode());
Assert.AreEqual(" PAGE ", doc.Range.Fields[1].GetFieldCode());

if (updateInsertedFieldsImmediately)
{
    Assert.AreEqual("John Doe", doc.Range.Fields[0].Result);
    Assert.AreEqual("1", doc.Range.Fields[1].Result);
}
else
{
    Assert.AreEqual(string.Empty, doc.Range.Fields[0].Result);
    Assert.AreEqual(string.Empty, doc.Range.Fields[1].Result);

    // Necesitaremos actualizar estos campos utilizando los métodos de actualización manualmente.
    doc.Range.Fields[0].Update();

    Assert.AreEqual("John Doe", doc.Range.Fields[0].Result);

    doc.UpdateFields();

    Assert.AreEqual("1", doc.Range.Fields[1].Result);
}

Ver también

InsertField(string)

Inserta un campo de Word en un documento y actualiza el resultado del campo.

public Field InsertField(string fieldCode)
ParámetroEscribeDescripción
fieldCodeStringEl código de campo a insertar (sin llaves).

Valor_devuelto

AField objeto que representa el campo insertado.

Observaciones

Este método inserta un campo en un documento y actualiza su resultado inmediatamente. Aspose.Words puede actualizar campos de la mayoría de los tipos, pero no de todos. Para más detalles, consulteInsertField sobrecarga.

Ejemplos

Muestra cómo insertar un campo en un documento utilizando un código de campo.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Field field = builder.InsertField("DATE \\@ \"dddd, MMMM dd, yyyy\"");

Assert.AreEqual(FieldType.FieldDate, field.Type);
Assert.AreEqual("DATE \\@ \"dddd, MMMM dd, yyyy\"", field.GetFieldCode());

// Esta sobrecarga del método InsertField actualiza automáticamente los campos insertados.
Assert.True((DateTime.Today - DateTime.Parse(field.Result)).Days <= 1);

Muestra cómo insertar campos y mover el cursor del generador de documentos hacia ellos.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.InsertField(@"MERGEFIELD MyMergeField1 \* MERGEFORMAT");
builder.InsertField(@"MERGEFIELD MyMergeField2 \* MERGEFORMAT");

// Mueve el cursor al primer MERGEFIELD.
builder.MoveToMergeField("MyMergeField1", true, false);

// Tenga en cuenta que el cursor se coloca inmediatamente después del primer MERGEFIELD y antes del segundo.
Assert.AreEqual(doc.Range.Fields[1].Start, builder.CurrentNode);
Assert.AreEqual(doc.Range.Fields[0].End, builder.CurrentNode.PreviousSibling);

// Si deseamos editar el código de campo o el contenido del campo utilizando el constructor,
//su cursor necesitaría estar dentro de un campo.
// Para colocarlo dentro de un campo, necesitaríamos llamar al método MoveTo del generador de documentos
// y pasar el nodo de inicio o separador del campo como argumento.
builder.Write(" Text between our merge fields. ");

doc.Save(ArtifactsDir + "DocumentBuilder.MergeFields.docx");

Ver también

InsertField(string, string)

Inserta un campo de Word en un documento sin actualizar el resultado del campo.

public Field InsertField(string fieldCode, string fieldValue)
ParámetroEscribeDescripción
fieldCodeStringEl código de campo a insertar (sin llaves).
fieldValueStringEl valor del campo a insertar. Pasarnulo para campos que no tienen un valor.

Valor_devuelto

AField objeto que representa el campo insertado.

Observaciones

Los campos en los documentos de Microsoft Word constan de un código de campo y un resultado de campo. El código de campo es como una fórmula y el resultado de campo es como el valor que la fórmula produce. El código de campo también puede contener modificadores de campo, que son como instrucciones adicionales para realizar una acción específica.

Puede alternar entre la visualización de códigos de campo y resultados en su documento de Microsoft Word mediante el atajo de teclado Alt+F9. Los códigos de campo aparecen entre llaves ({}).

Para crear un campo, debe especificar un tipo de campo, un código de campo y un valor de campo “marcador de posición”. Si no está seguro acerca de la sintaxis de un código de campo en particular, primero cree el campo en Microsoft Word y cambie para ver su código de campo.

Aspose.Words puede calcular resultados de campo para la mayoría de los tipos de campo, pero este método no actualiza el resultado automáticamente. Dado que el resultado no se calcula automáticamente, se espera que pase un valor de cadena (o incluso una cadena vacía) que se insertará en el resultado. Este valor permanecerá en el resultado como marcador de posición hasta que se actualice. Para actualizar el resultado, puede llamar aUpdate en el campo objeto devuelto a usted oUpdateFields para actualizar campos en todo el documento.

Ejemplos

Muestra cómo configurar la numeración de páginas en una sección.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Writeln("Section 1, page 1.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 1, page 2.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 1, page 3.");
builder.InsertBreak(BreakType.SectionBreakNewPage);
builder.Writeln("Section 2, page 1.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 2, page 2.");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Section 2, page 3.");

// Mueva el generador de documentos al encabezado principal de la primera sección,
// que se mostrará en cada página de esa sección.
builder.MoveToSection(0);
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);

// Inserta un campo PÁGINA, que mostrará el número de la página actual.
builder.Write("Page ");
builder.InsertField("PAGE", "");

// Configure la sección para que el recuento de páginas que muestran los campos PÁGINA comience desde 5.
// Además, configure todos los campos PÁGINA para mostrar sus números de página utilizando números romanos en mayúsculas.
PageSetup pageSetup = doc.Sections[0].PageSetup;
pageSetup.RestartPageNumbering = true;
pageSetup.PageStartingNumber = 5;
pageSetup.PageNumberStyle = NumberStyle.UppercaseRoman;

// Crea otro encabezado principal para la segunda sección, con otro campo PAGE.
builder.MoveToSection(1);
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.ParagraphFormat.Alignment = ParagraphAlignment.Center;
builder.Write(" - ");
builder.InsertField("PAGE", "");
builder.Write(" - ");

// Configure la sección para que el recuento de páginas que muestran los campos PÁGINA comience desde 10.
// Además, configure todos los campos PÁGINA para mostrar sus números de página utilizando números arábigos.
pageSetup = doc.Sections[1].PageSetup;
pageSetup.PageStartingNumber = 10;
pageSetup.RestartPageNumbering = true;
pageSetup.PageNumberStyle = NumberStyle.Arabic;

doc.Save(ArtifactsDir + "PageSetup.PageNumbering.docx");

Ver también

DocumentBuilder.InsertDocumentInline DocumentBuilder.InsertFootnote