done property

Comment.done property

Gets or sets flag indicating that the comment has been marked done.

@property
def done(self) -> bool:
    ...

@done.setter
def done(self, value: bool):
    ...

Examples

Shows how to mark a comment as “done”.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Helo world!')
# Insert a comment to point out an error.
comment = aw.Comment(doc=doc, author='John Doe', initial='J.D.', date_time=datetime.datetime.now())
comment.set_text('Fix the spelling error!')
doc.first_section.body.first_paragraph.append_child(comment)
# Comments have a "Done" flag, which is set to "false" by default.
# If a comment suggests that we make a change within the document,
# we can apply the change, and then also set the "Done" flag afterwards to indicate the correction.
self.assertFalse(comment.done)
doc.first_section.body.first_paragraph.runs[0].text = 'Hello world!'
comment.done = True
# Comments that are "done" will differentiate themselves
# from ones that are not "done" with a faded text color.
comment = aw.Comment(doc=doc, author='John Doe', initial='J.D.', date_time=datetime.datetime.now())
comment.set_text('Add text to this paragraph.')
builder.current_paragraph.append_child(comment)
doc.save(file_name=ARTIFACTS_DIR + 'Comment.Done.docx')

done property

Comment.done property

Examples

See Also