Un encabezado es el margen superior de cada página y un pie de página es el margen inferior de cada página. Los encabezados y pies de página son útiles para incluir información que desea mostrar en cada página de un documento, como su nombre, fechas, el título del documento, números de página o exenciones de responsabilidad de los documentos. Al usar MS Word, proporciona la capacidad de agregar encabezados y pies de página según diseños predefinidos o le permite agregar encabezados y pies de página personalizados. La mayoría de los encabezados integrados contienen algún texto de marcador de posición y puede mantener el texto de marcador de posición o reemplazarlo con su propia fuente de datos. Además, al actualizar la información en la sección Encabezado o Pie de página, el contenido dentro del cuerpo principal del documento aparece en gris, lo que indica que estos objetos están totalmente aislados del resto del contenido de la página y la operación que realiza en estos objetos es específica de estas áreas. En este artículo, aprenderemos los pasos sobre cómo agregar o actualizar el encabezado y pie de página en un documento de Word usando la API REST.

API de procesamiento de textos

Aspose.Words Cloud API ofrece la posibilidad de cargar archivos MS Word desde el almacenamiento en la nube, y permite al usuario pasar el archivo de entrada directamente en el cuerpo de la solicitud y la API devuelve el archivo actualizado en el objeto de respuesta. Ofrece las funciones de lectura, adición, actualización o eliminación de objetos de encabezado y pie de página específicos o de todos ellos. Además, también puede especificar que se representen diferentes encabezados y pies de página para la primera página y para las páginas pares e impares.

Además, la API también le permite configurar información de formato, como las propiedades de fuente y párrafo para el texto del encabezado/pie de página. También tiene la posibilidad de insertar números de página dinámicos en la sección de encabezado/pie de página. Por último, pero no por ello menos importante, puede considerar el uso de objetos de tabla para hacer que una parte del texto del encabezado/pie de página se alinee con el borde izquierdo y la otra con el borde derecho.

Alcance del artículo

Nuestro Aspose.Words Cloud SDK for .NET le permite trabajar con Aspose.Words Cloud REST APIs de forma rápida y sencilla, ya que se encarga de muchos detalles de bajo nivel relacionados con la realización de solicitudes y el manejo de respuestas y le permite centrarse en escribir código específico para los requisitos de su negocio. En este artículo, vamos a utilizar Aspose.Words Cloud SDK for .NET en Visual Studio para Mac. Esta publicación define los pasos para insertar un encabezado y un pie de página en un documento de Word donde se definirá un formato personalizado. Luego, se actualiza el formato del contenido del pie de página existente y se inserta la información de PageNumber en la posición inferior derecha. Todas estas operaciones se realizarán en la nube.

Instalación

Para comenzar, primero debe instalar Visual Studio en su sistema. Cree una solución de muestra y agregue la referencia NuGet de Aspose.Words Cloud SDK for .NET. Para agregar una referencia, haga clic con el botón derecho en la solución y seleccione la opción de menú Administrar paquetes NuGet… Ingrese Aspose.Words-Cloud en el campo de texto de búsqueda. Seleccione la opción y haga clic en el botón Agregar paquete.

Ahora aparece la referencia Aspose.Words.Cloud.Sdk en la solución. Existen algunas ventajas de utilizar API en la nube en comparación con las API locales (aspose.com).La razón es que no es necesario realizar un seguimiento y actualizar manualmente las versiones de API y no es necesario pagar la licencia completa.

Panel de control de Aspose.Cloud

Simplemente crea una cuenta en Aspose.Cloud dashboard o regístrate a través de tu cuenta existente de Google o GitHub y comienza a usar nuestras API de Cloud. Otra característica sorprendente de las API de Cloud es que puedes usarlas en cualquier plataforma y con cualquier lenguaje compatible.

Como se indicó anteriormente, el artículo enfatiza las opciones relacionadas con la adición y actualización de objetos de encabezado y pie de página dentro de los documentos de MS Word. Para realizar pruebas, hemos utilizado una plantilla de documento de MS Word existente con el nombre Carta comercial. El documento debe cargarse en el almacenamiento en la nube de Aspose y toda la manipulación y el procesamiento del documento se realizarán en la nube. Una vez que se complete todo el procesamiento, también podemos descargar la copia del archivo resultante desde el almacenamiento en la nube.

using Aspose.Words.Cloud.Sdk;
using Aspose.Words.Cloud.Sdk.Model;
using Aspose.Words.Cloud.Sdk.Model.Requests;

Ahora, para poder usar las API de Aspose.Cloud, debe usar la información de la clave de aplicación y el SID de la aplicación en su código. Estas claves están compuestas por dígitos alfanuméricos. Son códigos únicos asociados con su cuenta de suscripción. Para obtener estos detalles, haga clic en la pestaña Mis aplicaciones en el panel de control de Aspose.Cloud. Una vez que tengamos las claves, debemos inicializar el objeto de API de Aspose.Words.

string MyAppKey = "f6axxxxxxxxxxxxxxxxxx";     // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "478e4827-xxxxx-xxxx-xxxx-xxxxxxx"; // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// create an object of WordsApi while passing AppKey and AppSid information
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

Insertar objeto de encabezado

Para agregar el objeto de encabezado dentro del archivo MS Word, necesitamos realizar las siguientes operaciones en secuencia.

  1. Crea un objeto de InsertHeaderFooterRequest donde pasamos el tipo HeaderFooterLink como argumento.
  2. Inserte el objeto HeaderFooterRequest en el objeto WordsApi usando el método InsertHeaderFooter (…).
  3. Crea un objeto Ejecutar que contenga información de texto de muestra.
  4. Crea un objeto InsertRunRequest donde pasamos la referencia del párrafo (SectionPath) en el objeto HeaderFooter, donde se debe agregar el texto Run.
    Luego llame al método InsertRun (…) de WordsApi, que agrega RunRequest al objeto HeaderFooter.

HeaderFooter.TypeEnum puede ser cualquiera de los siguientes valores.

string MyAppKey = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// Crea un objeto de WordsAPI mientras pasas información de AppKey y AppSid
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// Subir documento de muestra al almacenamiento en la nube
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// Insertar objeto de encabezado en la primera página
var putHeaderFooterRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.InsertHeaderFooterRequest("BusinessLetter.docx", "HeaderFirst", null,null);  
var actual = wordsApi.InsertHeaderFooter(putHeaderFooterRequest);
// Crear objeto de ejecución que contenga texto de muestra
var run = new Run { Text = "Aspose.Words Cloud SDK for .NET " };
// Agregue el texto Ejecutar al primer párrafo del primer objeto HeaderFooter en la primera sección del documento de Word
var runRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.InsertRunRequest("BusinessLetter.docx", "sections/0/headersfooters/1/paragraphs/0", run);
// Insertar RunRequest en un documento de Word
var actual2 = wordsApi.InsertRun(runRequest);

Actualizar el formato del texto del encabezado recién insertado

Una vez añadido el objeto Header, podemos actualizar el formato del texto del contenido que contiene. Para cumplir con este requisito, debemos realizar los siguientes pasos.

  1. Crea un objeto de la clase Font, donde especificamos el nombre de la fuente, el tamaño y la información del color.
  2. Para que el texto sea más presentable, marque la propiedad Grabar como Verdadero.
  3. Crea un objeto de la clase UpdateRunFontRequest donde pasamos el archivo de entrada, Font, SectionPath y runIndex como argumento.
  4. Por último, utilice el método UpdateRunFont(..) y agregue el objeto UpdateRunFontRequest a la instancia de WordsApi.
string MyAppKey = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// Crea un objeto de WordsAPI mientras pasas información de AppKey y AppSid
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// Subir documento de muestra al almacenamiento en la nube
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// El siguiente paso es establecer el formato del objeto de encabezado.
var runIndex = 0;
var fontDto = new Font { Bold = true, Name = "Verdana", Size = 16, Color = new XmlColor { Web = "#e0a50d" } };
//  Establecer el formato del texto como Grabado
fontDto.Engrave = true;
// Aplicar formato al primer párrafo del objeto HeaderFooter
var documentParagraphRunFontRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.UpdateRunFontRequest("BusinessLetter.docx",
    fontDto, "sections/0/headersfooters/1/paragraphs/0", runIndex);
var actual4 = wordsApi.UpdateRunFont(documentParagraphRunFontRequest);

Actualizar el formato del objeto de pie de página existente

La API también ofrece la función de actualizar el formato del contenido dentro del objeto de encabezado/pie de página existente. Para cumplir con este requisito, podemos utilizar las líneas de código especificadas anteriormente, pero la única diferencia es el cambio del índice de encabezado/pie de página a 2. Vea la siguiente línea de código.

// Apply formatting to first paragraph of HeaderFooter object
var FooterDocumentParagraphRunFontRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.UpdateRunFontRequest("BusinessLetter.docx", 
FooterFontDto, "sections/0/headersfooters/2/paragraphs/0", FooterrunIndex);

Agregar información de número de página en la sección de pie de página

Los números de página proporcionan información muy útil, como la página actual y el número total de páginas de un documento. Los siguientes pasos definen cómo cumplir con los requisitos.

  1. Primero creamos un objeto de la clase PageNumber, donde definimos la alineación del texto, el formato del texto, la ubicación para representar la información de PageNumber y también, especificamos si PageNumber debe representarse en la primera página o no.
  2. Cree un objeto InsertPageNumbersRequest y pase el objeto PageNumber como argumento.
  3. Por último, llame al método InsertPageNumbers(..) para agregar InsertPageNumbersRequest a la instancia de WordsApi.
string MyAppKey = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// Crea un objeto de WordsAPI mientras pasas información de AppKey y AppSid
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// Subir documento de muestra al almacenamiento en la nube
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// La API también ofrece la función de agregar detalles del número de página en el objeto HeaderFooter
// Agregar información del número de página en la parte inferior derecha de la página
var body = new PageNumber { Alignment = "right", Format = "{PAGE} of {NUMPAGES}", IsTop = false, SetPageNumberOnFirstPage = true };
var insertPageNumbersRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.InsertPageNumbersRequest("BusinessLetter.docx", body);
// Insertar información de PageNumber dentro de un documento de Word
var actual6 = wordsApi.InsertPageNumbers(insertPageNumbersRequest);

Conclusión

En este artículo, hemos aprendido los pasos para agregar un encabezado y pie de página en un documento de Word usando Aspose.Words Cloud SDK para .NET. Tenga en cuenta que también tenemos SDK de la nube disponibles para Java, PHP, Ruby, Python, Go, Swift, C++, Node.Js, Android. Para obtener más detalles, visite Aspose.Words Cloud.

Artículos relacionados

También recomendamos visitar lo siguiente para obtener más información sobre