Das Hinzufügen schneller Kommentare direkt zu Word‑Dokumenten ist ein häufiges Bedürfnis für kollaborative Überprüfungs‑Workflows. GroupDocs.Annotation Cloud SDK for Node.JS ermöglicht es Ihnen, programmgesteuert reichhaltige Anmerkungen hinzuzufügen, ohne Ihre Serverumgebung zu verlassen. In diesem Leitfaden zeigen wir Ihnen, wie Sie in Node.JS Sticky Notes auf Word‑Seiten erstellen, einschließlich Einrichtung, einer detaillierten Schritt‑für‑Schritt‑Anleitung, einem vollständigen Codebeispiel und entsprechenden cURL‑Aufrufen.

Einrichten von GroupDocs.Annotation Cloud SDK für Node.JS

Bevor Sie beginnen, stellen Sie sicher, dass Sie Folgendes haben:

  • Node.js 14+ und npm installiert
  • Ein GroupDocs cloud‑Konto mit clientId und clientSecret
  • Zugriff auf die Quell‑DOCX‑Datei, die Sie annotieren möchten

Installieren Sie das SDK über npm:

npm install groupdocs-annotation-cloud

Laden Sie das neueste Paket von der offiziellen Release‑Seite herunter, wenn Sie eine manuelle Installation bevorzugen: GroupDocs.Annotation Cloud SDK for Node.JS Download.

Erstellen Sie ein Konfigurationsobjekt mit Ihren Anmeldeinformationen (Auszug aus dem vollständigen Beispiel):

const { Configuration } = require("@groupdocs.annotation-cloud");

const config = new Configuration({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET"
});

Mit dem installierten SDK und den bereitstehenden Anmeldeinformationen können wir mit der Implementierung fortfahren.

Erstellen von Haftnotizen auf Word‑Seiten in Node.JS: Schritt‑für‑Schritt‑Anleitung

In diesem Leitfaden erstellen wir Sticky Notes auf Word‑Seiten in Node.JS mithilfe der Annotation‑Klassen des SDK.

Schritt 1: Initialisieren der Annotation-API

Zuerst importieren Sie die erforderlichen Klassen und erstellen eine Instanz von AnnotateApi.

const { AnnotateApi, models } = require("@groupdocs.annotation-cloud");
const annotateApi = new AnnotateApi(config);

Schritt 2: Quell- und Zieldateien definieren

Geben Sie das Eingabe‑DOCX und den Pfad für die annotierte Ausgabe an.

const inputFilePath = "sample.docx";
const outputFilePath = "sample_annotated.docx";

const fileInfo = new models.FileInfo();
fileInfo.filePath = inputFilePath;

Schritt 3: Position der Haftnotiz festlegen

Erstellen Sie ein Rechteck, das bestimmt, wo die Haftnotiz auf Seite 1 angezeigt wird.

const rect = new models.Rectangle();
rect.x = 100;      // distance from left edge (points)
rect.y = 100;      // distance from top edge (points)
rect.width = 200;  // width of the sticky note
rect.height = 100; // height of the sticky note

Schritt 4: Erstellen Sie das Sticky-Note-Anmerkungsobjekt

Konfigurieren Sie den Anmerkungstyp, die Seitennummer, das Rechteck, den Text und die Hintergrundfarbe.

const stickyNote = new models.AnnotationInfo();
stickyNote.annotationType = "StickyNote";
stickyNote.pageNumber = 1;
stickyNote.rect = rect;
stickyNote.text = "This is a sticky note added via GroupDocs.Annotation Cloud SDK.";
stickyNote.color = "FFFF00"; // Yellow background

Schritt 5: Ausführen der Annotationsanforderung

Stellen Sie die Anforderungsoptionen zusammen und rufen Sie die annotate‑Methode auf.

const annotateOptions = new models.AnnotateOptions();
annotateOptions.fileInfo = fileInfo;
annotateOptions.annotations = [stickyNote];
annotateOptions.outputPath = outputFilePath;

(async () => {
    try {
        const request = new models.AnnotateRequest(annotateOptions);
        const response = await annotateApi.annotate(request);
        console.log("Sticky note created successfully. Output saved to:", response.path);
    } catch (err) {
        console.error("Failed to create sticky note:", err);
    }
})();

Vollständiges funktionierendes Beispiel zum Erstellen von Haftnotizen auf Word‑Seiten in Node.JS

Das folgende Beispiel demonstriert die vollständige Implementierung zum Erstellen von Haftnotizen auf Word‑Seiten in Node.JS mit dem GroupDocs.Annotation Cloud SDK.

const { AnnotateApi, Configuration, models } = require("@groupdocs.annotation-cloud");

// -----------------------------------------------------------------------------
// Configuration – replace with your actual GroupDocs credentials
// -----------------------------------------------------------------------------
const config = new Configuration({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET"
});

const annotateApi = new AnnotateApi(config);

// -----------------------------------------------------------------------------
// Define input and output files
// -----------------------------------------------------------------------------
const inputFilePath = "sample.docx";
const outputFilePath = "sample_annotated.docx";

// -----------------------------------------------------------------------------
// Build FileInfo object for the source document
// -----------------------------------------------------------------------------
const fileInfo = new models.FileInfo();
fileInfo.filePath = inputFilePath;

// -----------------------------------------------------------------------------
// Define rectangle (position & size) for the sticky note on page 1
// -----------------------------------------------------------------------------
const rect = new models.Rectangle();
rect.x = 100;      // distance from left edge (points)
rect.y = 100;      // distance from top edge (points)
rect.width = 200;  // width of the sticky note
rect.height = 100; // height of the sticky note

// -----------------------------------------------------------------------------
// Create the sticky‑note annotation
// -----------------------------------------------------------------------------
const stickyNote = new models.AnnotationInfo();
stickyNote.annotationType = "StickyNote";
stickyNote.pageNumber = 1;
stickyNote.rect = rect;
stickyNote.text = "This is a sticky note added via GroupDocs.Annotation Cloud SDK.";
stickyNote.color = "FFFF00"; // Yellow background

// -----------------------------------------------------------------------------
// Assemble the annotate request options
// -----------------------------------------------------------------------------
const annotateOptions = new models.AnnotateOptions();
annotateOptions.fileInfo = fileInfo;
annotateOptions.annotations = [stickyNote];
annotateOptions.outputPath = outputFilePath;

// -----------------------------------------------------------------------------
// Execute the request
// -----------------------------------------------------------------------------
(async () => {
    try {
        const request = new models.AnnotateRequest(annotateOptions);
        const response = await annotateApi.annotate(request);
        console.log("Sticky note created successfully. Output saved to:", response.path);
    } catch (err) {
        console.error("Failed to create sticky note:", err);
    }
})();

Hinweis: Dieses Codebeispiel demonstriert die Kernfunktionalität. Bevor Sie es in Ihrem Projekt verwenden, stellen Sie sicher, dass Sie alle Dateipfade und Konfigurationswerte an Ihre tatsächliche Umgebung anpassen, überprüfen Sie, dass alle erforderlichen Abhängigkeiten ordnungsgemäß installiert sind, und testen Sie gründlich in Ihrer Entwicklungsumgebung. Wenn Sie auf Probleme stoßen, lesen Sie bitte die offizielle Dokumentation oder wenden Sie sich an das Support-Team für Unterstützung.

Hinzufügen von Sticky-Note-Anmerkungen mit cURL und der REST-API

Die REST-API bietet dieselbe Funktionalität, ohne Code zu schreiben. Nachfolgend finden Sie die erforderlichen cURL-Aufrufe.

Zuerst ein Zugriffstoken erhalten:

curl -X POST "https://api.groupdocs.cloud/v2.0.0/auth/token" \
     -H "Content-Type: application/json" \
     -d '{"client_id":"YOUR_CLIENT_ID","client_secret":"YOUR_CLIENT_SECRET"}'

Laden Sie die Quell‑DOCX‑Datei hoch (ersetzen Sie YOUR_ACCESS_TOKEN durch das Token aus dem vorherigen Schritt):

curl -X PUT "https://api.groupdocs.cloud/v2.0.0/storage/file/sample.docx" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/octet-stream" \
     --data-binary @sample.docx

Erstellen Sie die Haftnotiz-Annotation:

curl -X POST "https://api.groupdocs.cloud/v2.0.0/annotation/annotate" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "fileInfo": { "filePath": "sample.docx" },
           "annotations": [
               {
                   "annotationType": "StickyNote",
                   "pageNumber": 1,
                   "rect": { "x": 100, "y": 100, "width": 200, "height": 100 },
                   "text": "This is a sticky note added via GroupDocs.Annotation Cloud SDK.",
                   "color": "FFFF00"
               }
           ],
           "outputPath": "sample_annotated.docx"
         }'

Laden Sie das kommentierte Dokument herunter:

curl -X GET "https://api.groupdocs.cloud/v2.0.0/storage/file/sample_annotated.docx?download=true" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -o sample_annotated.docx

Für weitere Details zu den Request-Payloads siehe die API-Referenz.

Konfigurieren von Annotationsoptionen für Haftnotizen

Das SDK stellt mehrere Eigenschaften bereit, mit denen Sie das Aussehen und Verhalten von Haftnotizen feinabstimmen können:

  • annotationType - muss auf "StickyNote" gesetzt werden (erforderlich).
  • pageNumber - die Seite, auf der die Notiz angezeigt wird.
  • rect - definiert die Position (x, y) und die Größe (width, height). Passen Sie diese Werte an, um die Platzierung zu steuern.
  • text - der Inhalt der Notiz.
  • color - Hintergrundfarbe im HEX-Format (z. B. "FFFF00" für Gelb).

Sie können optionale Felder wie author, fontFamily oder opacity über das AnnotationInfo‑Modell festlegen. Weitere Informationen finden Sie in der API‑Referenz für die vollständige Liste der konfigurierbaren Eigenschaften.

Fazit

Indem Sie den obigen Schritten folgen, wissen Sie jetzt, wie Sie Sticky Notes auf Word‑Seiten in Node.JS mit dem GroupDocs.Annotation Cloud SDK erstellen. Egal, ob Sie eine native Node.js‑Implementierung oder einen REST‑basierten cURL‑Workflow bevorzugen, das SDK bietet eine konsistente und zuverlässige Möglichkeit, DOCX‑Dateien programmgesteuert zu annotieren. Denken Sie daran, für den Produktionseinsatz eine gültige Lizenz zu verwenden; Sie können eine temporäre Lizenz von der Lizenzseite erhalten oder die Preisoptionen auf der Produktseite prüfen. Viel Spaß beim Annotieren!

FAQs

  • Wie kann ich in Node.JS mit dem GroupDocs.Annotation Cloud SDK Sticky Notes auf Word‑Seiten erstellen?
    Verwenden Sie die AnnotateApi, wie im Codebeispiel gezeigt. Das SDK übernimmt den Dateizugriff, das Erstellen von Anmerkungen und die automatische Generierung der Ausgabe.

  • Welche Dateiformate werden für Annotationen mit dem SDK unterstützt?
    Das SDK arbeitet mit DOCX, PDF, PPTX, XLSX, und vielen anderen gängigen Formaten. Siehe die vollständige Liste in der offiziellen Dokumentation.

  • Wie authentifiziere ich mich bei der Verwendung der REST-API für Sticky Notes?
    Erhalten Sie ein Zugriffstoken über den Endpunkt /auth/token mithilfe Ihrer Client-Anmeldeinformationen und fügen Sie das Token anschließend in den Header Authorization: Bearer für alle nachfolgenden Aufrufe ein. Detaillierte Schritte finden Sie in der API-Referenz.

  • Kann ich die Farbe oder Größe der Haftnotiz anpassen?
    Ja. Setzen Sie die color‑Eigenschaft auf einen HEX‑Wert und passen Sie die rect‑Abmessungen (width, height) an, um die Größe und Platzierung der Notiz zu steuern.

Mehr lesen