Trabalhar com comentários

Aspose.Words permite que os usuários trabalhem com comentários-os comentários em um documento em Aspose.Words são representados pela classe Comment. Use também as classes CommentRangeStart e CommentRangeEnd para especificar a região do texto que deve ser associada a um comentário.

Adicionar um comentário

Aspose.Words permite adicionar comentários de várias maneiras:

  1. Usando a classe Comment
  2. Usando as classes CommentRangeStart e CommentRangeEnd

O exemplo de código a seguir mostra como adicionar um comentário a um parágrafo usando a classe Comment:

O exemplo de código a seguir mostra como adicionar um comentário a um parágrafo usando uma região de texto e as classes CommentRangeStart e CommentRangeEnd:

Extrair ou remover comentários

O uso de comentários em um documento do Word (além de rastrear alterações) é uma prática comum ao revisar documentos, especialmente quando há vários revisores. Pode haver situações em que a única coisa que você precisa de um documento são os comentários. Digamos que você queira gerar uma lista de resultados de revisão, ou talvez tenha coletado todas as informações úteis do documento e simplesmente queira remover comentários desnecessários. Você pode querer ver ou remover os comentários de um revisor específico.

Nesta amostra, vamos analisar alguns métodos simples para recolher informações dos comentários de um documento e para remover comentários de um documento. Especificamente, abordaremos como:

  • Extraia todos os comentários de um documento ou apenas os feitos por um determinado autor.
  • Remova todos os comentários de um documento ou apenas de um autor específico.

Como extrair ou remover comentários

O código desta amostra é, na verdade, bastante simples e todos os métodos baseiam-se na mesma abordagem. Um comentário em um documento do Word é representado por um objeto Comment no modelo de objeto de Documento Aspose.Words. Para recolher todos os comentários num documento, utilize o método GetChildNodes com o primeiro parâmetro definido como NodeType.Comment. Certifique-se de que o segundo parâmetro do método GetChildNodes esteja definido como true: isso força o GetChildNodes a selecionar recursivamente de todos os nós filhos, em vez de coletar apenas os filhos imediatos.

Para ilustrar como extrair e remover comentários de um documento, seguiremos as seguintes etapas:

  1. Abrir um documento do Word utilizando a classe Document
  2. Obter todos os comentários do documento em uma coleção
  3. Para extrair comentários:
    1. Percorrer a recolha utilizando o operador foreach
    2. Extrair e listar o nome do autor, data e hora e o texto de todos os comentários
    3. Extrair e listar o nome do autor, a data e a hora e o texto dos comentários escritos por um autor específico, neste caso, o autor ‘ks’
  4. Para remover comentários:
    1. Retroceda através da recolha utilizando o for the operator
    2. Remover comentários
  5. Salve as alterações

Como extrair todos os comentários

O método GetChildNodes é muito útil e você pode usá-lo sempre que precisar obter uma lista de nós de documentos de qualquer tipo. A coleção resultante não cria uma sobrecarga imediata porque os nós são selecionados nessa coleção somente quando você enumera ou acessa itens nela.

O exemplo de código a seguir mostra como extrair o nome do autor, data e hora e o texto de todos os comentários no documento:

Como extrair Comentários de um autor especificado

Depois de selecionar os nós de comentário em uma coleção, tudo o que você precisa fazer é extrair as informações necessárias. Neste exemplo, as iniciais do autor, a data, a hora e o texto simples do comentário são combinados numa cadeia de caracteres; em vez disso, pode optar por armazená-lo de outras formas.

O método sobrecarregado que extrai os comentários de um determinado autor é quase o mesmo, apenas verifica o nome do autor antes de adicionar as informações ao array.

O exemplo de código a seguir mostra como extrair o nome do autor, a data e a hora e o texto dos comentários do autor especificado:

Como remover comentários

Se você estiver removendo todos os comentários, não há necessidade de percorrer a coleção excluindo Comentários um por um; você pode removê-los chamando NodeCollection.Clear na coleção de comentários.

O exemplo de código a seguir mostra como remover todos os comentários no documento:

Quando você precisa remover seletivamente comentários, o processo se torna mais semelhante ao código que usamos para a extração de comentários.

O exemplo de código a seguir mostra como remover comentários do autor especificado:

O principal ponto a destacar aqui é a utilização do operador for. Ao contrário da extração simples, aqui você deseja excluir um comentário. Um truque adequado é iterar a coleção para trás do último comentário para o primeiro. A razão para isso se você começar do final e retroceder, o índice dos itens anteriores permanece inalterado e você pode voltar ao primeiro item da coleção.

O exemplo de código a seguir mostra os métodos para a extração e remoção de comentários:

Como remover um comentário entre CommentRangeStart e CommentRangeEnd

Usando Aspose.Words Você também pode remover comentários entre os nós CommentRangeStart e CommentRangeEnd.

O exemplo de código a seguir mostra como remover texto entre CommentRangeStart e CommentRangeEnd:

Adicionar e remover a resposta do comentário

O método AddReply adiciona uma resposta a este comentário. Observe que, devido às limitações existentes do Microsoft Office, apenas o nível de respostas 1 é permitido no documento. Uma exceção do tipo InvalidOperationException será levantada se este método for chamado no Comentário de resposta existente.

Você pode usar o método RemoveReply para remover a resposta especificada a este comentário.

O exemplo de código a seguir mostra como adicionar uma resposta ao comentário e remover a resposta do comentário:

Ler a resposta do comentário

A propriedade Replies retorna uma coleção dos objetos Comment que são filhos imediatos do comentário especificado.

O exemplo de código a seguir mostra como iterar as respostas de um comentário e resolvê-las: