Anotar Documentos do Word

Adicionar comentários a documentos do Word usando C# .NET

Anotar um documento é uma parte essencial da colaboração e comunicação em muitos setores. Ele permite que os usuários forneçam feedback, sugestões e comentários sobre um documento que pode ser facilmente compartilhado com outras pessoas. Embora o Microsoft Word ofereça várias ferramentas de anotação, como comentários, controle de alterações e adição de notas, para ajudar os usuários a fornecer feedback e colaborar em um documento. No entanto, nesta postagem do blog, exploraremos como anotar documentos do Word usando o .NET Cloud SDK, tornando mais fácil para os usuários se comunicarem e colaborar em documentos.

API REST para adicionar comentários do Word

Usando Aspose.Words Cloud SDK para .NET, você pode facilmente adicionar comentários, respostas e anotações a um documento do Word programaticamente usando a linguagem C#. O SDK fornece um conjunto abrangente de APIs REST para manipulação de documentos do Word e suporta todos os principais formatos de documentos, incluindo DOC, DOCX, [RTF](https ://docs.fileformat.com/word-processing/rtf/) e muito mais. Agora, com a ajuda deste SDK, você pode aprimorar seu fluxo de trabalho e processo de colaboração adicionando anotações, comentários e outros elementos de revisão de maneira fácil e eficiente aos seus documentos do Word.

Para usar o SDK, pesquise Aspose.Words-Cloud no gerenciador de pacotes NuGet e clique no botão Add Package para adicionar a referência do SDK no projeto .NET.

Observação: para acessar a API REST, você precisa se registrar e obter suas credenciais pessoais. Consulte o guia Início rápido para obter informações relacionadas.

Adicionar anotação de documento do Word usando C#

Tente usar o trecho de código a seguir para adicionar anotação de documento do Word usando o .NET Cloud SDK.

// Para exemplos completos e arquivos de dados, acesse 
https://github.com/aspose-words-cloud/aspose-words-cloud-dotnet

// Obtenha as credenciais do cliente em https://dashboard.aspose.cloud/
string clientSecret = "7f098199230fc5f2175d494d48f2077c";
string clientID = "ee170169-ca49-49a4-87b7-0e2ff815ea6e";

// criar objeto de configuração usando ClinetID e detalhes do segredo do cliente
var config = new Aspose.Words.Cloud.Sdk.Configuration { ClientId = clientID, ClientSecret = clientSecret };
// inicializar a instância WordsApi
var wordsApi = new WordsApi(config);

string firstDocument = "input-sample-1.docx";
// leia o conteúdo do primeiro documento do Word da unidade local
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)
{
    // qualquer exceção durante o processo de anotação do documento
    Console.Write(ex);
}
visualização da anotação do documento do word

Imagem:- Visualização da anotação do documento do Word usando a 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);

Crie um objeto de WordsApi usando credenciais de cliente personalizadas.

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

Leia o conteúdo do documento do Word de entrada na unidade local.

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

Crie um objeto de NodeLink definindo NodeId para anotação. Repita esse processo para as instâncias CommentRangeStartNode e CommentRangeEndNode.

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

Crie uma instância de CommentInsert onde especificamos os detalhes como iniciais, nome do autor e o conteúdo do comentário/anotação.

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

Agora crie um objeto de InsertCommentOnlineRequest onde passamos o conteúdo do documento do Word de entrada, o objeto CommentInsert e o nome do documento do Word resultante.

 var response = wordsApi.InsertCommentOnline(insertRequest);

Por fim, chame o método InsertCommentOnline(…) para inserir um comentário em um documento do Word no nó especificado.

Os arquivos de amostra usados no exemplo acima podem ser baixados de input-sample-1.docx e Commented.docx.

Adicionar comentários ao documento do Word usando comandos cURL

Entendemos que adicionar anotações ou comentários a documentos do Word usando comandos cURL pode ser altamente benéfico, pois fornece uma maneira programática de adicionar anotações em massa ou permite integrar a funcionalidade em seus fluxos de trabalho existentes. Com a ajuda da API do Aspose.Words Cloud e dos comandos cURL, adicionar comentários a um documento do Word pode ser feito por meio de uma série de chamadas de API. Isso envolve o envio de solicitações à API do Aspose.Words Cloud com os parâmetros apropriados, como o arquivo do documento, localização, texto e informações do autor, para criar um comentário.

A primeira etapa é obter um accessToken enviando uma solicitação POST com o SID do aplicativo e os detalhes da chave do aplicativo. Por favor, execute o seguinte comando:

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"

Assim que tivermos o accessToken, execute o seguinte comando para inserir uma anotação no documento do 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 ....\"}"

Substitua {inputWordFile} pelo nome do documento do Word de entrada (já disponível no armazenamento em nuvem), {accessToken} pelo token de acesso JWT gerado acima e {resultantFile} pelo nome do documento do Word resultante contendo a nova anotação .

Conclusão

Em conclusão, adicionar anotações e comentários a documentos do Word pode ser um recurso útil para edição e revisão colaborativa. Com a ajuda dos comandos Aspose.Words Cloud e cURL ou o Aspose.Words Cloud SDK para .NET, essa tarefa pode ser realizada de forma eficiente e eficaz. Quer você prefira usar a solução baseada em nuvem ou o SDK, o Aspose.Words fornece uma ferramenta poderosa e confiável para anotar os documentos do Word. Esperamos que este tutorial tenha sido útil para orientá-lo no processo e tenha fornecido todos os detalhes necessários para começar.

Artigos relacionados

É altamente recomendável visitar os seguintes blogs: