légende

A quick view of MS Word document transformation.

Un en-tête est la marge supérieure de chaque page et un pied de page est la marge inférieure de chaque page. Les en-têtes et les pieds de page sont utiles pour inclure des informations que vous souhaitez afficher sur chaque page d’un document, telles que votre nom, les dates, le titre du document, les numéros de page ou les clauses de non-responsabilité des documents. Lorsque vous utilisez MS Word, il offre la possibilité d’ajouter des en-têtes et des pieds de page en fonction de mises en page prédéfinies ou de vous permettre d’ajouter des en-têtes et des pieds de page personnalisés. La plupart des en-têtes intégrés contiennent du texte d’espace réservé et vous pouvez conserver le texte d’espace réservé ou le remplacer par votre propre flux de données. De plus, lors de la mise à jour des informations dans la section En-tête ou Pied de page, le contenu à l’intérieur du corps principal du document est grisé, ce qui indique que ces objets sont totalement isolés du reste du contenu de la page et que l’opération que vous effectuez sur ces objets est spécifique à ces zones. Dans cet article, nous allons découvrir les étapes à suivre pour ajouter ou mettre à jour l’en-tête et le pied de page dans un document Word à l’aide de l’API REST.

API de traitement de texte

Aspose.Words Cloud API fournit les fonctionnalités pour charger des fichiers MS Word à partir du stockage Cloud, et permet également à l’utilisateur de transmettre le fichier d’entrée directement dans le corps de la requête et l’API renvoie le fichier mis à jour dans l’objet de réponse. Elle fournit les fonctionnalités pour lire, ajouter, mettre à jour ou supprimer des objets d’en-tête et de pied de page spécifiques ou tous. En outre, vous pouvez également spécifier le rendu d’en-têtes/pieds de page différents pour la première page et pour les pages paires/impaires.

De plus, l’API vous permet également de définir des informations de formatage telles que les propriétés de police et de paragraphe pour le texte d’en-tête/pied de page. Vous avez également la possibilité d’insérer des numéros de page dynamiques dans la section en-tête/pied de page. Enfin, vous pouvez envisager d’utiliser des objets de tableau pour aligner une partie du texte d’en-tête/pied de page sur le bord gauche et l’autre sur le bord droit.

Portée de l’article

Notre Aspose.Words Cloud SDK for .NET vous permet de travailler avec les API REST Aspose.Words Cloud rapidement et facilement, car il prend en charge de nombreux détails de bas niveau concernant la création de requêtes et la gestion des réponses et vous permet de vous concentrer sur l’écriture de code spécifique à vos besoins métier. Dans cet article, nous allons utiliser Aspose.Words Cloud SDK for .NET dans Visual Studio pour Mac. Cet article définit les étapes à suivre pour insérer un en-tête ou un pied de page dans un document Word où une mise en forme personnalisée sera définie. Ensuite, la mise en forme du contenu du pied de page existant est mise à jour et les informations sur le numéro de page sont insérées en bas à droite. Toutes ces opérations seront effectuées dans le cloud.

Installation

Pour commencer, vous devez d’abord installer Visual Studio sur votre système. Créez un exemple de solution et ajoutez une référence NuGet de Aspose.Words Cloud SDK for .NET. Pour ajouter une référence, faites un clic droit sur la solution et sélectionnez l’option de menu Gérer les packages NuGet… . Saisissez Aspose.Words-Cloud dans le champ de recherche. Sélectionnez l’option et cliquez sur le bouton Ajouter un package.

La référence Aspose.Words.Cloud.Sdk apparaît désormais dans la solution. L’utilisation d’API cloud présente certains avantages par rapport aux API sur site (aspose.com).En effet, vous n’avez pas besoin de suivre et de mettre à jour manuellement les versions d’API et vous n’avez pas besoin de payer pour la licence complète.

Tableau de bord Aspose.Cloud

Créez simplement un compte sur le tableau de bord Aspose.Cloud ou inscrivez-vous via votre compte Google ou GitHub existant et commencez à utiliser nos API Cloud. Une autre fonctionnalité étonnante des API Cloud est que vous pouvez les utiliser sur n’importe quelle plateforme en utilisant n’importe quel langage pris en charge.

Comme indiqué ci-dessus, l’article met l’accent sur les options concernant l’ajout et la mise à jour des objets Header et Footer dans les documents MS Word. À des fins de test, nous avons utilisé un modèle de document MS Word existant portant le nom Business Letter. Le document doit être téléchargé sur le stockage cloud Aspose et toutes les manipulations et le traitement du document seront effectués sur le cloud. Une fois tout le traitement terminé, nous pouvons également télécharger la copie du fichier résultant à partir du stockage cloud.

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

Pour pouvoir utiliser les API Aspose.Cloud, vous devez utiliser les informations App Key et App SID dans votre code. Ces clés sont composées de chiffres alphanumériques. Il s’agit de codes uniques associés à votre compte d’abonnement. Pour obtenir ces détails, veuillez cliquer sur l’onglet Mes applications dans tableau de bord Aspose.Cloud. Une fois que nous avons les clés, nous devons initialiser l’objet API 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);

Insérer un objet d’en-tête

Afin d’ajouter l’objet d’en-tête dans le fichier MS Word, nous devons effectuer les opérations suivantes dans l’ordre.

  1. Créez un objet de InsertHeaderFooterRequest où nous passons le type HeaderFooterLink comme argument.
  2. Insérez l’objet HeaderFooterRequest dans l’objet WordsApi à l’aide de la méthode InsertHeaderFooter (…).
  3. Créez un objet Run qui contient des exemples d’informations textuelles.
  4. Créez un objet InsertRunRequest dans lequel nous transmettons la référence du paragraphe (SectionPath) dans l’objet HeaderFooter, où le texte d’exécution doit être ajouté.
    Appelez ensuite la méthode InsertRun (…) de WordsApi, qui ajoute RunRequest à l’objet HeaderFooter.

HeaderFooter.TypeEnum peut avoir l’une des valeurs suivantes.

string MyAppKey = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// créer un objet de WordsAPI tout en transmettant les informations AppKey et AppSid
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// télécharger un exemple de document sur le stockage cloud
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// Insérer un objet d'en-tête sur la première page
var putHeaderFooterRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.InsertHeaderFooterRequest("BusinessLetter.docx", "HeaderFirst", null,null);  
var actual = wordsApi.InsertHeaderFooter(putHeaderFooterRequest);
// Créer un objet Run contenant un exemple de texte
var run = new Run { Text = "Aspose.Words Cloud SDK for .NET " };
// ajoutez le texte d'exécution au premier paragraphe du premier objet HeaderFooter dans la première section du document Word
var runRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.InsertRunRequest("BusinessLetter.docx", "sections/0/headersfooters/1/paragraphs/0", run);
// Insérer la RunRequest dans le document Word
var actual2 = wordsApi.InsertRun(runRequest);
légende

Image showing preview of recently added Header

Mettre à jour la mise en forme du texte de l’en-tête nouvellement inséré

Une fois l’objet Header ajouté, nous pouvons mettre à jour la mise en forme du texte du contenu qu’il contient. Afin de répondre à cette exigence, nous devons effectuer les étapes suivantes.

  1. Créez un objet de classe Font, où nous spécifions le nom de la police, la taille et les informations de couleur.
  2. Afin de rendre le texte plus présentable, marquez la propriété Engrave comme True.
  3. Créez un objet de classe UpdateRunFontRequest où nous transmettons le fichier d’entrée, Font, SectionPath et runIndex comme argument.
  4. Enfin, utilisez la méthode UpdateRunFont(..) et ajoutez l’objet UpdateRunFontRequest à l’instance 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/
// créer un objet de WordsAPI tout en transmettant les informations AppKey et AppSid
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// télécharger un exemple de document sur le stockage cloud
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// L'étape suivante consiste à définir la mise en forme de l'objet d'en-tête
var runIndex = 0;
var fontDto = new Font { Bold = true, Name = "Verdana", Size = 16, Color = new XmlColor { Web = "#e0a50d" } };
//  Définir la mise en forme du texte sur Gravure
fontDto.Engrave = true;
// Appliquer la mise en forme au premier paragraphe de l'objet 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);
légende

Image showing preview of Header after text formatting has been applied.

Mettre à jour la mise en forme de l’objet de pied de page existant

L’API offre également la possibilité de mettre à jour la mise en forme du contenu à l’intérieur de l’objet Header/Foter existant. Afin de répondre à cette exigence, nous pouvons utiliser les lignes de code spécifiées ci-dessus, mais la seule différence est le changement de l’index headerfooter à 2. Voir la ligne de code suivante.

// 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);
légende

Image displaying the change in Footer text formatting.

Ajouter des informations sur le numéro de page dans la section pied de page

Les numéros de page fournissent des informations très utiles telles que la page actuelle et le nombre total de pages d’un document. Les étapes suivantes définissent comment répondre aux exigences.

  1. Créez d’abord un objet de classe PageNumber, où nous définissons l’alignement du texte, le format du texte, l’emplacement pour restituer les informations PageNumber et également, spécifions si PageNumber doit être rendu sur la première page ou non.
  2. Créez un objet InsertPageNumbersRequest et transmettez l’objet PageNumber comme argument.
  3. Enfin, appelez la méthode InsertPageNumbers(..) pour ajouter InsertPageNumbersRequest à l’instance 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/
// créer un objet de WordsAPI tout en transmettant les informations AppKey et AppSid
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// télécharger un exemple de document sur le stockage cloud
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// L'API offre également la possibilité d'ajouter des détails sur le numéro de page dans l'objet HeaderFooter
// Ajoutez les informations sur le numéro de page en bas à droite de la page
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);
// Insérer les informations de numéro de page dans le document Word
var actual6 = wordsApi.InsertPageNumbers(insertPageNumbersRequest);
légende

Preview Page number in the footer section.

Conclusion

Dans cet article, nous avons appris les étapes à suivre pour ajouter un en-tête et un pied de page dans un document Word à l’aide de Aspose.Words Cloud SDK pour .NET. Veuillez noter que nous avons également des SDK Cloud disponibles pour Java, PHP, Ruby, Python, Go, Swift, C++, Node.Js, Android. Pour plus de détails, veuillez consulter Aspose.Words Cloud.

Articles connexes

Nous vous recommandons également de visiter les sites suivants pour en savoir plus sur