Bildunterschrift

A quick view of MS Word document transformation.

Eine Kopfzeile ist der obere Rand jeder Seite und eine Fußzeile ist der untere Rand jeder Seite. Kopf und Fußzeilen sind nützlich, um Informationen aufzunehmen, die Sie auf jeder Seite eines Dokuments anzeigen möchten, wie z. B. Ihren Namen, Daten, den Titel des Dokuments, Seitenzahlen oder Haftungsausschlüsse zu Dokumenten. Wenn Sie MS Word verwenden, können Sie Kopf und Fußzeilen basierend auf vordefinierten Layouts hinzufügen oder benutzerdefinierte Kopf und Fußzeilen hinzufügen. Die meisten integrierten Kopfzeilen enthalten Platzhaltertext und Sie können den Platzhaltertext entweder beibehalten oder durch Ihren eigenen Datenfeed ersetzen. Wenn Sie die Informationen im Kopf oder Fußzeilenabschnitt aktualisieren, wird der Inhalt im Hauptteil des Dokuments ausgegraut, was darauf hinweist, dass diese Objekte vollständig vom Rest des Seiteninhalts isoliert sind und die Operation, die Sie an diesen Objekten durchführen, auf diese Bereiche beschränkt ist. In diesem Artikel lernen wir die Schritte zum Hinzufügen oder Aktualisieren der Kopf und Fußzeile in Word Dokumenten mithilfe der REST-API.

Textverarbeitungs-API

Aspose.Words Cloud API bietet die Möglichkeit, MS Word Dateien aus dem Cloud-Speicher zu laden. Außerdem ermöglicht es dem Benutzer, die Eingabedatei direkt im Anforderungstext zu übergeben, und die API gibt die aktualisierte Datei im Antwortobjekt zurück. Es bietet die Funktionen zum Lesen, Hinzufügen, Aktualisieren oder Löschen bestimmter oder aller Kopf und Fußzeilenobjekte. Darüber hinaus können Sie auch angeben, dass für die erste Seite und für ungerade/gerade Seiten unterschiedliche Kopf-/Fußzeilen gerendert werden sollen.

Darüber hinaus können Sie mit der API Formatierungsinformationen wie Schriftart und Absatzeigenschaften für den Kopf-/Fußzeilentext festlegen. Sie haben auch die Möglichkeit, dynamische Seitenzahlen in den Kopf-/Fußzeilenabschnitt einzufügen. Zu guter Letzt können Sie Tabellenobjekte verwenden, um einen Teil des Kopf-/Fußzeilentexts am linken Rand und den anderen am rechten Rand auszurichten.

Geltungsbereich des Artikels

Unser Aspose.Words Cloud SDK für .NET ermöglicht Ihnen die schnelle und einfache Arbeit mit Aspose.Words Cloud REST APIs, da es viele grundlegende Details im Zusammenhang mit Anfragen und der Bearbeitung von Antworten übernimmt und Sie sich auf das Schreiben von Code konzentrieren können, der speziell auf Ihre Geschäftsanforderungen zugeschnitten ist. In diesem Artikel verwenden wir Aspose.Words Cloud SDK für .NET in Visual Studio für Mac. Dieser Beitrag definiert die Schritte zum Einfügen von Kopf und Fußzeilen in Word Dokumente, in denen die benutzerdefinierte Formatierung definiert wird. Anschließend wird die Formatierung des vorhandenen Fußzeileninhalts aktualisiert und die Seitennummerinformationen werden unten rechts eingefügt. Alle diese Vorgänge werden in der Cloud ausgeführt.

Installation

Um loszulegen, müssen Sie zunächst Visual Studio auf Ihrem System installieren. Erstellen Sie eine Beispiellösung und fügen Sie eine NuGet-Referenz von Aspose.Words Cloud SDK für .NET hinzu. Um eine Referenz hinzuzufügen, klicken Sie mit der rechten Maustaste auf die Lösung und wählen Sie die Menüoption „NuGet-Pakete verwalten…“. Geben Sie Aspose.Words-Cloud in das Suchtextfeld ein. Wählen Sie die Option aus und klicken Sie auf die Schaltfläche „Paket hinzufügen“.

Jetzt wird in der Lösung der Verweis auf Aspose.Words.Cloud.Sdk angezeigt. Die Verwendung von Cloud-APIs bietet im Gegensatz zu APIs vor Ort (aspose.com) einige Vorteile. Der Grund dafür ist, dass Sie die API-Versionen nicht manuell verfolgen und aktualisieren müssen und nicht für die gesamte Lizenz bezahlen müssen.

Aspose.Cloud Dashboard

Erstellen Sie einfach ein Konto auf dem Aspose.Cloud-Dashboard oder melden Sie sich über Ihr bestehendes Google oder GitHub-Konto an und beginnen Sie mit der Nutzung unserer Cloud-APIs. Ein weiteres erstaunliches Merkmal von Cloud-APIs ist, dass Sie sie auf jeder Plattform und in jeder unterstützten Sprache verwenden können.

Wie oben erwähnt, betont der Artikel Optionen zum Hinzufügen und Aktualisieren von Kopf und Fußzeilenobjekten in MS Word Dokumenten. Zu Testzwecken haben wir eine vorhandene MS Word Dokumentvorlage mit dem Namen „Geschäftsbrief“ verwendet. Das Dokument muss in den Aspose-Cloud-Speicher hochgeladen werden, und die gesamte Bearbeitung und Dokumentverarbeitung wird über die Cloud durchgeführt. Sobald die gesamte Verarbeitung abgeschlossen ist, können wir auch die resultierende Dateikopie aus dem Cloud-Speicher herunterladen.

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

Um nun Aspose.Cloud-APIs verwenden zu können, müssen Sie in Ihrem Code App-Schlüssel und App-SID-Informationen verwenden. Diese Schlüssel bestehen aus alphanumerischen Ziffern. Dies sind eindeutige Codes, die Ihrem Abonnementkonto zugeordnet sind. Um diese Details zu erhalten, klicken Sie bitte auf die Registerkarte „Meine Apps“ im Aspose.Cloud-Dashboard. Sobald wir die Schlüssel haben, müssen wir das Aspose.Words-API Objekt initialisieren.

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

Header Objekt einfügen

Um das Header Objekt in die MS Word-Datei einzufügen, müssen wir die folgenden Vorgänge nacheinander ausführen.

  1. Erstellen Sie ein Objekt von InsertHeaderFooterRequest, wobei wir den Typ HeaderFooterLink als Argument übergeben.
  2. Fügen Sie mit der Methode InsertHeaderFooter (…) ein HeaderFooterRequest Objekt in das WordsApi Objekt ein.
  3. Erstellen Sie ein Run Objekt, das Beispieltextinformationen enthält.
  4. Erstellen Sie ein InsertRunRequest Objekt, in dem wir die Referenz des Absatzes (SectionPath) im HeaderFooter Objekt übergeben, wo der Run-Text hinzugefügt werden muss.
    Rufen Sie dann die Methode InsertRun (…) von WordsApi auf, die die RunRequest zum HeaderFooter Objekt hinzufügt.

HeaderFooter.TypeEnum kann einen der folgenden Werte haben.

string MyAppKey = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// Erstellen Sie ein Objekt von WordsAPI, während Sie AppKey und AppSid-Informationen übergeben
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// Beispieldokument in den Cloud-Speicher hochladen
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// Kopfzeilenobjekt auf der ersten Seite einfügen
var putHeaderFooterRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.InsertHeaderFooterRequest("BusinessLetter.docx", "HeaderFirst", null,null);  
var actual = wordsApi.InsertHeaderFooter(putHeaderFooterRequest);
// Run Objekt mit Beispieltext erstellen
var run = new Run { Text = "Aspose.Words Cloud SDK for .NET " };
// Fügen Sie den Lauftext zum ersten Absatz des ersten HeaderFooter Objekts im ersten Abschnitt des Word Dokuments hinzu
var runRequest = new Aspose.Words.Cloud.Sdk.Model.Requests.InsertRunRequest("BusinessLetter.docx", "sections/0/headersfooters/1/paragraphs/0", run);
// Fügen Sie den RunRequest in ein Word Dokument ein
var actual2 = wordsApi.InsertRun(runRequest);
Bildunterschrift

Image showing preview of recently added Header

Textformatierung der neu eingefügten Kopfzeile aktualisieren

Sobald das Header Objekt hinzugefügt wurde, können wir die Textformatierung des darin enthaltenen Inhalts aktualisieren. Um diese Anforderung zu erfüllen, müssen wir die folgenden Schritte ausführen.

  1. Erstellen Sie ein Objekt der Schriftartklasse, in dem wir den Schriftnamen, die Größe und die Farbinformationen angeben.
  2. Um den Text ansprechender zu gestalten, markieren Sie die Eigenschaft „Gravieren“ als „True“.
  3. Erstellen Sie ein Objekt der Klasse UpdateRunFontRequest, an das wir die Eingabedatei, Schriftart, Abschnittspfad und RunIndex als Argument übergeben.
  4. Verwenden Sie abschließend die Methode UpdateRunFont(..) und fügen Sie der WordsApi-Instanz das Objekt UpdateRunFontRequest hinzu.
string MyAppKey = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// Erstellen Sie ein Objekt von WordsAPI, während Sie AppKey und AppSid-Informationen übergeben
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// Beispieldokument in den Cloud-Speicher hochladen
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// Der nächste Schritt besteht darin, die Formatierung des Header Objekts festzulegen
var runIndex = 0;
var fontDto = new Font { Bold = true, Name = "Verdana", Size = 16, Color = new XmlColor { Web = "#e0a50d" } };
//  Formatierung des Textes als Gravieren festlegen
fontDto.Engrave = true;
// Formatierung auf den ersten Absatz des HeaderFooter Objekts anwenden
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);
Bildunterschrift

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

Die API bietet auch die Möglichkeit, die Formatierung des Inhalts innerhalb des vorhandenen Header-/Footer Objekts zu aktualisieren. Um diese Anforderung zu erfüllen, können wir die oben angegebenen Codezeilen verwenden, aber der einzige Unterschied besteht in der Änderung des Header-/Footer-Index auf 2. Siehe die folgende Codezeile.

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

Image displaying the change in Footer text formatting.

Seitenzahlinformationen im Fußzeilenabschnitt hinzufügen

Seitenzahlen liefern sehr nützliche Informationen, beispielsweise die aktuelle Seite und die Gesamtseitenzahl eines Dokuments. Die folgenden Schritte definieren, wie die Anforderungen erfüllt werden.

  1. Erstellen Sie zunächst ein Objekt der Klasse PageNumber, in dem wir die Ausrichtung und das Format des Textes sowie den Speicherort für die Darstellung der PageNumber-Informationen definieren und außerdem angeben, ob die PageNumber auf der ersten Seite dargestellt werden soll oder nicht.
  2. Erstellen Sie ein InsertPageNumbersRequest Objekt und übergeben Sie das PageNumber Objekt als Argument.
  3. Rufen Sie abschließend die Methode InsertPageNumbers(..) auf, um InsertPageNumbersRequest zur WordsApi-Instanz hinzuzufügen.
string MyAppKey = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/
string MyAppSid = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
// Erstellen Sie ein Objekt von WordsAPI, während Sie AppKey und AppSid-Informationen übergeben
WordsApi wordsApi = new WordsApi(MyAppKey, MyAppSid);

// Beispieldokument in den Cloud-Speicher hochladen
wordsApi.UploadFile(new UploadFileRequest(new System.IO.FileStream("/Users/nayyershahbaz/Documents/BusinessLetter.docx", 
    FileMode.Open, FileAccess.Read), "BusinessLetter.docx"));

// Die API bietet auch die Möglichkeit, Seitenzahlendetails im HeaderFooter Objekt hinzuzufügen.
// Fügen Sie unten rechts auf der Seite Informationen zur Seitenzahl hinzu
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);
// Seitenzahlinformationen in Word Dokument einfügen
var actual6 = wordsApi.InsertPageNumbers(insertPageNumbersRequest);
Bildunterschrift

Preview Page number in the footer section.

Abschluss

In diesem Artikel haben wir die Schritte zum Hinzufügen einer Kopf und Fußzeile in einem Word Dokument mit Aspose.Words Cloud SDK für .NET gelernt. Bitte beachten Sie, dass wir auch Cloud SDKs für Java, PHP, Ruby, Python, Go, Swift, C++, Node.Js, Android zur Verfügung haben. Weitere Einzelheiten finden Sie unter Aspose.Words Cloud.

Verwandte Artikel

Wir empfehlen Ihnen außerdem, die folgenden Seiten zu besuchen, um mehr zu erfahren über