Удалить комментарии всех или определенного автора в документе обработки текста

В этом разделе показано, как использовать классы в пакете SDK Open XML для Office для программного удаления комментариев всех или определенных авторов в текстовом документе без необходимости загружать документ в microsoft Word. Он содержит пример DeleteComments метода для иллюстрации этой задачи.

---

Метод DeleteComments

Метод можно использовать для DeleteComments удаления всех комментариев из текстового документа или только тех, которые написаны определенным автором. Как показано в следующем коде, этот метод принимает два параметра, задающие имя изменяемого документа (строковый параметр) и, дополнительно, имя автора, чьи комментарии требуется удалить (строковый параметр). Если предоставить имя автора, код удаляет комментарии, написанные заданным автором. Если не предоставить имя автора, код удаляет все комментарии.

C#

// Delete comments by a specific author. Pass an empty string for the 
// author to delete all comments, by all authors.
static void DeleteComments(string fileName, string author = "")

Visual Basic

' Delete comments by a specific author. Pass an empty string for the author 
' to delete all comments, by all authors.
Public Sub DeleteComments(ByVal fileName As String, Optional ByVal author As String = "")

---

Вызов метода DeleteComments

Чтобы вызвать DeleteComments метод, укажите необходимые параметры, как показано в следующем коде.

C#

if (args is [{ } fileName, { } author])
{
    DeleteComments(fileName, author);
}
else if (args is [{ } fileName2])
{
    DeleteComments(fileName2);
}

Visual Basic

If (args.Length >= 2) Then
    Dim fileName As String = args(0)
    Dim author As String = args(1)

    DeleteComments(fileName, author)
ElseIf args.Length = 1 Then
    Dim fileName As String = args(0)

    DeleteComments(fileName)
End If

---

Принципы работы кода

Следующий код начинается с открытия документа с помощью WordprocessingDocument.Open метода и указания, что документ должен быть открыт для чтения и записи (конечное true значение параметра). Затем код извлекает ссылку на часть комментариев, используя WordprocessingCommentsPart свойство main части документа, после получения ссылки на часть документа main из MainDocumentPart свойства текстового документа. Если часть комментариев отсутствует, продолжение не имеет смысла, так как нет комментариев (и удалять нечего).

C#

// Get an existing Wordprocessing document.
using (WordprocessingDocument document = WordprocessingDocument.Open(fileName, true))
{

    if (document.MainDocumentPart is null)
    {
        throw new ArgumentNullException("MainDocumentPart is null.");
    }

    // Set commentPart to the document WordprocessingCommentsPart, 
    // if it exists.
    WordprocessingCommentsPart? commentPart = document.MainDocumentPart.WordprocessingCommentsPart;

    // If no WordprocessingCommentsPart exists, there can be no 
    // comments. Stop execution and return from the method.
    if (commentPart is null)
    {
        return;
    }

Visual Basic

' Get an existing Wordprocessing document.
Using document As WordprocessingDocument = WordprocessingDocument.Open(fileName, True)
    ' Set commentPart to the document 
    ' WordprocessingCommentsPart, if it exists.
    Dim commentPart As WordprocessingCommentsPart = document.MainDocumentPart.WordprocessingCommentsPart

    ' If no WordprocessingCommentsPart exists, there can be no
    ' comments. Stop execution and return from the method.
    If (commentPart Is Nothing) Then
        Return
    End If

---

Создание списка комментариев

Далее код выполняет две задачи: создание списка всех удаляемых комментариев и создание списка идентификаторов комментариев, соответствующих удаляемой примечания. Учитывая эти списки, код может как удалить комментарии из части примечаний, содержащей примечания, так и ссылки на комментарии из части документа. Следующий код начинается с получения списка Comment элементов. Чтобы получить список, он преобразует коллекцию Elements() , предоставленную переменной, commentPart в список Comment объектов.

C#

List<Comment> commentsToDelete = commentPart.Comments.Elements<Comment>().ToList();

Visual Basic

Dim commentsToDelete As List(Of Comment) = commentPart.Comments.Elements(Of Comment)().ToList()

Пока что список комментариев содержит все комментарии. Если параметр author не является пустой строкой, следующий код ограничивает список только теми комментариями, где Author свойство соответствует указанному параметру.

C#

if (!String.IsNullOrEmpty(author))
{
    commentsToDelete = commentsToDelete.Where(c => c.Author == author).ToList();
}

Visual Basic

If Not String.IsNullOrEmpty(author) Then
    commentsToDelete = commentsToDelete.Where(Function(c) c.Author = author).ToList()
End If

Перед удалением комментариев код получает список со значениями идентификаторов (ID) комментариев, чтобы позже удалить совпадающие элементы из части документа. Вызов Select метода эффективно проецирует список примечаний, получая из IEnumerable<T> строк, содержащих все значения идентификатора комментария.

C#

IEnumerable<string?> commentIds = commentsToDelete.Where(r => r.Id is not null && r.Id.HasValue).Select(r => r.Id?.Value);

Visual Basic

Dim commentIds As IEnumerable(Of String) = commentsToDelete.Where(Function(r) r IsNot Nothing And r.Id.HasValue).Select(Function(r) r.Id.Value)

---

Удаление комментариев и сохранение части

Учитывая коллекцию commentsToDelete , следующий код циклически просматривает все комментарии, требующие удаления, и выполняет удаление.

C#

// Delete each comment in commentToDelete from the 
// Comments collection.
foreach (Comment c in commentsToDelete)
{
    if (c is not null)
    {
        c.Remove();
    }
}

Visual Basic

' Delete each comment in commentToDelete from the Comments 
' collection.
For Each c As Comment In commentsToDelete
    If (c IsNot Nothing) Then
        c.Remove()
    End If
Next

---

Удаление ссылок на комментарии из документа

Хотя код успешно удалил все комментарии к этому моменту, этого недостаточно. Код также должен удалить ссылки на примечания из части документа. Для этого действия требуется три шага, так как ссылка на комментарий включает CommentRangeStartэлементы , CommentRangeEndи CommentReference , а код должен удалить все три для каждого комментария. Перед удалением код сначала извлекает ссылку на корневой элемент части документа main, как показано в следующем коде.

C#

    Document doc = document.MainDocumentPart.Document;

Visual Basic

    Dim doc As Document = document.MainDocumentPart.Document

Имея ссылку на элемент документа, следующий код выполняет цикл удаления три раза: по одному разу для каждого из элементов, предназначенных для удаления. В каждом случае код ищет всех потомков правильного типа (CommentRangeStart, CommentRangeEndили CommentReference) и ограничивает список теми, чье Id значение свойства содержится в списке идентификаторов комментариев, которые необходимо удалить. Имея список удаляемых элементов, код удаляет каждый из них. Наконец, код завершает работу, сохраняя документ.

C#

// Delete CommentRangeStart for each
// deleted comment in the main document.
List<CommentRangeStart> commentRangeStartToDelete = doc.Descendants<CommentRangeStart>()
                                                    .Where(c => c.Id is not null && c.Id.HasValue && commentIds.Contains(c.Id.Value))
                                                    .ToList();

foreach (CommentRangeStart c in commentRangeStartToDelete)
{
    c.Remove();
}

// Delete CommentRangeEnd for each deleted comment in the main document.
List<CommentRangeEnd> commentRangeEndToDelete = doc.Descendants<CommentRangeEnd>()
                                                .Where(c => c.Id is not null && c.Id.HasValue && commentIds.Contains(c.Id.Value))
                                                .ToList();

foreach (CommentRangeEnd c in commentRangeEndToDelete)
{
    c.Remove();
}

// Delete CommentReference for each deleted comment in the main document.
List<CommentReference> commentRangeReferenceToDelete = doc.Descendants<CommentReference>()
                                                        .Where(c => c.Id is not null && c.Id.HasValue && commentIds.Contains(c.Id.Value))
                                                        .ToList();

foreach (CommentReference c in commentRangeReferenceToDelete)
{
    c.Remove();
}

Visual Basic

' Delete CommentRangeStart for each 
' deleted comment in the main document.
Dim commentRangeStartToDelete As List(Of CommentRangeStart) = doc.Descendants(Of CommentRangeStart).
                                                                Where(Function(c) commentIds.Contains(c.Id.Value)).
                                                                ToList()

For Each c As CommentRangeStart In commentRangeStartToDelete
    c.Remove()
Next

' Delete CommentRangeEnd for each deleted comment in main document.
Dim commentRangeEndToDelete As List(Of CommentRangeEnd) = doc.Descendants(Of CommentRangeEnd).
                                                            Where(Function(c) commentIds.Contains(c.Id.Value)).
                                                            ToList()

For Each c As CommentRangeEnd In commentRangeEndToDelete
    c.Remove()
Next

' Delete CommentReference for each deleted comment in the main document.
Dim commentRangeReferenceToDelete As List(Of CommentReference) = doc.Descendants(Of CommentReference).
                                                                    Where(Function(c) commentIds.Contains(c.Id.Value)).
                                                                    ToList()

For Each c As CommentReference In commentRangeReferenceToDelete
    c.Remove()
Next

---

Пример кода

Ниже приведен полный пример кода на C# и Visual Basic.

C#

using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
using System;
using System.Collections.Generic;
using System.Linq;


// Delete comments by a specific author. Pass an empty string for the 
// author to delete all comments, by all authors.
static void DeleteComments(string fileName, string author = "")
{
    // Get an existing Wordprocessing document.
    using (WordprocessingDocument document = WordprocessingDocument.Open(fileName, true))
    {

        if (document.MainDocumentPart is null)
        {
            throw new ArgumentNullException("MainDocumentPart is null.");
        }

        // Set commentPart to the document WordprocessingCommentsPart, 
        // if it exists.
        WordprocessingCommentsPart? commentPart = document.MainDocumentPart.WordprocessingCommentsPart;

        // If no WordprocessingCommentsPart exists, there can be no 
        // comments. Stop execution and return from the method.
        if (commentPart is null)
        {
            return;
        }

        // Create a list of comments by the specified author, or
        // if the author name is empty, all authors.
        List<Comment> commentsToDelete = commentPart.Comments.Elements<Comment>().ToList();

        if (!String.IsNullOrEmpty(author))
        {
            commentsToDelete = commentsToDelete.Where(c => c.Author == author).ToList();
        }

        IEnumerable<string?> commentIds = commentsToDelete.Where(r => r.Id is not null && r.Id.HasValue).Select(r => r.Id?.Value);

        // Delete each comment in commentToDelete from the 
        // Comments collection.
        foreach (Comment c in commentsToDelete)
        {
            if (c is not null)
            {
                c.Remove();
            }
        }

        Document doc = document.MainDocumentPart.Document;

        // Delete CommentRangeStart for each
        // deleted comment in the main document.
        List<CommentRangeStart> commentRangeStartToDelete = doc.Descendants<CommentRangeStart>()
                                                            .Where(c => c.Id is not null && c.Id.HasValue && commentIds.Contains(c.Id.Value))
                                                            .ToList();

        foreach (CommentRangeStart c in commentRangeStartToDelete)
        {
            c.Remove();
        }

        // Delete CommentRangeEnd for each deleted comment in the main document.
        List<CommentRangeEnd> commentRangeEndToDelete = doc.Descendants<CommentRangeEnd>()
                                                        .Where(c => c.Id is not null && c.Id.HasValue && commentIds.Contains(c.Id.Value))
                                                        .ToList();

        foreach (CommentRangeEnd c in commentRangeEndToDelete)
        {
            c.Remove();
        }

        // Delete CommentReference for each deleted comment in the main document.
        List<CommentReference> commentRangeReferenceToDelete = doc.Descendants<CommentReference>()
                                                                .Where(c => c.Id is not null && c.Id.HasValue && commentIds.Contains(c.Id.Value))
                                                                .ToList();

        foreach (CommentReference c in commentRangeReferenceToDelete)
        {
            c.Remove();
        }
    }
}

Visual Basic

Imports DocumentFormat.OpenXml.Packaging
Imports DocumentFormat.OpenXml.Wordprocessing

Module Program
    Sub Main(args As String())
        If (args.Length >= 2) Then
            Dim fileName As String = args(0)
            Dim author As String = args(1)

            DeleteComments(fileName, author)
        ElseIf args.Length = 1 Then
            Dim fileName As String = args(0)

            DeleteComments(fileName)
        End If
    End Sub


    ' Delete comments by a specific author. Pass an empty string for the author 
    ' to delete all comments, by all authors.
    Public Sub DeleteComments(ByVal fileName As String, Optional ByVal author As String = "")

        ' Get an existing Wordprocessing document.
        Using document As WordprocessingDocument = WordprocessingDocument.Open(fileName, True)
            ' Set commentPart to the document 
            ' WordprocessingCommentsPart, if it exists.
            Dim commentPart As WordprocessingCommentsPart = document.MainDocumentPart.WordprocessingCommentsPart

            ' If no WordprocessingCommentsPart exists, there can be no
            ' comments. Stop execution and return from the method.
            If (commentPart Is Nothing) Then
                Return
            End If

            ' Create a list of comments by the specified author, or
            ' if the author name is empty, all authors.
            Dim commentsToDelete As List(Of Comment) = commentPart.Comments.Elements(Of Comment)().ToList()

            If Not String.IsNullOrEmpty(author) Then
                commentsToDelete = commentsToDelete.Where(Function(c) c.Author = author).ToList()
            End If

            Dim commentIds As IEnumerable(Of String) = commentsToDelete.Where(Function(r) r IsNot Nothing And r.Id.HasValue).Select(Function(r) r.Id.Value)

            ' Delete each comment in commentToDelete from the Comments 
            ' collection.
            For Each c As Comment In commentsToDelete
                If (c IsNot Nothing) Then
                    c.Remove()
                End If
            Next

            Dim doc As Document = document.MainDocumentPart.Document

            ' Delete CommentRangeStart for each 
            ' deleted comment in the main document.
            Dim commentRangeStartToDelete As List(Of CommentRangeStart) = doc.Descendants(Of CommentRangeStart).
                                                                            Where(Function(c) commentIds.Contains(c.Id.Value)).
                                                                            ToList()

            For Each c As CommentRangeStart In commentRangeStartToDelete
                c.Remove()
            Next

            ' Delete CommentRangeEnd for each deleted comment in main document.
            Dim commentRangeEndToDelete As List(Of CommentRangeEnd) = doc.Descendants(Of CommentRangeEnd).
                                                                        Where(Function(c) commentIds.Contains(c.Id.Value)).
                                                                        ToList()

            For Each c As CommentRangeEnd In commentRangeEndToDelete
                c.Remove()
            Next

            ' Delete CommentReference for each deleted comment in the main document.
            Dim commentRangeReferenceToDelete As List(Of CommentReference) = doc.Descendants(Of CommentReference).
                                                                                Where(Function(c) commentIds.Contains(c.Id.Value)).
                                                                                ToList()

            For Each c As CommentReference In commentRangeReferenceToDelete
                c.Remove()
            Next
        End Using
    End Sub
End Module

См. также

• Справочник по библиотеке классов пакета SDK Open XML