Java でプレゼンテーションのコメントを管理

概要

この記事では、Aspose.Slides for Java を使用してプレゼンテーションのコメントを管理する方法を説明します。主なコメント関連の型を紹介し、スライドへのコメントの追加、既存コメントへのアクセス、返信やモダンコメントの操作、プレゼンテーションからのコメントの削除方法を実演します。

例では、PowerPoint の一般的なレビューおよびコラボレーションシナリオ、たとえばコメントを著者に割り当てること、コメントのテキストやメタデータを読み取ること、返信チェーンを構築すること、選択したコメントまたはすべてのコメントを削除すること、を扱います。

PowerPoint では、コメントはスライド上の注釈として表示されます。コメントを選択すると、そのテキストと関連するディスカッションが表示されます。

プレゼンテーションを開くときにコメントを表示または非表示にするプレゼンテーションを開くときにコメントを表示または非表示にする.

なぜプレゼンテーションにコメントを追加するのか?

コメントは、プレゼンテーションをレビューする際にフィードバックを提供し、同僚と協働するために使用できます。

Aspose.Slides for Java は、コメント操作のために以下の API を提供します。

  • Presentation クラスは、プレゼンテーションのコメント著者へのアクセスを提供します。
  • ICommentCollection インターフェイスは、個々の著者に関連付けられたコメントを表します。
  • IComment インターフェイスは、コメントの情報(著者、作成時刻、位置、テキスト)を提供します。
  • CommentAuthor クラスは、著者の情報(名前、イニシャル、関連コメント)を提供します。

スライドコメントの追加

この例では、2 つのスライドを作成し、addAuthor を使用してコメント著者を登録します。addComment を使って各スライドに 1 つずつコメントを配置し、getSlideComments でその著者の最初のスライドのコメントを取得します。コンソールは最初のコメントのテキストを 2 回表示し、スライドと著者の両方からのアクセスを示し、保存されたプレゼンテーションには両方のコメントが含まれます。

import com.aspose.slides.IComment;
import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.ISlide;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;
import java.awt.geom.Point2D;
import java.util.Date;

Presentation presentation = new Presentation();
try {
    ISlide firstSlide = presentation.getSlides().get_Item(0);
    ISlide secondSlide = presentation.getSlides().addEmptySlide(presentation.getLayoutSlides().get_Item(0));

    ICommentAuthor author = presentation.getCommentAuthors().addAuthor("Jawad", "MF");
    Point2D.Float position = new Point2D.Float(0.2f, 0.2f);
    Date createdTime = new Date();

    author.getComments().addComment("Hello Jawad, this is a slide comment", firstSlide, position, createdTime);
    author.getComments().addComment("Hello Jawad, this is the second slide comment", secondSlide, position, createdTime);

    IComment[] comments = firstSlide.getSlideComments(author);
    if (comments.length > 0) {
        IComment firstComment = comments[0];
        System.out.println(firstComment.getText());

        String commentText = firstComment.getAuthor().getComments().get_Item(0).getText();
        System.out.println(commentText);
    }

    presentation.save("Comments_out.pptx", SaveFormat.Pptx);
} finally {
    presentation.dispose();
}

コメント著者の検索または作成

自動レビューが同じプレゼンテーションを繰り返し処理する場合、著者を追加する前に getCommentAuthors が返すコレクションを検索します。findByNameAndInitials は名前とイニシャルの両方が一致する著者の配列を返し、該当がなければ空の配列を返します。これに対し、findByName はイニシャルに関係なく名前だけで検索します。コレクションに既に存在する名前とイニシャルで addAuthor を呼び出すと例外がスローされます。

この例では、少なくとも 1 枚のスライドがあるプレゼンテーションファイルが必要です。2 回のパスそれぞれで、最初に一致した著者を再利用するか、結果が空の場合にのみ新規作成します。複数の一致がある場合は、他の著者を結合または削除せずに最初の配列要素を選択します。その後、選択した著者に対して addComment を呼び出し、プレゼンテーションを保存します。2 回目のパスは 1 回目の出力を開き、同じ操作を再実行します。

import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;
import java.awt.geom.Point2D;
import java.util.Date;

final String authorName = "Reviewer";
final String authorInitials = "RV";

String inputFile = "input.pptx";
Point2D.Float position = new Point2D.Float(20, 20);

for (int pass = 1; pass <= 2; pass++) {
    Presentation presentation = new Presentation(inputFile);
    try {
        ICommentAuthor[] matches = presentation.getCommentAuthors().findByNameAndInitials(authorName, authorInitials);

        ICommentAuthor author = matches.length > 0 ? matches[0] : presentation.getCommentAuthors().addAuthor(authorName, authorInitials);
        author.getComments().addComment("Please review this slide.", presentation.getSlides().get_Item(0), position, new Date());

        String outputFile = "review_pass_" + pass + ".pptx";
        presentation.save(outputFile, SaveFormat.Pptx);
        inputFile = outputFile;
    } finally {
        presentation.dispose();
    }
}

2 回目のパスは、別の著者を追加したり既存のコメントを削除したりせずに別のコメントを追加します。最終ファイル review_pass_2.pptx には、元のコメントに加えて新しいコメントの両方が含まれます。著者を再利用してもコメントは重複除去されません。同じコメントの繰り返し追加を防ぐには、追加前に別途重複検出を実装してください。

スライドコメントへのアクセス

この例では、既存のプレゼンテーションを開き、getCommentAuthors が返すコレクションを読み取ります。各著者について、getComments が返すコレクションを反復し、スライド番号、コメントテキスト、著者名、作成時刻を出力します。コンソール出力を得るには、入力プレゼンテーションにコメントが含まれている必要があります。

import com.aspose.slides.IComment;
import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.Presentation;

Presentation presentation = new Presentation("Comments1.pptx");
try {
    for (ICommentAuthor author : presentation.getCommentAuthors()) {
        for (IComment comment : author.getComments()) {
            System.out.println("Slide: " + comment.getSlide().getSlideNumber());
            System.out.println("Comment: " + comment.getText());
            System.out.println("Author: " + comment.getAuthor().getName());
            System.out.println("Posted at: " + comment.getCreatedTime());
            System.out.println();
        }
    }
} finally {
    presentation.dispose();
}

コメントへの返信

親コメントは、返信階層の最上位にある元のコメントです。IComment.getParentComment および IComment.setParentComment メソッドを使用して、コメントの親を取得または設定できます。

この例では、2 人の著者からコメントを作成し、setParentComment を使用して返信を構築し、別の返信への返信も含めます。null を getSlideComments に渡すとすべての著者からコメントを取得します。コンソールは返信階層の深さに応じて各エントリをインデントします。例は全体のディスカッションを保存し、最初のルートコメントに対して remove を呼び出し、そのコメントと返信が削除された 2 番目のプレゼンテーションを保存します。

import com.aspose.slides.IComment;
import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.ISlide;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;
import java.awt.geom.Point2D;
import java.util.Date;

Presentation presentation = new Presentation();
try {
    ISlide slide = presentation.getSlides().get_Item(0);

    Point2D.Float position = new Point2D.Float(10, 10);
    Date createdTime = new Date();

    ICommentAuthor originalAuthor = presentation.getCommentAuthors().addAuthor("Author_1", "A.A.");
    IComment rootComment = originalAuthor.getComments().addComment("comment 1", slide, position, createdTime);

    ICommentAuthor reviewer = presentation.getCommentAuthors().addAuthor("Author_2", "B.B.");
    IComment firstReply = reviewer.getComments().addComment("reply 1 for comment 1", slide, position, createdTime);
    firstReply.setParentComment(rootComment);

    IComment secondReply = reviewer.getComments().addComment("reply 2 for comment 1", slide, position, createdTime);
    secondReply.setParentComment(rootComment);

    IComment subReply = originalAuthor.getComments().addComment("subreply 3 for reply 2", slide, position, createdTime);
    subReply.setParentComment(secondReply);

    reviewer.getComments().addComment("comment 2", slide, position, createdTime);
    IComment separateComment = reviewer.getComments().addComment("comment 3", slide, position, createdTime);

    IComment separateReply = originalAuthor.getComments().addComment("reply 4 for comment 3", slide, position, createdTime);
    separateReply.setParentComment(separateComment);

    IComment[] comments = slide.getSlideComments(null);
    for (int i = 0; i < comments.length; i++) {
        IComment comment = comments[i];
        while (comment.getParentComment() != null) {
            System.out.print("\t");
            comment = comment.getParentComment();
        }

        System.out.println(comments[i].getAuthor().getName() + ": " + comments[i].getText());
    }

    presentation.save("parent_comment.pptx", SaveFormat.Pptx);

    rootComment.remove();
    presentation.save("remove_comment.pptx", SaveFormat.Pptx);
} finally {
    presentation.dispose();
}

モダンコメントの追加

モダンコメントは、スライド自体、特定のシェイプ、または AutoShape 内のテキスト範囲に関連付けることができます。ICommentCollection.addModernComment メソッドは、スライドとコメントマーカーの座標に加えて IShape 引数を受け取ります。

null がシェイプ引数として渡されると、コメントはスライドレベルのコメントになります。マーカーは指定された座標で配置されますが、特定のシェイプには関連付けられないため、IModernComment.getShape は null を返します。IShape が指定されると、コメントはそのシェイプにアンカー付けされます。座標は依然としてスライド上のコメントマーカーの位置を定義し、シェイプの関連付けは IModernComment.getShape で取得できます。

モダンコメントをシェイプにアンカー付けする

この例では、addModernComment を 2 回呼び出します。1 回目は null シェイプでスライドレベルのコメント、2 回目は矩形をアンカーとして使用します。getShape を読み取ると、スライドレベルコメントの null チェックで true、アンカー付きコメントで Revenue title が出力されます。両方のコメントはプレゼンテーションに保存されます。

import com.aspose.slides.IAutoShape;
import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.IModernComment;
import com.aspose.slides.ISlide;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;
import com.aspose.slides.ShapeType;
import java.awt.geom.Point2D;
import java.util.Date;

Presentation presentation = new Presentation();
try {
    ISlide slide = presentation.getSlides().get_Item(0);

    ICommentAuthor author = presentation.getCommentAuthors().addAuthor("Reviewer", "RV");

    IAutoShape shape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 300, 80);
    shape.setName("Revenue title");
    shape.getTextFrame().setText("Quarterly revenue");

    Date createdTime = new Date();
    Point2D.Float slideCommentPosition = new Point2D.Float(20, 20);
    Point2D.Float shapeCommentPosition = new Point2D.Float(60, 60);
    IModernComment slideComment = author.getComments().addModernComment("Review the overall slide layout.", slide, null, slideCommentPosition, createdTime);
    IModernComment shapeComment = author.getComments().addModernComment("Check this title.", slide, shape, shapeCommentPosition, createdTime);

    System.out.println(slideComment.getShape() == null);
    System.out.println(shapeComment.getShape().getName());

    presentation.save("modern_comments.pptx", SaveFormat.Pptx);
} finally {
    presentation.dispose();
}

異なるシェイプタイプへのコメントのアンカー付け

IShape を実装するスライドオブジェクトは、シェイプのアンカーとして使用できます。代表的な例として IAutoShape、IPictureFrame、IGroupShape、IConnector、およびチャートなどの IGraphicalObject インスタンスがあります。

この例では、addModernComment を使用して、5 種類のシェイプ(AutoShape、ピクチャフレーム、グループ、コネクタ、チャート)それぞれにコメントを関連付けます。ピクチャは埋め込み画像データを使用するため、外部画像は必要ありません。各コメントは独自のマーカー位置を持ち、保存されたプレゼンテーションは 5 つすべてのシェイプ関連付けを保持します。

import com.aspose.slides.ChartType;
import com.aspose.slides.IAutoShape;
import com.aspose.slides.IChart;
import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.IConnector;
import com.aspose.slides.IGroupShape;
import com.aspose.slides.IPPImage;
import com.aspose.slides.IPictureFrame;
import com.aspose.slides.ISlide;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;
import com.aspose.slides.ShapeType;
import java.awt.geom.Point2D;
import java.util.Base64;
import java.util.Date;

Presentation presentation = new Presentation();
try {
    ISlide slide = presentation.getSlides().get_Item(0);

    ICommentAuthor author = presentation.getCommentAuthors().addAuthor("Reviewer", "RV");
    Date createdTime = new Date();

    IAutoShape autoShape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 20, 20, 180, 60);
    autoShape.getTextFrame().setText("AutoShape");

    Point2D.Float autoShapeCommentPosition = new Point2D.Float(30, 30);
    author.getComments().addModernComment("Comment on an AutoShape.", slide, autoShape, autoShapeCommentPosition, createdTime);

    String imageBase64 = "iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAIAAAD91JpzAAAAFklEQVR4nGP8//8/AwMDEwMDAwMDAwAkBgMB/DXemwAAAABJRU5ErkJggg==";
    byte[] imageData = Base64.getDecoder().decode(imageBase64);
    IPPImage image = presentation.getImages().addImage(imageData);
    IPictureFrame pictureFrame = slide.getShapes().addPictureFrame(ShapeType.Rectangle, 220, 20, 120, 80, image);
    Point2D.Float pictureCommentPosition = new Point2D.Float(230, 30);
    author.getComments().addModernComment("Comment on a picture.", slide, pictureFrame, pictureCommentPosition, createdTime);

    IGroupShape groupShape = slide.getShapes().addGroupShape();
    groupShape.getShapes().addAutoShape(ShapeType.Rectangle, 0, 0, 80, 40);
    groupShape.getShapes().addAutoShape(ShapeType.Ellipse, 100, 0, 80, 40);
    Point2D.Float groupCommentPosition = new Point2D.Float(40, 150);
    author.getComments().addModernComment("Comment on a group.", slide, groupShape, groupCommentPosition, createdTime);

    IConnector connector = slide.getShapes().addConnector(ShapeType.StraightConnector1, 220, 150, 140, 40);
    Point2D.Float connectorCommentPosition = new Point2D.Float(240, 150);
    author.getComments().addModernComment("Comment on a connector.", slide, connector, connectorCommentPosition, createdTime);

    IChart chart = slide.getShapes().addChart(ChartType.ClusteredColumn, 400, 20, 250, 180);
    Point2D.Float chartCommentPosition = new Point2D.Float(420, 40);
    author.getComments().addModernComment("Comment on a graphical object.", slide, chart, chartCommentPosition, createdTime);

    presentation.save("modern_comment_shape_types.pptx", SaveFormat.Pptx);
} finally {
    presentation.dispose();
}

テキストへのコメントのアンカー付けとステータス設定

IAutoShape に関連付けられたモダンコメントの場合、IModernComment.getTextSelectionStart と IModernComment.setTextSelectionStart はシェイプのテキストフレーム内で選択されたテキストの開始位置にアクセスします。IModernComment.getTextSelectionLength と IModernComment.setTextSelectionLength は選択範囲の長さにアクセスします。これらの値を組み合わせることで、コメントは AutoShape 内の特定のテキスト範囲に関連付けられます。

IModernComment.getStatus と IModernComment.setStatus メソッドは、ModernCommentStatus 定数の値にアクセスします。

  • NotDefined — 特定のモダンコメントステータスは定義されていません。
  • Active — コメントはアクティブです。
  • Resolved — コメントは解決済みです。
  • Closed — コメントはクローズされています。

この例では、矩形テキスト内の “quarterly revenue” という語句にモダンコメントをアンカー付けします。テキストからゼロベースの選択開始位置を計算し、setTextSelectionStart に渡し、setTextSelectionLength で選択文字数を設定します。Resolved を指定して setStatus を呼び出した後、プレゼンテーションを保存して再度開きます。4 つのコンソールチェックはすべて true を出力し、シェイプアンカー、テキスト範囲、ステータスが保持されていることを確認します。

import com.aspose.slides.IAutoShape;
import com.aspose.slides.IComment;
import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.IModernComment;
import com.aspose.slides.ISlide;
import com.aspose.slides.ModernCommentStatus;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;
import com.aspose.slides.ShapeType;
import java.awt.geom.Point2D;
import java.util.Date;

String outputFile = "modern_comment_text_anchor.pptx";
String shapeText = "Review the quarterly revenue forecast.";
String selectedText = "quarterly revenue";
int expectedSelectionStart = shapeText.indexOf(selectedText);

Presentation presentation = new Presentation();
try {
    ISlide slide = presentation.getSlides().get_Item(0);

    IAutoShape shape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 400, 100);
    shape.setName("Forecast text");
    shape.getTextFrame().setText(shapeText);

    ICommentAuthor author = presentation.getCommentAuthors().addAuthor("Reviewer", "RV");
    Point2D.Float commentPosition = new Point2D.Float(60, 60);
    IModernComment comment = author.getComments().addModernComment("Verify this forecast wording.", slide, shape, commentPosition, new Date());
    comment.setTextSelectionStart(expectedSelectionStart);
    comment.setTextSelectionLength(selectedText.length());
    comment.setStatus(ModernCommentStatus.Resolved);

    presentation.save(outputFile, SaveFormat.Pptx);
} finally {
    presentation.dispose();
}

Presentation reopenedPresentation = new Presentation(outputFile);
try {
    ISlide reopenedSlide = reopenedPresentation.getSlides().get_Item(0);
    IComment[] reopenedComments = reopenedSlide.getSlideComments(null);

    for (IComment reopenedComment : reopenedComments) {
        if (!(reopenedComment instanceof IModernComment)) {
            continue;
        }

        IModernComment modernComment = (IModernComment) reopenedComment;
        boolean shapeMatches = modernComment.getShape() != null && "Forecast text".equals(modernComment.getShape().getName());
        boolean selectionStartMatches = modernComment.getTextSelectionStart() == expectedSelectionStart;
        boolean selectionLengthMatches = modernComment.getTextSelectionLength() == selectedText.length();
        boolean statusMatches = modernComment.getStatus() == ModernCommentStatus.Resolved;

        System.out.println("Shape anchor preserved: " + shapeMatches);
        System.out.println("Text selection start preserved: " + selectionStartMatches);
        System.out.println("Text selection length preserved: " + selectionLengthMatches);
        System.out.println("Resolved status preserved: " + statusMatches);
    }
} finally {
    reopenedPresentation.dispose();
}

既存のモダンコメントの検査

この例では、モダンコメントを含む既存のプレゼンテーションが必要で、コメントのテキスト、ステータス、アンカーの詳細を出力します。検査するには、どのコメントが IModernComment を実装しているか確認し、IModernComment.getShape 、IModernComment.getTextSelectionStart 、IModernComment.getTextSelectionLength 、IModernComment.getStatus を調べます。null のシェイプはスライドレベルのコメントを示します。IAutoShape アンカーの場合、テキスト選択メソッドはシェイプのテキストフレーム内の対象範囲を特定します。

import com.aspose.slides.IAutoShape;
import com.aspose.slides.IComment;
import com.aspose.slides.IModernComment;
import com.aspose.slides.IShape;
import com.aspose.slides.ISlide;
import com.aspose.slides.Presentation;

Presentation presentation = new Presentation("comments.pptx");
try {
    for (ISlide slide : presentation.getSlides()) {
        IComment[] comments = slide.getSlideComments(null);
        for (IComment comment : comments) {
            if (!(comment instanceof IModernComment)) {
                continue;
            }

            IModernComment modernComment = (IModernComment) comment;
            System.out.println("Slide: " + slide.getSlideNumber());
            System.out.println("Text: " + modernComment.getText());
            System.out.println("Status: " + modernComment.getStatus());

            IShape shape = modernComment.getShape();
            if (shape == null) {
                System.out.println("Anchor: slide level");
            } else {
                System.out.println("Anchor shape: " + shape.getName());
                System.out.println("Anchor type: " + shape.getClass().getSimpleName());

                if (shape instanceof IAutoShape) {
                    System.out.println("Text selection start: " + modernComment.getTextSelectionStart());
                    System.out.println("Text selection length: " + modernComment.getTextSelectionLength());
                }
            }

            System.out.println();
        }
    }
} finally {
    presentation.dispose();
}

コメントの削除

Aspose.Slides for Java を使用すると、プレゼンテーションからすべてのコメントとその著者を削除したり、選択したコメントだけを削除して残りを保持したりできます。以下の例は両方の方法を示し、更新されたプレゼンテーションを保存します。

すべてのコメントとコメント著者の削除

この例では、既存のプレゼンテーションを開き、各著者に対して ICommentCollection.clear を呼び出し、次に ICommentAuthorCollection.clear を呼び出して著者自体を削除します。保存されたプレゼンテーションにはコメントもコメント著者も含まれません。削除を確認するには、コメントを含むプレゼンテーションを使用してください。

import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;

Presentation presentation = new Presentation("example.pptx");
try {
    for (ICommentAuthor author : presentation.getCommentAuthors()) {
        author.getComments().clear();
    }

    presentation.getCommentAuthors().clear();

    presentation.save("example_out.pptx", SaveFormat.Pptx);
} finally {
    presentation.dispose();
}

特定のコメントの削除

この例では、1 枚のスライドに 2 つのコメントを作成し、getSlideComments を使用して各著者のコメントを検索します。ICommentCollection.remove を呼び出す前に、テキストが “comment 1” と等しいコメントを収集し、選択中にコレクションが変更されるのを防ぎます。保存されたプレゼンテーションには “comment 2” のみが残ります。

import com.aspose.slides.IComment;
import com.aspose.slides.ICommentAuthor;
import com.aspose.slides.ISlide;
import com.aspose.slides.Presentation;
import com.aspose.slides.SaveFormat;
import java.awt.geom.Point2D;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

Presentation presentation = new Presentation();
try {
    ISlide slide = presentation.getSlides().get_Item(0);

    ICommentAuthor author = presentation.getCommentAuthors().addAuthor("Author", "A");
    Date createdTime = new Date();

    Point2D.Float firstCommentPosition = new Point2D.Float(0.2f, 0.2f);
    Point2D.Float secondCommentPosition = new Point2D.Float(0.3f, 0.2f);
    author.getComments().addComment("comment 1", slide, firstCommentPosition, createdTime);
    author.getComments().addComment("comment 2", slide, secondCommentPosition, createdTime);

    for (ICommentAuthor commentAuthor : presentation.getCommentAuthors()) {
        List<IComment> commentsToRemove = new ArrayList<IComment>();
        IComment[] comments = slide.getSlideComments(commentAuthor);

        for (IComment comment : comments) {
            if ("comment 1".equals(comment.getText())) {
                commentsToRemove.add(comment);
            }
        }

        for (IComment comment : commentsToRemove) {
            commentAuthor.getComments().remove(comment);
        }
    }

    presentation.save("pres.pptx", SaveFormat.Pptx);
} finally {
    presentation.dispose();
}

FAQ

Aspose.Slides はモダンコメントの解決済みステータスをサポートしていますか?

はい。 IModernComment.getStatus と IModernComment.setStatus は、Resolved を含む ModernCommentStatus の値にアクセスします。ステータスはプレゼンテーションに保存され、ファイルを再度開いた後でも読み取れます。

スレッド化されたディスカッション(返信チェーン)はサポートされていますか?また、入れ子の制限はありますか?

はい。各コメントは parent comment を参照できるため、返信チェーンが可能です。API では特定の入れ子深さの制限は定義されていません。

スライド上のコメントマーカーの位置はどの座標系で定義されていますか?

マーカーの位置はスライド座標系の浮動小数点座標で定義されており、スライド上の正確な位置に配置できます。