Dodawaj adnotacje do dokumentów programu Word

Dodawaj komentarze do dokumentów programu Word przy użyciu języka C# .NET

Dodawanie adnotacji do dokumentu jest istotną częścią współpracy i komunikacji w wielu branżach. Pozwala użytkownikom przekazywać opinie, sugestie i komentarze na temat dokumentu, który można łatwo udostępnić innym. Chociaż Microsoft Word oferuje kilka narzędzi do adnotacji, takich jak komentarze, śledzenie zmian i dodawanie notatek, aby pomóc użytkownikom w przekazywaniu opinii i współpracy nad dokumentem. Jednak w tym poście na blogu przyjrzymy się, jak dodawać adnotacje do dokumentów programu Word za pomocą pakietu .NET Cloud SDK, ułatwiając użytkownikom komunikację i współpracować nad dokumentami.

Interfejs API REST do dodawania komentarzy do programu Word

Używając Aspose.Words Cloud SDK for .NET, możesz łatwo dodawać komentarze, odpowiedzi i adnotacje do dokumentu Word programowo przy użyciu języka C#. SDK zapewnia kompleksowy zestaw interfejsów API REST do manipulacji dokumentami programu Word i obsługuje wszystkie główne formaty dokumentów, w tym DOC, DOCX, [RTF](https ://docs.fileformat.com/word-processing/rtf/) i nie tylko. Teraz za pomocą tego zestawu SDK możesz usprawnić przepływ pracy i proces współpracy, łatwo i wydajnie dodając adnotacje, komentarze i inne elementy recenzji do dokumentów programu Word.

Aby skorzystać z SDK, wyszukaj Aspose.Words-Cloud w menedżerze pakietów NuGet i kliknij przycisk Dodaj pakiet, aby dodać odniesienie do SDK w projekcie .NET.

Uwaga: aby uzyskać dostęp do REST API, musisz się zarejestrować i uzyskać osobiste dane uwierzytelniające. Zapoznaj się z przewodnikiem Szybki start, aby uzyskać powiązane informacje.

Dodaj adnotację do dokumentu Word za pomocą C#

Spróbuj użyć poniższego fragmentu kodu, aby dodać adnotację do dokumentu programu Word przy użyciu pakietu .NET Cloud SDK.

// Aby uzyskać pełne przykłady i pliki danych, przejdź do 
https://github.com/aspose-words-cloud/aspose-words-cloud-dotnet

// Uzyskaj poświadczenia klienta z https://dashboard.aspose.cloud/
string clientSecret = "7f098199230fc5f2175d494d48f2077c";
string clientID = "ee170169-ca49-49a4-87b7-0e2ff815ea6e";

// utwórz obiekt konfiguracyjny przy użyciu danych ClinetID i Client Secret
var config = new Aspose.Words.Cloud.Sdk.Configuration { ClientId = clientID, ClientSecret = clientSecret };
// zainicjuj instancję WordsApi
var wordsApi = new WordsApi(config);

string firstDocument = "input-sample-1.docx";
// odczytać zawartość pierwszego dokumentu programu Word z dysku lokalnego
var firstFile = System.IO.File.OpenRead(firstDocument);
try
{
    var requestCommentRangeStartNode = new NodeLink()
    {
        NodeId = "0.6.5.3"
    };
    var requestCommentRangeStart = new DocumentPosition()
    {
        Node = requestCommentRangeStartNode,
        Offset = 0
    };
    var requestCommentRangeEndNode = new NodeLink()
    {
        NodeId = "0.6.5.3"
    };
    var requestCommentRangeEnd = new DocumentPosition()
    {
        Node = requestCommentRangeEndNode,
        Offset = 0
    };
    var requestComment = new CommentInsert()
    {
        RangeStart = requestCommentRangeStart,
        RangeEnd = requestCommentRangeEnd,
        Initial = "NS",
        Author = "Nayyer Shahbaz",
        Text = "Second Revisions..."
    };

    var insertRequest = new InsertCommentOnlineRequest(firstFile, requestComment, destFileName: "Commented.docx");
    var response = wordsApi.InsertCommentOnline(insertRequest);
    
    if (response != null && response.Equals("OK"))
    {
        Console.WriteLine("Word Document Annotation added successfully!");
    }
}
catch(Exception ex)
{
    // wszelkie wyjątki podczas procesu adnotacji w dokumencie
    Console.Write(ex);
}
podgląd adnotacji dokumentu Word

Obraz: — Podgląd adnotacji dokumentu programu Word przy użyciu interfejsu API REST.

// create configuration object using ClientID and Client Secret details
var config = new Configuration { ClientId = clientID, ClientSecret = clientSecret };
// initialize WordsApi instance
var wordsApi = new WordsApi(config);

Utwórz obiekt WordsApi, korzystając ze spersonalizowanych poświadczeń klienta.

var firstFile = System.IO.File.OpenRead(firstDocument);

Przeczytaj zawartość wejściowego dokumentu Word z dysku lokalnego.

var requestCommentRangeStartNode = new NodeLink()
{
    NodeId = "0.6.5.3"
};

Utwórz obiekt NodeLink definiujący NodeId dla Annotation. Powtórz ten proces dla instancji CommentRangeStartNode i CommentRangeEndNode.

var requestComment = new CommentInsert()
{
    RangeStart = requestCommentRangeStart,
    RangeEnd = requestCommentRangeEnd,
    Initial = "NS",
    Author = "Nayyer Shahbaz",
    Text = "Second Revisions..."
};

Utwórz instancję CommentInsert, w której podajemy szczegóły, takie jak inicjały, nazwisko autora oraz treść komentarza/adnotacji.

var insertRequest = new InsertCommentOnlineRequest(firstFile, requestComment, destFileName: "Commented.docx");

Teraz utwórz obiekt InsertCommentOnlineRequest, w którym przekazujemy zawartość wejściowego dokumentu Word, obiekt CommentInsert oraz nazwę wynikowego dokumentu Word.

 var response = wordsApi.InsertCommentOnline(insertRequest);

Na koniec wywołaj metodę InsertCommentOnline(…), aby wstawić komentarz do dokumentu programu Word w określonym węźle.

Przykładowe pliki użyte w powyższym przykładzie można pobrać z input-sample-1.docx i Commented.docx.

Dodaj komentarze do dokumentu programu Word za pomocą poleceń cURL

Rozumiemy, że dodawanie adnotacji lub komentarzy do dokumentów programu Word za pomocą poleceń cURL może być bardzo korzystne, ponieważ zapewnia programistyczny sposób masowego dodawania adnotacji lub umożliwia zintegrowanie tej funkcji z istniejącymi przepływami pracy. Za pomocą poleceń Aspose.Words Cloud API i poleceń cURL dodawanie komentarzy do dokumentu programu Word można wykonać za pomocą serii wywołań API. Obejmuje to wysyłanie żądań do interfejsu API chmury Aspose.Words z odpowiednimi parametrami, takimi jak plik dokumentu, lokalizacja, tekst i informacje o autorze, w celu utworzenia komentarza.

Pierwszym krokiem jest uzyskanie accessToken przez wysłanie żądania POST ze szczegółami identyfikatora SID aplikacji i klucza aplikacji. Proszę wykonać następujące polecenie:

curl -v "https://api.aspose.cloud/connect/token" \
 -X POST \
 -d "grant_type=client_credentials&client_id=ee170169-ca49-49a4-87b7-0e2ff815ea6e&client_secret=7f098199230fc5f2175d494d48f2077c" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "Accept: application/json"

Gdy już mamy accessToken, wykonaj następujące polecenie, aby wstawić adnotację do dokumentu programu Word.

curl -v "https://api.aspose.cloud/v4.0/words/{inputWordFile}/comments?destFileName={resultantFile}&revisionAuthor=Nayyer%20Shahbaz" \
-X POST \
-H  "accept: application/json" \
-H  "Authorization: Bearer {accessToken}" \
-H  "Content-Type: application/json" \
-d "{  \"RangeStart\": {    \"Node\": {      \"link\": {        \"Href\":\"http://api.aspose.cloud/v4.0/words/input-sample-1.docx/sections/0/body/paragraphs/5/runs/2\",        \"Rel\": \"self\"      },      \"NodeId\": \"0.6.5.3\",\"Text\": \"dictum\",    },    \"Offset\": 0  },  \"RangeEnd\": {    \"Node\": {      \"link\": {        \"Href\": \"http://api.aspose.cloud/v4.0/words/input-sample-1.docx/sections/0/body/paragraphs/5/runs/2\",        \"Rel\": \"self\",      },      \"NodeId\": \"0.6.5.3\",\"Text\": \"dictum\",    },    \"Offset\": 0  },  \"Author\": \"Nayyer Shahbaz\",  \"Initial\": \"NS\",  \"DateTime\": \"2023-04-28T12:52:50.108Z\",  \"Text\": \"Second Revisions ....\"}"

Zastąp {inputWordFile} nazwą wejściowego dokumentu Word (dostępnego już w chmurze), {accessToken} wygenerowanym powyżej tokenem dostępu JWT, a {resultantFile} nazwą wynikowego dokumentu Word zawierającego nową adnotację .

Wniosek

Podsumowując, dodawanie adnotacji i komentarzy do dokumentów programu Word może być przydatną funkcją do wspólnego edytowania i recenzowania. Z pomocą poleceń Aspose.Words Cloud i cURL lub Aspose.Words Cloud SDK dla .NET zadanie to można wykonać wydajnie i skutecznie. Niezależnie od tego, czy wolisz korzystać z rozwiązania opartego na chmurze, czy z zestawu SDK, Aspose.Words zapewnia potężne i niezawodne narzędzie do dodawania adnotacji do dokumentów Word. Mamy nadzieję, że ten samouczek był pomocny w przeprowadzeniu Cię przez ten proces i dostarczył wszystkich niezbędnych informacji, aby rozpocząć.

Przydatne linki

Powiązane artykuły

Gorąco polecamy przejrzenie następujących blogów: