Gerenciar comentários de apresentação em Python via Java
Visão geral
Este artigo explica como gerenciar comentários de apresentação com Aspose.Slides for Python via Java. Ele apresenta os principais tipos relacionados a comentários e demonstra como adicionar comentários aos slides, acessar comentários existentes, trabalhar com respostas e comentários modernos, e remover comentários de uma apresentação.
Os exemplos cobrem cenários comuns de revisão e colaboração no PowerPoint, como atribuir comentários a autores, ler o texto e os metadados dos comentários, construir cadeias de respostas e remover comentários selecionados ou todos os comentários.
No PowerPoint, os comentários aparecem como anotações nos slides. Selecionar um comentário exibe seu texto e a discussão relacionada.
Para solicitar que os comentários sejam exibidos ou ocultados ao abrir uma apresentação sem alterar os próprios comentários, veja Exibir ou ocultar comentários ao abrir uma apresentação.
Por que adicionar comentários a apresentações?
Você pode usar comentários para fornecer feedback e colaborar com colegas ao revisar apresentações.
Aspose.Slides for Python via Java oferece as seguintes APIs para trabalhar com comentários:
- A classe Presentation , que fornece acesso aos autores de comentários da apresentação.
- A classe CommentCollection , que representa os comentários associados a um autor específico.
- A classe Comment , que fornece informações sobre um comentário, incluindo seu autor, horário de criação, posição e texto.
- A classe CommentAuthor , que fornece informações sobre um autor, incluindo nome, iniciais e comentários associados.
Adicionar comentários aos slides
O exemplo cria dois slides e registra um autor de comentário com addAuthor. Ele usa addComment para colocar um comentário em cada slide, então recupera os comentários do primeiro slide para esse autor com getSlideComments. O console exibe o texto do primeiro comentário duas vezes, demonstrando o acesso tanto pelo slide quanto pelo autor, e a apresentação salva contém ambos os comentários.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import Presentation, SaveFormat
Point2DFloat = jpype.JClass("java.awt.geom.Point2D$Float")
Date = jpype.JClass("java.util.Date")
presentation = Presentation()
try:
first_slide = presentation.getSlides().get_Item(0)
second_slide = presentation.getSlides().addEmptySlide(presentation.getLayoutSlides().get_Item(0))
author = presentation.getCommentAuthors().addAuthor("Jawad", "MF")
position = Point2DFloat(0.2, 0.2)
created_time = Date()
author.getComments().addComment("Hello Jawad, this is a slide comment", first_slide, position, created_time)
author.getComments().addComment("Hello Jawad, this is the second slide comment", second_slide, position, created_time)
comments = first_slide.getSlideComments(author)
if len(comments) > 0:
first_comment = comments[0]
print(first_comment.getText())
author_comments = first_comment.getAuthor().getComments()
comment_text = author_comments.get_Item(0).getText()
print(comment_text)
presentation.save("Comments_out.pptx", SaveFormat.Pptx)
finally:
presentation.dispose()
Localizar ou criar um autor de comentário
Quando uma revisão automatizada processa a mesma apresentação repetidamente, procure na coleção retornada por getCommentAuthors antes de adicionar um autor. findByNameAndInitials combina nome e iniciais e retorna um array de autores correspondentes, ou um array vazio se não houver correspondências. Em contraste, findByName pesquisa apenas pelo nome, independentemente das iniciais. Chamar addAuthor com um nome e iniciais já presentes na coleção lança uma exceção.
O exemplo requer um arquivo de apresentação com pelo menos um slide. Em cada uma das duas passagens, ele reutiliza o primeiro autor correspondente, ou cria um somente quando o resultado está vazio. Se houver várias correspondências, ele seleciona o primeiro elemento do array sem mesclar ou remover os demais autores. Em seguida, chama addComment para o autor selecionado e salva a apresentação. A segunda passagem abre a saída da primeira passagem e repete a operação.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import Presentation, SaveFormat
Point2DFloat = jpype.JClass("java.awt.geom.Point2D$Float")
Date = jpype.JClass("java.util.Date")
author_name = "Reviewer"
author_initials = "RV"
input_file = "input.pptx"
position = Point2DFloat(20, 20)
for pass_number in range(1, 3):
presentation = Presentation(input_file)
try:
matches = presentation.getCommentAuthors().findByNameAndInitials(author_name, author_initials)
author = matches[0] if len(matches) > 0 else presentation.getCommentAuthors().addAuthor(author_name, author_initials)
created_time = Date()
author.getComments().addComment("Please review this slide.", presentation.getSlides().get_Item(0), position, created_time)
output_file = f"review_pass_{pass_number}.pptx"
presentation.save(output_file, SaveFormat.Pptx)
input_file = output_file
finally:
presentation.dispose()
A segunda passagem adiciona outro comentário sem adicionar outro autor ou remover comentários existentes. O arquivo final, review_pass_2.pptx, contém ambos os novos comentários junto com quaisquer comentários originais. Reutilizar um autor não deduplica comentários: para evitar a adição repetida do mesmo comentário, implemente a detecção de duplicatas antes de adicioná‑lo.
Acessar comentários dos slides
O exemplo abre uma apresentação existente e lê a coleção retornada por getCommentAuthors. Para cada autor, ele itera sobre a coleção retornada por getComments e imprime o número do slide, o texto do comentário, o nome do autor e a data de criação. A apresentação de entrada deve conter comentários para produzir saída no console.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import Presentation
presentation = Presentation("Comments1.pptx")
try:
for author in presentation.getCommentAuthors():
for comment in author.getComments():
print("Slide: ", comment.getSlide().getSlideNumber())
print("Comment: ", comment.getText())
print("Author: ", comment.getAuthor().getName())
print("Posted at: ", comment.getCreatedTime())
print()
finally:
presentation.dispose()
Responder a comentários
Um comentário pai é o comentário original no topo de uma hierarquia de respostas. Os métodos Comment.getParentComment e Comment.setParentComment permitem obter ou definir o pai de um comentário.
O exemplo cria comentários de dois autores e usa setParentComment para construir respostas, incluindo uma resposta a outra resposta. Passar None para getSlideComments recupera comentários de todos os autores; o console indenta cada entrada de acordo com sua profundidade na hierarquia de respostas. O exemplo salva a discussão completa, chama remove no primeiro comentário raiz e salva uma segunda apresentação com esse comentário e suas respostas removidos.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import Presentation, SaveFormat
Point2DFloat = jpype.JClass("java.awt.geom.Point2D$Float")
Date = jpype.JClass("java.util.Date")
presentation = Presentation()
try:
slide = presentation.getSlides().get_Item(0)
position = Point2DFloat(10, 10)
created_time = Date()
thread_author = presentation.getCommentAuthors().addAuthor("Author_1", "A.A.")
root_comment = thread_author.getComments().addComment("comment 1", slide, position, created_time)
responding_author = presentation.getCommentAuthors().addAuthor("Author_2", "B.B.")
direct_reply = responding_author.getComments().addComment("reply 1 for comment 1", slide, position, created_time)
direct_reply.setParentComment(root_comment)
branch_reply = responding_author.getComments().addComment("reply 2 for comment 1", slide, position, created_time)
branch_reply.setParentComment(root_comment)
nested_reply = thread_author.getComments().addComment("subreply 3 for reply 2", slide, position, created_time)
nested_reply.setParentComment(branch_reply)
responding_author.getComments().addComment("comment 2", slide, position, created_time)
separate_thread_comment = responding_author.getComments().addComment("comment 3", slide, position, created_time)
separate_thread_reply = thread_author.getComments().addComment("reply 4 for comment 3", slide, position, created_time)
separate_thread_reply.setParentComment(separate_thread_comment)
comments = slide.getSlideComments(None)
for i in range(len(comments)):
comment = comments[i]
while comment.getParentComment() is not None:
print("\t", end="")
comment = comment.getParentComment()
print(f"{comments[i].getAuthor().getName()}: {comments[i].getText()}")
presentation.save("parent_comment.pptx", SaveFormat.Pptx)
root_comment.remove()
presentation.save("remove_comment.pptx", SaveFormat.Pptx)
finally:
presentation.dispose()
Warning
- Quando o método Comment.remove é usado para excluir um comentário, todas as respostas a esse comentário também são excluídas.
- Se Comment.setParentComment criar uma referência circular, uma PptxEditException será lançada.
Adicionar comentários modernos
Comentários modernos podem ser associados ao próprio slide, a uma forma específica ou a um intervalo de texto dentro de um AutoShape. O método CommentCollection.addModernComment aceita um argumento Shape além do slide e das coordenadas do marcador de comentário.
Quando None é passado para o argumento shape, o comentário é um comentário ao nível do slide. Seu marcador é posicionado pelas coordenadas fornecidas, mas não está associado a uma forma específica, portanto ModernComment.getShape retorna None. Quando uma Shape é fornecida, o comentário fica ancorado a essa forma. As coordenadas ainda definem a posição do marcador de comentário no slide, enquanto a associação à forma pode ser recuperada através de ModernComment.getShape.
Ancorar um comentário moderno a uma forma
O exemplo chama addModernComment duas vezes: uma vez com a forma None para um comentário ao nível do slide e outra vez com um retângulo como âncora. Ler getShape imprime True para a verificação None do comentário ao nível do slide e Revenue title para o comentário ancorado. Ambos os comentários são salvos com a apresentação.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import Presentation, SaveFormat, ShapeType
Point2DFloat = jpype.JClass("java.awt.geom.Point2D$Float")
Date = jpype.JClass("java.util.Date")
presentation = Presentation()
try:
slide = presentation.getSlides().get_Item(0)
author = presentation.getCommentAuthors().addAuthor("Reviewer", "RV")
shape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 300, 80)
shape.setName("Revenue title")
shape.getTextFrame().setText("Quarterly revenue")
created_time = Date()
slide_comment_position = Point2DFloat(20, 20)
shape_comment_position = Point2DFloat(60, 60)
slide_comment = author.getComments().addModernComment("Review the overall slide layout.", slide, None, slide_comment_position, created_time)
shape_comment = author.getComments().addModernComment("Check this title.", slide, shape, shape_comment_position, created_time)
print(slide_comment.getShape() is None)
print(shape_comment.getShape().getName())
presentation.save("modern_comments.pptx", SaveFormat.Pptx)
finally:
presentation.dispose()
Ancorar comentários a diferentes tipos de forma
Qualquer objeto de slide que herde de Shape pode ser usado como âncora de forma. Exemplos comuns incluem AutoShape, PictureFrame, GroupShape, Connector e instâncias de GraphicalObject como gráficos.
O exemplo usa addModernComment para associar um comentário a cada um de cinco tipos de forma: um AutoShape, um quadro de imagem, um grupo, um conectador e um gráfico. A imagem do quadro é embutida, portanto nenhuma imagem externa é necessária. Cada comentário tem sua própria posição de marcador, e a apresentação salva mantém todas as cinco associações de forma.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import ChartType, Presentation, SaveFormat, ShapeType
Point2DFloat = jpype.JClass("java.awt.geom.Point2D$Float")
Date = jpype.JClass("java.util.Date")
Base64 = jpype.JClass("java.util.Base64")
presentation = Presentation()
try:
slide = presentation.getSlides().get_Item(0)
author = presentation.getCommentAuthors().addAuthor("Reviewer", "RV")
created_time = Date()
auto_shape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 20, 20, 180, 60)
auto_shape.getTextFrame().setText("AutoShape")
auto_shape_comment_position = Point2DFloat(30, 30)
author.getComments().addModernComment("Comment on an AutoShape.", slide, auto_shape, auto_shape_comment_position, created_time)
image_base64 = "iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAIAAAD91JpzAAAAFklEQVR4nGP8//8/AwMDEwMDAwMDAwAkBgMB/DXemwAAAABJRU5ErkJggg=="
image_data = Base64.getDecoder().decode(image_base64)
image = presentation.getImages().addImage(image_data)
picture_frame = slide.getShapes().addPictureFrame(ShapeType.Rectangle, 220, 20, 120, 80, image)
picture_comment_position = Point2DFloat(230, 30)
author.getComments().addModernComment("Comment on a picture.", slide, picture_frame, picture_comment_position, created_time)
group_shape = slide.getShapes().addGroupShape()
group_shape.getShapes().addAutoShape(ShapeType.Rectangle, 0, 0, 80, 40)
group_shape.getShapes().addAutoShape(ShapeType.Ellipse, 100, 0, 80, 40)
group_comment_position = Point2DFloat(40, 150)
author.getComments().addModernComment("Comment on a group.", slide, group_shape, group_comment_position, created_time)
connector = slide.getShapes().addConnector(ShapeType.StraightConnector1, 220, 150, 140, 40)
connector_comment_position = Point2DFloat(240, 150)
author.getComments().addModernComment("Comment on a connector.", slide, connector, connector_comment_position, created_time)
chart = slide.getShapes().addChart(ChartType.ClusteredColumn, 400, 20, 250, 180)
chart_comment_position = Point2DFloat(420, 40)
author.getComments().addModernComment("Comment on a graphical object.", slide, chart, chart_comment_position, created_time)
presentation.save("modern_comment_shape_types.pptx", SaveFormat.Pptx)
finally:
presentation.dispose()
Ancorar um comentário ao texto e definir seu status
Para um comentário moderno associado a um AutoShape, os métodos ModernComment.getTextSelectionStart e ModernComment.setTextSelectionStart acessam a posição inicial do texto selecionado no quadro de texto da forma. ModernComment.getTextSelectionLength e ModernComment.setTextSelectionLength acessam o comprimento da seleção. Juntos, esses valores associam o comentário a um intervalo de texto específico dentro do AutoShape.
Os métodos ModernComment.getStatus e ModernComment.setStatus acessam um valor da enumeração ModernCommentStatus :
- NotDefined — nenhum status específico de comentário moderno está definido.
- Active — o comentário está ativo.
- Resolved — o comentário foi resolvido.
- Closed — o comentário está fechado.
O exemplo ancora um comentário moderno nas palavras “quarterly revenue” no texto de um retângulo. Ele calcula o início da seleção (baseado em zero) a partir do texto e o passa para setTextSelectionStart e usa setTextSelectionLength para definir a quantidade de caracteres selecionados. Após chamar setStatus com Resolved, ele salva e reabre a apresentação. As quatro verificações no console devem imprimir True, confirmando que a âncora de forma, o intervalo de texto e o status foram preservados.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import ModernComment, ModernCommentStatus, Presentation, SaveFormat, ShapeType
Point2DFloat = jpype.JClass("java.awt.geom.Point2D$Float")
Date = jpype.JClass("java.util.Date")
output_file = "modern_comment_text_anchor.pptx"
shape_text = "Review the quarterly revenue forecast."
selected_text = "quarterly revenue"
expected_selection_start = shape_text.find(selected_text)
presentation = Presentation()
try:
slide = presentation.getSlides().get_Item(0)
shape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 400, 100)
shape.setName("Forecast text")
shape.getTextFrame().setText(shape_text)
author = presentation.getCommentAuthors().addAuthor("Reviewer", "RV")
comment_position = Point2DFloat(60, 60)
created_time = Date()
comment = author.getComments().addModernComment("Verify this forecast wording.", slide, shape, comment_position, created_time)
comment.setTextSelectionStart(expected_selection_start)
comment.setTextSelectionLength(len(selected_text))
comment.setStatus(ModernCommentStatus.Resolved)
presentation.save(output_file, SaveFormat.Pptx)
finally:
presentation.dispose()
reopened_presentation = Presentation(output_file)
try:
reopened_slide = reopened_presentation.getSlides().get_Item(0)
reopened_comments = reopened_slide.getSlideComments(None)
for reopened_comment in reopened_comments:
if not isinstance(reopened_comment, ModernComment):
continue
modern_comment = reopened_comment
shape_matches = modern_comment.getShape() is not None and modern_comment.getShape().getName() == "Forecast text"
selection_start_matches = modern_comment.getTextSelectionStart() == expected_selection_start
selection_length_matches = modern_comment.getTextSelectionLength() == len(selected_text)
status_matches = modern_comment.getStatus() == ModernCommentStatus.Resolved
print("Shape anchor preserved: ", shape_matches)
print("Text selection start preserved: ", selection_start_matches)
print("Text selection length preserved: ", selection_length_matches)
print("Resolved status preserved: ", status_matches)
finally:
reopened_presentation.dispose()
Inspecionar comentários modernos existentes
O exemplo requer uma apresentação existente contendo comentários modernos e imprime seu texto, status e detalhes da âncora. Para inspecioná‑la, verifique quais comentários são instâncias de ModernComment, então examine ModernComment.getShape, ModernComment.getTextSelectionStart, ModernComment.getTextSelectionLength e ModernComment.getStatus. Uma forma None indica um comentário ao nível do slide. Para uma âncora de AutoShape, os métodos de seleção de texto identificam o intervalo associado no quadro de texto da forma.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import AutoShape, ModernComment, Presentation
presentation = Presentation("comments.pptx")
try:
for slide in presentation.getSlides():
comments = slide.getSlideComments(None)
for comment in comments:
if not isinstance(comment, ModernComment):
continue
modern_comment = comment
print("Slide: ", slide.getSlideNumber())
print("Text: ", modern_comment.getText())
print("Status: ", modern_comment.getStatus())
shape = modern_comment.getShape()
if shape is None:
print("Anchor: slide level")
else:
print("Anchor shape: ", shape.getName())
print("Anchor type: ", shape.getClass().getSimpleName())
if isinstance(shape, AutoShape):
print("Text selection start: ", modern_comment.getTextSelectionStart())
print("Text selection length: ", modern_comment.getTextSelectionLength())
print()
finally:
presentation.dispose()
Remover comentários
Aspose.Slides for Python via Java permite remover todos os comentários e seus autores de uma apresentação ou excluir comentários selecionados mantendo o restante. Os exemplos a seguir demonstram ambas as abordagens e salvam a apresentação atualizada.
Remover todos os comentários e autores de comentários
O exemplo abre uma apresentação existente e chama CommentCollection.clear para cada autor, depois chama CommentAuthorCollection.clear para remover os próprios autores. A apresentação salva não contém nem comentários nem autores de comentários. Use uma apresentação que contenha comentários para observar a remoção.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import Presentation, SaveFormat
presentation = Presentation("example.pptx")
try:
for author in presentation.getCommentAuthors():
author.getComments().clear()
presentation.getCommentAuthors().clear()
presentation.save("example_out.pptx", SaveFormat.Pptx)
finally:
presentation.dispose()
Remover comentários específicos
O exemplo cria dois comentários em um slide e usa getSlideComments para encontrar comentários de cada autor. Ele coleta os comentários cujo texto é igual a “comment 1” antes de chamar CommentCollection.remove, evitando alterações na coleção durante a seleção. A apresentação salva mantém apenas “comment 2”.
import jpype
import asposeslides
if not jpype.isJVMStarted():
jpype.startJVM()
from asposeslides.api import Presentation, SaveFormat
Point2DFloat = jpype.JClass("java.awt.geom.Point2D$Float")
Date = jpype.JClass("java.util.Date")
presentation = Presentation()
try:
slide = presentation.getSlides().get_Item(0)
author = presentation.getCommentAuthors().addAuthor("Author", "A")
created_time = Date()
first_comment_position = Point2DFloat(0.2, 0.2)
second_comment_position = Point2DFloat(0.3, 0.2)
author.getComments().addComment("comment 1", slide, first_comment_position, created_time)
author.getComments().addComment("comment 2", slide, second_comment_position, created_time)
for comment_author in presentation.getCommentAuthors():
comments_to_remove = []
comments = slide.getSlideComments(comment_author)
for comment in comments:
if comment.getText() == "comment 1":
comments_to_remove.append(comment)
for comment in comments_to_remove:
comment_author.getComments().remove(comment)
presentation.save("pres.pptx", SaveFormat.Pptx)
finally:
presentation.dispose()
FAQ
Aspose.Slides suporta um status resolvido para comentários modernos?
Sim. ModernComment.getStatus e ModernComment.setStatus acessam um valor de ModernCommentStatus , incluindo Resolved. O status é armazenado na apresentação e pode ser lido novamente após o arquivo ser reaberto.
Cadeias de discussão (respostas) são suportadas e há um limite de aninhamento?
Sim. Cada comentário pode referenciar seu parent comment, permitindo cadeias de respostas. A API não define um limite específico de profundidade de aninhamento.
Em que sistema de coordenadas a posição do marcador de comentário é definida em um slide?
A posição do marcador é definida por coordenadas em ponto flutuante no sistema de coordenadas do slide, permitindo posicioná‑lo com precisão no slide.